all: autogenerated update (2018-01-28)
Update:
- firestore/v1beta1
- gmail/v1
- tpu/v1alpha1
- youtube/v3
diff --git a/abusiveexperiencereport/v1/abusiveexperiencereport-api.json b/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
index eace356..78d0e9a 100644
--- a/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
+++ b/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
@@ -1,106 +1,4 @@
{
- "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": "",
- "id": "abusiveexperiencereport:v1",
- "documentationLink": "https://developers.google.com/abusive-experience-report/",
- "revision": "20171129",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "ViolatingSitesResponse": {
- "properties": {
- "violatingSites": {
- "description": "A list of summaries of violating sites.",
- "type": "array",
- "items": {
- "$ref": "SiteSummaryResponse"
- }
- }
- },
- "id": "ViolatingSitesResponse",
- "description": "Response message for ListViolatingSites.",
- "type": "object"
- },
- "SiteSummaryResponse": {
- "description": "Response message for GetSiteSummary.",
- "type": "object",
- "properties": {
- "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",
@@ -130,6 +28,7 @@
"sites": {
"methods": {
"get": {
+ "description": "Gets a summary of the abusive experience rating of a site.",
"response": {
"$ref": "SiteSummaryResponse"
},
@@ -139,11 +38,11 @@
"httpMethod": "GET",
"parameters": {
"name": {
+ "pattern": "^sites/[^/]+$",
+ "location": "path",
"description": "The required site name. This is the site property whose abusive\nexperiences have been reviewed, and it must be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field\nreturned by the API will lead to the verification page, prompting the user\nto go through that process before they can gain access to the Abusive\nExperience Report.",
"required": true,
- "type": "string",
- "pattern": "^sites/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -151,75 +50,27 @@
],
"flatPath": "v1/sites/{sitesId}",
"path": "v1/{+name}",
- "id": "abusiveexperiencereport.sites.get",
- "description": "Gets a summary of the abusive experience rating of a site."
+ "id": "abusiveexperiencereport.sites.get"
}
}
}
},
"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": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "default": "true"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
@@ -240,11 +91,160 @@
"type": "string"
},
"callback": {
- "location": "query",
"description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
"type": "string"
}
},
"version": "v1",
- "baseUrl": "https://abusiveexperiencereport.googleapis.com/"
+ "baseUrl": "https://abusiveexperiencereport.googleapis.com/",
+ "servicePath": "",
+ "description": "View Abusive Experience Report data, and get a list of sites that have a significant number of abusive experiences.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "abusiveexperiencereport:v1",
+ "documentationLink": "https://developers.google.com/abusive-experience-report/",
+ "revision": "20171129",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
+ "ViolatingSitesResponse": {
+ "properties": {
+ "violatingSites": {
+ "description": "A list of summaries of violating sites.",
+ "type": "array",
+ "items": {
+ "$ref": "SiteSummaryResponse"
+ }
+ }
+ },
+ "id": "ViolatingSitesResponse",
+ "description": "Response message for ListViolatingSites.",
+ "type": "object"
+ },
+ "SiteSummaryResponse": {
+ "properties": {
+ "abusiveStatus": {
+ "enumDescriptions": [
+ "Not reviewed.",
+ "Passing.",
+ "Failing."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PASSING",
+ "FAILING"
+ ],
+ "description": "The status of the site reviewed for the abusive experiences.",
+ "type": "string"
+ },
+ "enforcementTime": {
+ "description": "The date on which enforcement begins.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "filterStatus": {
+ "enum": [
+ "UNKNOWN",
+ "ON",
+ "OFF",
+ "PAUSED",
+ "PENDING"
+ ],
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "SiteSummaryResponse",
+ "description": "Response message for GetSiteSummary.",
+ "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": "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/"
}
diff --git a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
index 6925dfb..475c258 100644
--- a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
+++ b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
@@ -1,9 +1,4 @@
{
- "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "acceleratedmobilepageurl",
- "batchPath": "batch",
"revision": "20180110",
"documentationLink": "https://developers.google.com/amp/cache/",
"id": "acceleratedmobilepageurl:v1",
@@ -15,34 +10,39 @@
"ampUrls": {
"methods": {
"batchGet": {
+ "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).",
"request": {
"$ref": "BatchGetAmpUrlsRequest"
},
- "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "BatchGetAmpUrlsResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {},
"flatPath": "v1/ampUrls:batchGet",
- "id": "acceleratedmobilepageurl.ampUrls.batchGet",
- "path": "v1/ampUrls:batchGet"
+ "path": "v1/ampUrls:batchGet",
+ "id": "acceleratedmobilepageurl.ampUrls.batchGet"
}
}
}
},
"parameters": {
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
@@ -56,18 +56,7 @@
"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",
@@ -75,17 +64,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": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -98,15 +93,15 @@
"default": "true",
"location": "query"
},
- "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."
+ "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\").",
@@ -122,8 +117,6 @@
},
"schemas": {
"BatchGetAmpUrlsResponse": {
- "description": "Batch AMP URL response.",
- "type": "object",
"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.",
@@ -140,7 +133,9 @@
}
}
},
- "id": "BatchGetAmpUrlsResponse"
+ "id": "BatchGetAmpUrlsResponse",
+ "description": "Batch AMP URL response.",
+ "type": "object"
},
"AmpUrl": {
"properties": {
@@ -162,21 +157,12 @@
"type": "object"
},
"AmpUrlError": {
- "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",
@@ -186,7 +172,15 @@
"URL_IS_INVALID_AMP"
],
"description": "The error code of an API call.",
- "type": "string"
+ "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."
+ ]
},
"originalUrl": {
"description": "The original non-AMP URL.",
@@ -194,30 +188,31 @@
}
},
"id": "AmpUrlError",
- "description": "AMP URL Error resource for a requested URL that couldn't be found."
+ "description": "AMP URL Error resource for a requested URL that couldn't be found.",
+ "type": "object"
},
"BatchGetAmpUrlsRequest": {
"description": "AMP URL request for a batch of URLs.",
"type": "object",
"properties": {
+ "lookupStrategy": {
+ "enum": [
+ "FETCH_LIVE_DOC",
+ "IN_INDEX_DOC"
+ ],
+ "description": "The lookup_strategy being requested.",
+ "type": "string",
+ "enumDescriptions": [
+ "FETCH_LIVE_DOC strategy involves live document fetch of URLs not found in\nthe index. Any request URL not found in the index is crawled in realtime\nto validate if there is a corresponding AMP URL. This strategy has higher\ncoverage but with extra latency introduced by realtime crawling. This is\nthe default strategy. Applications using this strategy should set higher\nHTTP timeouts of the API calls.",
+ "IN_INDEX_DOC strategy skips fetching live documents of URL(s) not found\nin index. For applications which need low latency use of IN_INDEX_DOC\nstrategy is recommended."
+ ]
+ },
"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"
@@ -225,12 +220,17 @@
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"version": "v1",
"baseUrl": "https://acceleratedmobilepageurl.googleapis.com/",
- "kind": "discovery#restDescription",
+ "servicePath": "",
"description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).\n",
- "servicePath": ""
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "acceleratedmobilepageurl",
+ "batchPath": "batch"
}
diff --git a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
index 430edb1..68b0231 100644
--- a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
+++ b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
@@ -1,370 +1,15 @@
{
+ "rootUrl": "https://adexchangebuyer.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "adexchangebuyer2",
+ "batchPath": "batch",
+ "title": "Ad Exchange Buyer API II",
+ "ownerName": "Google",
"resources": {
"bidders": {
"resources": {
"filterSets": {
- "methods": {
- "delete": {
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}",
- "path": "v2beta1/{+name}",
- "id": "adexchangebuyer2.bidders.filterSets.delete",
- "description": "Deletes the requested filter set from the account with the given account\nID.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$"
- }
- }
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "FilterSet"
- },
- "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/[^/]+/filterSets/[^/]+$"
- }
- },
- "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": "GET",
- "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": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
- },
- "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/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets",
- "path": "v2beta1/{+ownerName}/filterSets",
- "id": "adexchangebuyer2.bidders.filterSets.list"
- },
- "create": {
- "response": {
- "$ref": "FilterSet"
- },
- "parameterOrder": [
- "ownerName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "isTransient": {
- "type": "boolean",
- "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."
- },
- "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/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets",
- "path": "v2beta1/{+ownerName}/filterSets",
- "id": "adexchangebuyer2.bidders.filterSets.create",
- "request": {
- "$ref": "FilterSet"
- },
- "description": "Creates the specified filter set for the account with the given account ID."
- }
- },
"resources": {
- "losingBids": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListLosingBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "parameters": {
- "filterSetName": {
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`"
- },
- "pageToken": {
- "type": "string",
- "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."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/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."
- }
- }
- },
- "bidMetrics": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListBidMetricsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "parameters": {
- "filterSetName": {
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$"
- },
- "pageToken": {
- "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.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidMetrics",
- "id": "adexchangebuyer2.bidders.filterSets.bidMetrics.list",
- "path": "v2beta1/{+filterSetName}/bidMetrics",
- "description": "Lists all metrics that are measured in terms of number of bids."
- }
- }
- },
- "impressionMetrics": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "filterSetName"
- ],
- "response": {
- "$ref": "ListImpressionMetricsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/impressionMetrics",
- "id": "adexchangebuyer2.bidders.filterSets.impressionMetrics.list",
- "path": "v2beta1/{+filterSetName}/impressionMetrics",
- "description": "Lists all metrics that are measured in terms of number of impressions."
- }
- }
- },
- "bidResponseErrors": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListBidResponseErrorsResponse"
- },
- "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\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponseErrors",
- "path": "v2beta1/{+filterSetName}/bidResponseErrors",
- "id": "adexchangebuyer2.bidders.filterSets.bidResponseErrors.list",
- "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason."
- }
- }
- },
- "bidResponsesWithoutBids": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "filterSetName"
- ],
- "response": {
- "$ref": "ListBidResponsesWithoutBidsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids",
- "id": "adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list",
- "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids",
- "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason."
- }
- }
- },
- "filteredBidRequests": {
- "methods": {
- "list": {
- "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.",
- "httpMethod": "GET",
- "parameterOrder": [
- "filterSetName"
- ],
- "response": {
- "$ref": "ListFilteredBidRequestsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`"
- },
- "pageToken": {
- "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": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBidRequests",
- "id": "adexchangebuyer2.bidders.filterSets.filteredBidRequests.list",
- "path": "v2beta1/{+filterSetName}/filteredBidRequests"
- }
- }
- },
"nonBillableWinningBids": {
"methods": {
"list": {
@@ -379,46 +24,35 @@
"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",
- "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`"
+ "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",
- "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."
+ "location": "query"
},
"pageSize": {
- "type": "integer",
"location": "query",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ }
}
}
},
"filteredBids": {
"methods": {
"list": {
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids",
- "id": "adexchangebuyer2.bidders.filterSets.filteredBids.list",
- "path": "v2beta1/{+filterSetName}/filteredBids",
- "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListFilteredBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
"parameters": {
"filterSetName": {
"location": "path",
@@ -428,9 +62,9 @@
"pattern": "^bidders/[^/]+/filterSets/[^/]+$"
},
"pageToken": {
- "type": "string",
"location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.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": {
"location": "query",
@@ -441,13 +75,25 @@
},
"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.",
+ "response": {
+ "$ref": "ListFilteredBidsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET"
}
},
"resources": {
"details": {
"methods": {
"list": {
+ "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
"response": {
"$ref": "ListCreativeStatusBreakdownByDetailResponse"
},
@@ -456,16 +102,13 @@
"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/[^/]+$"
+ "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`"
},
"creativeStatusId": {
"required": true,
@@ -475,21 +118,23 @@
"format": "int32"
},
"pageToken": {
- "location": "query",
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the filteredBids.details.list\nmethod.",
- "type": "string"
+ "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"
+ "type": "integer",
+ "location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details",
"path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details",
- "id": "adexchangebuyer2.bidders.filterSets.filteredBids.details.list",
- "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail."
+ "id": "adexchangebuyer2.bidders.filterSets.filteredBids.details.list"
}
}
},
@@ -504,23 +149,20 @@
"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/[^/]+$",
- "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`"
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$"
},
"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",
- "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"
+ "location": "path"
},
"pageToken": {
"location": "query",
@@ -528,12 +170,15 @@
"type": "string"
},
"pageSize": {
+ "type": "integer",
"location": "query",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives",
"path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives",
"id": "adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list",
@@ -542,82 +187,149 @@
}
}
}
- }
- }
- },
- "accounts": {
- "resources": {
- "filterSets": {
+ },
+ "losingBids": {
"methods": {
- "delete": {
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.delete",
- "path": "v2beta1/{+name}",
- "description": "Deletes the requested filter set from the account with the given account\nID.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`"
- }
- }
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "FilterSet"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.get",
- "path": "v2beta1/{+name}",
- "description": "Retrieves the requested filter set for the account with the given account\nID."
- },
"list": {
- "httpMethod": "GET",
+ "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
"response": {
- "$ref": "ListFilterSetsResponse"
+ "$ref": "ListLosingBidsResponse"
},
"parameterOrder": [
- "ownerName"
+ "filterSetName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
- "ownerName": {
+ "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/[^/]+$",
- "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`"
+ "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\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/losingBids",
+ "path": "v2beta1/{+filterSetName}/losingBids",
+ "id": "adexchangebuyer2.bidders.filterSets.losingBids.list"
+ }
+ }
+ },
+ "bidMetrics": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListBidMetricsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidMetrics",
+ "path": "v2beta1/{+filterSetName}/bidMetrics",
+ "id": "adexchangebuyer2.bidders.filterSets.bidMetrics.list",
+ "description": "Lists all metrics that are measured in terms of number of bids."
+ }
+ }
+ },
+ "impressionMetrics": {
+ "methods": {
+ "list": {
+ "parameters": {
+ "filterSetName": {
+ "location": "path",
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.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}/impressionMetrics",
+ "path": "v2beta1/{+filterSetName}/impressionMetrics",
+ "id": "adexchangebuyer2.bidders.filterSets.impressionMetrics.list",
+ "description": "Lists all metrics that are measured in terms of number of impressions.",
+ "response": {
+ "$ref": "ListImpressionMetricsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET"
+ }
+ }
+ },
+ "bidResponseErrors": {
+ "methods": {
+ "list": {
+ "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "response": {
+ "$ref": "ListBidResponseErrorsResponse"
+ },
+ "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\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.",
"type": "string"
},
"pageSize": {
@@ -630,270 +342,343 @@
"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",
- "description": "Lists all filter sets for the account with the given account ID."
- },
- "create": {
- "httpMethod": "POST",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponseErrors",
+ "id": "adexchangebuyer2.bidders.filterSets.bidResponseErrors.list",
+ "path": "v2beta1/{+filterSetName}/bidResponseErrors"
+ }
+ }
+ },
+ "bidResponsesWithoutBids": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
"parameterOrder": [
- "ownerName"
+ "filterSetName"
],
"response": {
+ "$ref": "ListBidResponsesWithoutBidsResponse"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids",
+ "id": "adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list",
+ "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids",
+ "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason."
+ }
+ }
+ },
+ "filteredBidRequests": {
+ "methods": {
+ "list": {
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBidRequests",
+ "path": "v2beta1/{+filterSetName}/filteredBidRequests",
+ "id": "adexchangebuyer2.bidders.filterSets.filteredBidRequests.list",
+ "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.",
+ "response": {
+ "$ref": "ListFilteredBidRequestsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filterSetName": {
+ "location": "path",
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\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"
+ ]
+ }
+ }
+ }
+ },
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}",
+ "id": "adexchangebuyer2.bidders.filterSets.delete",
+ "path": "v2beta1/{+name}",
+ "description": "Deletes the requested filter set from the account with the given account\nID."
+ },
+ "get": {
+ "description": "Retrieves the requested filter set for the account with the given account\nID.",
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}",
+ "path": "v2beta1/{+name}",
+ "id": "adexchangebuyer2.bidders.filterSets.get"
+ },
+ "list": {
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "ownerName": {
+ "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/[^/]+$"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets",
+ "id": "adexchangebuyer2.bidders.filterSets.list",
+ "path": "v2beta1/{+ownerName}/filterSets",
+ "description": "Lists all filter sets for the account with the given account ID.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "ownerName"
+ ],
+ "response": {
+ "$ref": "ListFilterSetsResponse"
+ }
+ },
+ "create": {
+ "path": "v2beta1/{+ownerName}/filterSets",
+ "id": "adexchangebuyer2.bidders.filterSets.create",
+ "request": {
+ "$ref": "FilterSet"
+ },
+ "description": "Creates the specified filter set for the account with the given account ID.",
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "parameterOrder": [
+ "ownerName"
+ ],
+ "httpMethod": "POST",
+ "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/[^/]+$",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets"
+ }
+ }
+ },
+ "accounts": {
+ "resources": {
+ "filterSets": {
+ "methods": {
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}",
+ "path": "v2beta1/{+name}",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.get",
+ "description": "Retrieves the requested filter set for the account with the given account\nID.",
+ "response": {
"$ref": "FilterSet"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET"
+ },
+ "list": {
+ "path": "v2beta1/{+ownerName}/filterSets",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.list",
+ "description": "Lists all filter sets for the account with the given account ID.",
+ "response": {
+ "$ref": "ListFilterSetsResponse"
+ },
+ "parameterOrder": [
+ "ownerName"
+ ],
+ "httpMethod": "GET",
"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"
+ },
+ "create": {
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets",
+ "path": "v2beta1/{+ownerName}/filterSets",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.create",
+ "request": {
+ "$ref": "FilterSet"
+ },
+ "description": "Creates the specified filter set for the account with the given account ID.",
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "parameterOrder": [
+ "ownerName"
+ ],
+ "httpMethod": "POST",
+ "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/[^/]+$"
- },
- "isTransient": {
- "type": "boolean",
- "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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "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",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.create",
- "path": "v2beta1/{+ownerName}/filterSets",
- "request": {
- "$ref": "FilterSet"
- },
- "description": "Creates the specified filter set for the account with the given account ID."
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.delete",
+ "path": "v2beta1/{+name}",
+ "description": "Deletes the requested filter set from the account with the given account\nID."
}
},
"resources": {
- "filteredBids": {
- "methods": {
- "list": {
- "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
- "response": {
- "$ref": "ListFilteredBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filterSetName": {
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.list\nmethod."
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids",
- "path": "v2beta1/{+filterSetName}/filteredBids",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list"
- }
- },
- "resources": {
- "details": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListCreativeStatusBreakdownByDetailResponse"
- },
- "parameterOrder": [
- "filterSetName",
- "creativeStatusId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`"
- },
- "creativeStatusId": {
- "required": true,
- "type": "integer",
- "location": "path",
- "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.",
- "format": "int32"
- },
- "pageToken": {
- "type": "string",
- "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."
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{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."
- }
- }
- },
- "creatives": {
- "methods": {
- "list": {
- "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListCreativeStatusBreakdownByCreativeResponse"
- },
- "parameterOrder": [
- "filterSetName",
- "creativeStatusId"
- ],
- "parameters": {
- "filterSetName": {
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
- },
- "creativeStatusId": {
- "required": true,
- "type": "integer",
- "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"
- },
- "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}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list",
- "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives"
- }
- }
- }
- }
- },
- "nonBillableWinningBids": {
- "methods": {
- "list": {
- "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.",
- "response": {
- "$ref": "ListNonBillableWinningBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
- },
- "pageToken": {
- "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": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/nonBillableWinningBids",
- "path": "v2beta1/{+filterSetName}/nonBillableWinningBids",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list"
- }
- }
- },
- "losingBids": {
- "methods": {
- "list": {
- "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
- "response": {
- "$ref": "ListLosingBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filterSetName": {
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
- },
- "pageToken": {
- "type": "string",
- "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."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/losingBids",
- "path": "v2beta1/{+filterSetName}/losingBids",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.losingBids.list"
- }
- }
- },
"impressionMetrics": {
"methods": {
"list": {
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/impressionMetrics",
- "path": "v2beta1/{+filterSetName}/impressionMetrics",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list",
"description": "Lists all metrics that are measured in terms of number of impressions.",
"response": {
"$ref": "ListImpressionMetricsResponse"
@@ -902,21 +687,18 @@
"filterSetName"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"parameters": {
"filterSetName": {
- "required": true,
- "type": "string",
"pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
"location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`"
+ "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\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.",
"type": "string",
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod."
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -924,24 +706,66 @@
"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"
}
}
},
"bidMetrics": {
"methods": {
"list": {
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidMetrics",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list",
- "path": "v2beta1/{+filterSetName}/bidMetrics",
- "description": "Lists all metrics that are measured in terms of number of bids.",
- "httpMethod": "GET",
"response": {
"$ref": "ListBidMetricsResponse"
},
"parameterOrder": [
"filterSetName"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "location": "path",
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.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}/bidMetrics",
+ "path": "v2beta1/{+filterSetName}/bidMetrics",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list",
+ "description": "Lists all metrics that are measured in terms of number of bids."
+ }
+ }
+ },
+ "bidResponseErrors": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "response": {
+ "$ref": "ListBidResponseErrorsResponse"
+ },
"parameters": {
"filterSetName": {
"required": true,
@@ -951,59 +775,23 @@
"description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`"
},
"pageToken": {
- "type": "string",
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod."
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "bidResponseErrors": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListBidResponseErrorsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
- },
- "pageToken": {
"location": "query",
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.",
"type": "string"
},
"pageSize": {
+ "type": "integer",
"location": "query",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
}
},
+ "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",
+ "path": "v2beta1/{+filterSetName}/bidResponseErrors",
"description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason."
}
}
@@ -1011,20 +799,24 @@
"bidResponsesWithoutBids": {
"methods": {
"list": {
- "response": {
- "$ref": "ListBidResponsesWithoutBidsResponse"
- },
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponsesWithoutBids",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list",
+ "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids",
+ "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.",
+ "httpMethod": "GET",
"parameterOrder": [
"filterSetName"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListBidResponsesWithoutBidsResponse"
+ },
"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/[^/]+$"
+ "type": "string"
},
"pageToken": {
"type": "string",
@@ -1040,31 +832,21 @@
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "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": {
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBidRequests",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list",
- "path": "v2beta1/{+filterSetName}/filteredBidRequests",
"description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.",
- "httpMethod": "GET",
- "parameterOrder": [
- "filterSetName"
- ],
"response": {
"$ref": "ListFilteredBidRequestsResponse"
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
+ "parameterOrder": [
+ "filterSetName"
],
+ "httpMethod": "GET",
"parameters": {
"filterSetName": {
"location": "path",
@@ -1074,9 +856,230 @@
"pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
},
"pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the filteredBidRequests.list\nmethod.",
"type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "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",
+ "path": "v2beta1/{+filterSetName}/filteredBidRequests",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list"
+ }
+ }
+ },
+ "nonBillableWinningBids": {
+ "methods": {
+ "list": {
+ "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"
+ },
+ "pageToken": {
"location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the filteredBidRequests.list\nmethod."
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/nonBillableWinningBids",
+ "path": "v2beta1/{+filterSetName}/nonBillableWinningBids",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list",
+ "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason."
+ }
+ }
+ },
+ "filteredBids": {
+ "methods": {
+ "list": {
+ "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": {
+ "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\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",
+ "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/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
+ },
+ "creativeStatusId": {
+ "location": "path",
+ "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
+ "format": "int32",
+ "required": true,
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the filteredBids.creatives.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives",
+ "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives",
+ "id": "adexchangebuyer2.bidders.accounts.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": {
+ "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/[^/]+/accounts/[^/]+/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}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details",
+ "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list"
+ }
+ }
+ }
+ }
+ },
+ "losingBids": {
+ "methods": {
+ "list": {
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/losingBids",
+ "path": "v2beta1/{+filterSetName}/losingBids",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.losingBids.list",
+ "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
+ "response": {
+ "$ref": "ListLosingBidsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.",
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -1084,7 +1087,10 @@
"format": "int32",
"type": "integer"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
}
}
}
@@ -1097,149 +1103,45 @@
"accounts": {
"resources": {
"clients": {
- "methods": {
- "get": {
- "description": "Gets a client buyer with a given client account ID.",
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "response": {
- "$ref": "Client"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "accountId": {
- "location": "path",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
- "clientAccountId": {
- "location": "path",
- "description": "Numerical account ID of the client buyer to retrieve. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "id": "adexchangebuyer2.accounts.clients.get",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}"
- },
- "list": {
- "description": "Lists all the clients for the current sponsor buyer.",
- "response": {
- "$ref": "ListClientsResponse"
- },
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "type": "string",
- "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."
- },
- "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"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/clients",
- "path": "v2beta1/accounts/{accountId}/clients",
- "id": "adexchangebuyer2.accounts.clients.list"
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "response": {
- "$ref": "Client"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "clientAccountId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Unique numerical account ID of the client to update. (required)",
- "format": "int64"
- },
- "accountId": {
- "location": "path",
- "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "id": "adexchangebuyer2.accounts.clients.update",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "description": "Updates an existing client buyer.",
- "request": {
- "$ref": "Client"
- }
- },
- "create": {
- "response": {
- "$ref": "Client"
- },
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "POST",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/clients",
- "path": "v2beta1/accounts/{accountId}/clients",
- "id": "adexchangebuyer2.accounts.clients.create",
- "request": {
- "$ref": "Client"
- },
- "description": "Creates a new client buyer."
- }
- },
"resources": {
"invitations": {
"methods": {
+ "create": {
+ "response": {
+ "$ref": "ClientUserInvitation"
+ },
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "accountId": {
+ "location": "path",
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ },
+ "clientAccountId": {
+ "location": "path",
+ "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "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": {
"httpMethod": "GET",
"parameterOrder": [
@@ -1250,24 +1152,21 @@
"response": {
"$ref": "ClientUserInvitation"
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"parameters": {
"accountId": {
- "required": true,
- "type": "string",
"location": "path",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64"
- },
- "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"
},
+ "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": {
"location": "path",
"description": "Numerical identifier of the user invitation to retrieve. (required)",
@@ -1276,6 +1175,9 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
"id": "adexchangebuyer2.accounts.clients.invitations.get",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
@@ -1307,64 +1209,31 @@
"type": "string"
},
"pageSize": {
- "type": "integer",
- "location": "query",
"description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.",
- "format": "int32"
+ "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",
- "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."
+ "location": "path"
}
},
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
"id": "adexchangebuyer2.accounts.clients.invitations.list",
"description": "Lists all the client users invitations for a client\nwith a given account ID."
- },
- "create": {
- "response": {
- "$ref": "ClientUserInvitation"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "accountId": {
- "location": "path",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
- "clientAccountId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
- "format": "int64"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "id": "adexchangebuyer2.accounts.clients.invitations.create",
- "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
- "request": {
- "$ref": "ClientUserInvitation"
- }
}
}
},
"users": {
"methods": {
"list": {
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
+ "id": "adexchangebuyer2.accounts.clients.users.list",
"description": "Lists all the known client users for a specified\nsponsor buyer account ID.",
"response": {
"$ref": "ListClientUsersResponse"
@@ -1378,39 +1247,33 @@
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
- "clientAccountId": {
- "required": true,
- "type": "string",
- "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."
- },
- "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": {
- "location": "path",
"description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
"format": "int64",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"pageSize": {
- "type": "integer",
"location": "query",
"description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
+ },
+ "clientAccountId": {
+ "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",
+ "location": "path"
+ },
+ "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"
}
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
- "id": "adexchangebuyer2.accounts.clients.users.list"
+ }
},
"get": {
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "id": "adexchangebuyer2.accounts.clients.users.get",
"description": "Retrieves an existing client user.",
"response": {
"$ref": "ClientUser"
@@ -1421,20 +1284,16 @@
"userId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"parameters": {
- "clientAccountId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
- "format": "int64"
- },
"userId": {
- "required": true,
- "type": "string",
"location": "path",
"description": "Numerical identifier of the user to retrieve. (required)",
- "format": "int64"
+ "format": "int64",
+ "required": true,
+ "type": "string"
},
"accountId": {
"location": "path",
@@ -1442,145 +1301,376 @@
"format": "int64",
"required": true,
"type": "string"
+ },
+ "clientAccountId": {
+ "location": "path",
+ "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string"
}
},
- "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}",
- "id": "adexchangebuyer2.accounts.clients.users.update",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
+ "id": "adexchangebuyer2.accounts.clients.users.update",
"request": {
"$ref": "ClientUser"
},
- "httpMethod": "PUT",
+ "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
+ "response": {
+ "$ref": "ClientUser"
+ },
"parameterOrder": [
"accountId",
"clientAccountId",
"userId"
],
- "response": {
- "$ref": "ClientUser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
+ "httpMethod": "PUT",
"parameters": {
- "userId": {
- "location": "path",
- "description": "Numerical identifier of the user to retrieve. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
- "accountId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64"
- },
"clientAccountId": {
"location": "path",
"description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
"format": "int64",
"required": true,
"type": "string"
+ },
+ "userId": {
+ "description": "Numerical identifier of the user to retrieve. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "accountId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
}
}
}
- }
- },
- "creatives": {
+ },
"methods": {
- "stopWatching": {
- "httpMethod": "POST",
+ "get": {
+ "httpMethod": "GET",
"parameterOrder": [
"accountId",
- "creativeId"
+ "clientAccountId"
],
"response": {
- "$ref": "Empty"
+ "$ref": "Client"
},
+ "parameters": {
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clientAccountId": {
+ "location": "path",
+ "description": "Numerical account ID of the client buyer to retrieve. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "id": "adexchangebuyer2.accounts.clients.get",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "description": "Gets a client buyer with a given client account ID."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "response": {
+ "$ref": "ListClientsResponse"
+ },
+ "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": {
+ "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": {
+ "description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients",
+ "id": "adexchangebuyer2.accounts.clients.list",
+ "path": "v2beta1/accounts/{accountId}/clients",
+ "description": "Lists all the clients for the current sponsor buyer."
+ },
+ "update": {
+ "description": "Updates an existing client buyer.",
+ "request": {
+ "$ref": "Client"
+ },
+ "response": {
+ "$ref": "Client"
+ },
+ "parameterOrder": [
+ "accountId",
+ "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)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clientAccountId": {
"required": true,
"type": "string",
"location": "path",
- "description": "The account of the creative to stop notifications for."
- },
- "creativeId": {
+ "description": "Unique numerical account ID of the client to update. (required)",
+ "format": "int64"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "id": "adexchangebuyer2.accounts.clients.update"
+ },
+ "create": {
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "accountId": {
"location": "path",
- "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
+ "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)",
+ "format": "int64",
"required": true,
"type": "string"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "id": "adexchangebuyer2.accounts.creatives.stopWatching",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
+ "flatPath": "v2beta1/accounts/{accountId}/clients",
+ "path": "v2beta1/accounts/{accountId}/clients",
+ "id": "adexchangebuyer2.accounts.clients.create",
+ "description": "Creates a new client buyer.",
"request": {
- "$ref": "StopWatchingCreativeRequest"
- }
+ "$ref": "Client"
+ },
+ "response": {
+ "$ref": "Client"
+ },
+ "parameterOrder": [
+ "accountId"
+ ],
+ "httpMethod": "POST"
+ }
+ }
+ },
+ "creatives": {
+ "methods": {
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
+ "type": "string"
+ },
+ "accountId": {
+ "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "query": {
+ "location": "query",
+ "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eattribute: {a numeric attribute from the list of attributes}\n\u003cli\u003edisapprovalReason: {a reason from\nDisapprovalReason}\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND\ndisapprovalReason:unacceptable_content) OR attribute:47'",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives",
+ "path": "v2beta1/accounts/{accountId}/creatives",
+ "id": "adexchangebuyer2.accounts.creatives.list",
+ "description": "Lists creatives.",
+ "response": {
+ "$ref": "ListCreativesResponse"
+ },
+ "parameterOrder": [
+ "accountId"
+ ],
+ "httpMethod": "GET"
},
- "get": {
+ "create": {
+ "flatPath": "v2beta1/accounts/{accountId}/creatives",
+ "path": "v2beta1/accounts/{accountId}/creatives",
+ "id": "adexchangebuyer2.accounts.creatives.create",
+ "request": {
+ "$ref": "Creative"
+ },
+ "description": "Creates a creative.",
"response": {
"$ref": "Creative"
},
"parameterOrder": [
+ "accountId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "accountId": {
+ "location": "path",
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "required": true,
+ "type": "string"
+ },
+ "accountId1": {
+ "description": "The account the creative belongs to.",
+ "type": "string",
+ "location": "query"
+ },
+ "duplicateIdMode": {
+ "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "NO_DUPLICATES",
+ "FORCE_ENABLE_DUPLICATE_IDS"
+ ]
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "stopWatching": {
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
+ "id": "adexchangebuyer2.accounts.creatives.stopWatching",
+ "request": {
+ "$ref": "StopWatchingCreativeRequest"
+ },
+ "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
"accountId",
"creativeId"
],
- "httpMethod": "GET",
+ "httpMethod": "POST",
"parameters": {
- "creativeId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the creative to retrieve."
- },
"accountId": {
"location": "path",
- "description": "The account the creative belongs to.",
+ "description": "The account of the creative to stop notifications for.",
"required": true,
"type": "string"
+ },
+ "creativeId": {
+ "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "response": {
+ "$ref": "Creative"
+ },
+ "parameters": {
+ "accountId": {
+ "description": "The account the creative belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "creativeId": {
+ "description": "The ID of the creative to retrieve.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
"id": "adexchangebuyer2.accounts.creatives.get",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
"description": "Gets a creative."
},
"watch": {
- "httpMethod": "POST",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
+ "id": "adexchangebuyer2.accounts.creatives.watch",
+ "request": {
+ "$ref": "WatchCreativeRequest"
+ },
+ "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
+ "response": {
+ "$ref": "Empty"
+ },
"parameterOrder": [
"accountId",
"creativeId"
],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
+ "httpMethod": "POST",
"parameters": {
"creativeId": {
- "location": "path",
- "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path",
+ "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic."
},
"accountId": {
"location": "path",
@@ -1589,29 +1679,33 @@
"type": "string"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
- "id": "adexchangebuyer2.accounts.creatives.watch",
- "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"
- }
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch"
},
"update": {
- "httpMethod": "PUT",
+ "description": "Updates a creative.",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
"parameterOrder": [
"accountId",
"creativeId"
],
- "response": {
- "$ref": "Creative"
- },
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"parameters": {
"accountId": {
- "required": true,
- "type": "string",
"location": "path",
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod."
+ "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",
@@ -1625,165 +1719,57 @@
"description": "The account the creative belongs to."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "id": "adexchangebuyer2.accounts.creatives.update",
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "request": {
- "$ref": "Creative"
- },
- "description": "Updates a creative."
- },
- "list": {
- "response": {
- "$ref": "ListCreativesResponse"
- },
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "query": {
- "type": "string",
- "location": "query",
- "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eattribute: {a numeric attribute from the list of attributes}\n\u003cli\u003edisapprovalReason: {a reason from\nDisapprovalReason}\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND\ndisapprovalReason:unacceptable_content) OR attribute:47'"
- },
- "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": {
- "location": "path",
- "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives",
- "path": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.list",
- "description": "Lists creatives."
- },
- "create": {
- "flatPath": "v2beta1/accounts/{accountId}/creatives",
- "path": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.create",
- "description": "Creates a creative.",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "duplicateIdMode": {
- "type": "string",
- "location": "query",
- "enum": [
- "NO_DUPLICATES",
- "FORCE_ENABLE_DUPLICATE_IDS"
- ],
- "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative)."
- },
- "accountId": {
- "location": "path",
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "required": true,
- "type": "string"
- },
- "accountId1": {
- "location": "query",
- "description": "The account the creative belongs to.",
- "type": "string"
- }
- }
+ "id": "adexchangebuyer2.accounts.creatives.update"
}
},
"resources": {
"dealAssociations": {
"methods": {
- "list": {
- "response": {
- "$ref": "ListDealAssociationsResponse"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "query": {
- "location": "query",
- "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsId=\u003ci\u003edeals_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003c/ul\u003e\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
- "type": "string"
- },
- "creativeId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account."
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.",
- "type": "string"
- },
- "accountId": {
- "location": "path",
- "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
+ "add": {
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list",
- "description": "List all creative-deal associations."
- },
- "add": {
+ "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:add",
- "id": "adexchangebuyer2.accounts.creatives.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"
},
- "description": "Associate an existing deal with a creative.",
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Empty"
+ },
"parameterOrder": [
"accountId",
"creativeId"
],
+ "httpMethod": "POST"
+ },
+ "remove": {
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "POST",
"parameters": {
"accountId": {
"location": "path",
@@ -1800,41 +1786,61 @@
},
"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",
+ "request": {
+ "$ref": "RemoveDealAssociationRequest"
+ },
+ "description": "Remove the association between a deal and a creative."
},
- "remove": {
- "httpMethod": "POST",
+ "list": {
+ "response": {
+ "$ref": "ListDealAssociationsResponse"
+ },
"parameterOrder": [
"accountId",
"creativeId"
],
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "GET",
"parameters": {
- "creativeId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the creative associated with the deal."
- },
"accountId": {
"required": true,
"type": "string",
"location": "path",
- "description": "The account the creative belongs to."
+ "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to."
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "query": {
+ "location": "query",
+ "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsId=\u003ci\u003edeals_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003c/ul\u003e\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
+ "type": "string"
+ },
+ "creativeId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account."
+ },
+ "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"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
- "request": {
- "$ref": "RemoveDealAssociationRequest"
- },
- "description": "Remove the association between a deal and a creative."
+ "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."
}
}
}
@@ -1845,32 +1851,33 @@
},
"parameters": {
"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."
},
"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"
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
+ "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
@@ -1880,39 +1887,38 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format."
+ ]
},
"alt": {
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response."
+ "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"
},
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
"quotaUser": {
- "type": "string",
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ "description": "Available to use 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",
@@ -1926,9 +1932,9 @@
"description": "OAuth bearer token."
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"version": "v2beta1",
@@ -1937,14 +1943,343 @@
"description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
"servicePath": "",
"basePath": "",
+ "id": "adexchangebuyer2:v2beta1",
"revision": "20180125",
"documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/reference/rest/",
- "id": "adexchangebuyer2:v2beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "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": {
+ "all": {
+ "enumDescriptions": [
+ "A simple context."
+ ],
+ "enum": [
+ "SIMPLE_CONTEXT"
+ ],
+ "description": "Matches all contexts.",
+ "type": "string"
+ },
+ "appType": {
+ "$ref": "AppContext",
+ "description": "Matches impressions for a particular app type."
+ },
+ "securityType": {
+ "$ref": "SecurityContext",
+ "description": "Matches impressions for a particular security type."
+ },
+ "platform": {
+ "$ref": "PlatformContext",
+ "description": "Matches impressions coming from a particular platform."
+ },
+ "location": {
+ "$ref": "LocationContext",
+ "description": "Matches impressions coming from users *or* publishers in a specific\nlocation."
+ },
+ "auctionType": {
+ "$ref": "AuctionContext",
+ "description": "Matches impressions for a particular auction type."
+ }
+ },
+ "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": {
+ "height": {
+ "description": "Image height in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "width": {
+ "description": "Image width in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "description": "The URL of the image.",
+ "type": "string"
+ }
+ },
+ "id": "Image"
+ },
+ "ListFilterSetsResponse": {
+ "type": "object",
+ "properties": {
+ "filterSets": {
+ "description": "The filter sets belonging to the buyer.",
+ "type": "array",
+ "items": {
+ "$ref": "FilterSet"
+ }
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListFilterSetsResponse",
+ "description": "Response message for listing filter sets."
+ },
+ "BidResponseWithoutBidsStatusRow": {
+ "type": "object",
+ "properties": {
+ "rowDimensions": {
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
+ },
+ "impressionCount": {
+ "description": "The number of impressions for which there was a bid response with the\nspecified status.",
+ "$ref": "MetricValue"
+ },
+ "status": {
+ "enumDescriptions": [
+ "A placeholder for an undefined status.\nThis value will never be returned in responses.",
+ "The response had no bids.",
+ "The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.",
+ "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "RESPONSES_WITHOUT_BIDS",
+ "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
+ "RESPONSES_WITHOUT_BIDS_FOR_DEAL"
+ ],
+ "description": "The status specifying why the bid responses were considered to have no\napplicable bids.",
+ "type": "string"
+ }
+ },
+ "id": "BidResponseWithoutBidsStatusRow",
+ "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status."
+ },
+ "ClientUserInvitation": {
+ "id": "ClientUserInvitation",
+ "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.",
+ "type": "object",
+ "properties": {
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
+ "format": "int64",
+ "type": "string"
+ },
+ "invitationId": {
+ "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
+ "format": "int64",
+ "type": "string"
+ },
+ "email": {
+ "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.",
+ "type": "string"
+ }
+ }
+ },
+ "ListClientUserInvitationsResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results."
+ },
+ "invitations": {
+ "description": "The returned list of client users.",
+ "type": "array",
+ "items": {
+ "$ref": "ClientUserInvitation"
+ }
+ }
+ },
+ "id": "ListClientUserInvitationsResponse"
+ },
+ "ListClientUsersResponse": {
+ "type": "object",
+ "properties": {
+ "users": {
+ "description": "The returned list of client users.",
+ "type": "array",
+ "items": {
+ "$ref": "ClientUser"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results."
+ }
+ },
+ "id": "ListClientUsersResponse"
+ },
+ "ListCreativeStatusBreakdownByDetailResponse": {
+ "id": "ListCreativeStatusBreakdownByDetailResponse",
+ "description": "Response message for listing all details associated with a given filtered bid\nreason.",
+ "type": "object",
+ "properties": {
+ "filteredBidDetailRows": {
+ "description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.",
+ "type": "array",
+ "items": {
+ "$ref": "FilteredBidDetailRow"
+ }
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the filteredBids.details.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ },
+ "detailType": {
+ "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"
+ ]
+ }
+ }
+ },
+ "LocationContext": {
+ "description": "@OutputOnly The Geo criteria the restriction applies to.",
+ "type": "object",
+ "properties": {
+ "geoCriteriaIds": {
+ "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "id": "LocationContext"
+ },
+ "PlatformContext": {
+ "description": "@OutputOnly The type of platform the restriction applies to.",
+ "type": "object",
+ "properties": {
+ "platforms": {
+ "description": "The platforms this restriction applies to.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "DESKTOP",
+ "ANDROID",
+ "IOS"
+ ],
+ "type": "string"
+ },
+ "enumDescriptions": [
+ "Desktop platform.",
+ "Android platform.",
+ "iOS platform."
+ ]
+ }
+ },
+ "id": "PlatformContext"
+ },
+ "MetricValue": {
+ "id": "MetricValue",
+ "description": "A metric value, with an expected value and a variance; represents a count\nthat may be either exact or estimated (i.e. when sampled).",
+ "type": "object",
+ "properties": {
+ "variance": {
+ "description": "The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value",
+ "format": "int64",
+ "type": "string"
+ },
+ "value": {
+ "description": "The expected value of the metric.",
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "ClientUser": {
+ "description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.",
+ "type": "object",
+ "properties": {
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
+ "format": "int64",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the client user.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined user status.",
+ "A user who was already created but hasn't accepted the invitation yet.",
+ "A user that is currently active.",
+ "A user that is currently disabled."
+ ],
+ "enum": [
+ "USER_STATUS_UNSPECIFIED",
+ "PENDING",
+ "ACTIVE",
+ "DISABLED"
+ ]
+ },
+ "userId": {
+ "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.",
+ "format": "int64",
+ "type": "string"
+ },
+ "email": {
+ "type": "string",
+ "description": "User's email address. The value of this field\nis ignored in an update operation."
+ }
+ },
+ "id": "ClientUser"
+ },
+ "CreativeDealAssociation": {
+ "properties": {
+ "accountId": {
+ "type": "string",
+ "description": "The account the creative belongs to."
+ },
+ "creativeId": {
+ "description": "The ID of the creative associated with the deal.",
+ "type": "string"
+ },
+ "dealsId": {
+ "description": "The externalDealId for the deal associated with the creative.",
+ "type": "string"
+ }
+ },
+ "id": "CreativeDealAssociation",
+ "description": "The association between a creative and a deal.",
+ "type": "object"
+ },
"FilteringStats": {
- "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
"type": "object",
"properties": {
"reasons": {
@@ -1959,13 +2294,64 @@
"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."
}
},
- "id": "FilteringStats"
+ "id": "FilteringStats",
+ "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific)."
},
"Creative": {
"description": "A creative and its classification data.",
"type": "object",
"properties": {
+ "advertiserName": {
+ "description": "The name of the company being advertised in the creative.",
+ "type": "string"
+ },
+ "detectedDomains": {
+ "description": "@OutputOnly\nThe detected domains for this creative.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "detectedAdvertiserIds": {
+ "description": "@OutputOnly Detected advertiser IDs, if any.",
+ "type": "array",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "filteringStats": {
+ "description": "@OutputOnly The filtering stats for this creative.",
+ "$ref": "FilteringStats"
+ },
"attributes": {
+ "enumDescriptions": [
+ "Do not use. This is a placeholder value only.",
+ "The creative is tagged.",
+ "The creative is cookie targeted.",
+ "The creative is user interest targeted.",
+ "The creative does not expand.",
+ "The creative expands up.",
+ "The creative expands down.",
+ "The creative expands left.",
+ "The creative expands right.",
+ "The creative expands up and left.",
+ "The creative expands up and right.",
+ "The creative expands down and left.",
+ "The creative expands down and right.",
+ "The creative expands up or down.",
+ "The creative expands left or right.",
+ "The creative expands on any diagonal.",
+ "The creative expands when rolled over.",
+ "The instream vast video type is vpaid flash.",
+ "The creative is MRAID",
+ "The creative is SSL.",
+ "The creative is an interstitial.",
+ "The creative is eligible for native.",
+ "The creative is not eligible for native.",
+ "The creative can dynamically resize to fill a variety of slot sizes."
+ ],
+ "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"type": "array",
"items": {
"enum": [
@@ -1995,63 +2381,32 @@
"RENDERING_SIZELESS_ADX"
],
"type": "string"
- },
- "enumDescriptions": [
- "Do not use. This is a placeholder value only.",
- "The creative is tagged.",
- "The creative is cookie targeted.",
- "The creative is user interest targeted.",
- "The creative does not expand.",
- "The creative expands up.",
- "The creative expands down.",
- "The creative expands left.",
- "The creative expands right.",
- "The creative expands up and left.",
- "The creative expands up and right.",
- "The creative expands down and left.",
- "The creative expands down and right.",
- "The creative expands up or down.",
- "The creative expands left or right.",
- "The creative expands on any diagonal.",
- "The creative expands when rolled over.",
- "The instream vast video type is vpaid flash.",
- "The creative is MRAID",
- "The creative is SSL.",
- "The creative is an interstitial.",
- "The creative is eligible for native.",
- "The creative is not eligible for native.",
- "The creative can dynamically resize to fill a variety of slot sizes."
- ],
- "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod."
+ }
},
"apiUpdateTime": {
- "type": "string",
"description": "@OutputOnly The last update timestamp of the creative via API.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"detectedLanguages": {
+ "description": "@OutputOnly\nThe detected languages for this creative. The order is arbitrary. The codes\nare 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "@OutputOnly\nThe detected languages for this creative. The order is arbitrary. The codes\nare 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes."
+ }
},
"creativeId": {
- "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string"
+ "type": "string",
+ "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod."
},
"accountId": {
- "type": "string",
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod."
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "type": "string"
},
"native": {
"$ref": "NativeContent",
"description": "A native creative."
},
- "video": {
- "$ref": "VideoContent",
- "description": "A video creative."
- },
"servingRestrictions": {
"description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
"type": "array",
@@ -2059,39 +2414,43 @@
"$ref": "ServingRestriction"
}
},
+ "video": {
+ "description": "A video creative.",
+ "$ref": "VideoContent"
+ },
"agencyId": {
"description": "The agency ID for this creative.",
"format": "int64",
"type": "string"
},
"clickThroughUrls": {
+ "description": "The set of destination URLs for the creative.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "The set of destination URLs for the creative."
+ }
+ },
+ "adChoicesDestinationUrl": {
+ "description": "The link to AdChoices destination page.",
+ "type": "string"
},
"detectedSensitiveCategories": {
+ "description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
- },
- "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."
- },
- "adChoicesDestinationUrl": {
- "type": "string",
- "description": "The link to AdChoices destination page."
+ }
},
"restrictedCategories": {
"description": "All restricted categories for the ads that may be shown from this creative.",
"type": "array",
"items": {
+ "type": "string",
"enum": [
"NO_RESTRICTED_CATEGORIES",
"ALCOHOL"
- ],
- "type": "string"
+ ]
},
"enumDescriptions": [
"The ad has no restricted categories",
@@ -2099,37 +2458,44 @@
]
},
"corrections": {
+ "description": "@OutputOnly Shows any corrections that were applied to this creative.",
"type": "array",
"items": {
"$ref": "Correction"
- },
- "description": "@OutputOnly Shows any corrections that were applied to this creative."
+ }
},
"version": {
- "type": "integer",
"description": "@OutputOnly The version of this creative.",
- "format": "int32"
+ "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": {
- "type": "integer",
- "format": "int32"
- },
- "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."
+ "format": "int32",
+ "type": "integer"
+ }
},
"impressionTrackingUrls": {
+ "description": "The set of URLs to be called to record an impression.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "The set of URLs to be called to record an impression."
+ }
},
"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",
@@ -2138,14 +2504,7 @@
"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."
- ]
+ "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.",
@@ -2156,6 +2515,13 @@
}
},
"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",
@@ -2164,42 +2530,13 @@
"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": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- },
- "description": "@OutputOnly Detected advertiser IDs, if any."
- },
- "detectedDomains": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "@OutputOnly\nThe detected domains for this creative."
- },
- "filteringStats": {
- "$ref": "FilteringStats",
- "description": "@OutputOnly The filtering stats for this creative."
}
},
"id": "Creative"
},
"RemoveDealAssociationRequest": {
+ "description": "A request for removing the association between a deal and a creative.",
"type": "object",
"properties": {
"association": {
@@ -2207,52 +2544,32 @@
"description": "The association between a creative and a deal that should be removed."
}
},
- "id": "RemoveDealAssociationRequest",
- "description": "A request for removing the association between a deal and a creative."
+ "id": "RemoveDealAssociationRequest"
+ },
+ "ListCreativeStatusBreakdownByCreativeResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the filteredBids.creatives.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ },
+ "filteredBidCreativeRows": {
+ "type": "array",
+ "items": {
+ "$ref": "FilteredBidCreativeRow"
+ },
+ "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative."
+ }
+ },
+ "id": "ListCreativeStatusBreakdownByCreativeResponse",
+ "description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
+ "type": "object"
},
"Client": {
"description": "A client resource represents a client buyer—an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified.",
"type": "object",
"properties": {
- "status": {
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined client status.",
- "A client that is currently disabled.",
- "A client that is currently active."
- ],
- "enum": [
- "CLIENT_STATUS_UNSPECIFIED",
- "DISABLED",
- "ACTIVE"
- ],
- "description": "The status of the client buyer."
- },
- "partnerClientId": {
- "type": "string",
- "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."
- },
- "entityType": {
- "enum": [
- "ENTITY_TYPE_UNSPECIFIED",
- "ADVERTISER",
- "BRAND",
- "AGENCY"
- ],
- "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.",
- "A brand.",
- "An advertising agency."
- ]
- },
- "clientName": {
- "description": "Name used to represent this client to publishers.\nYou may have multiple clients that map to the same entity,\nbut for each client the combination of `clientName` and entity\nmust be unique.\nYou can specify this field as empty.",
- "type": "string"
- },
"role": {
+ "description": "The role which is assigned to the client buyer. Each role implies a set of\npermissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.",
"type": "string",
"enumDescriptions": [
"A placeholder for an undefined client role.",
@@ -2265,12 +2582,11 @@
"CLIENT_DEAL_VIEWER",
"CLIENT_DEAL_NEGOTIATOR",
"CLIENT_DEAL_APPROVER"
- ],
- "description": "The role which is assigned to the client buyer. Each role implies a set of\npermissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`."
+ ]
},
"visibleToSeller": {
- "type": "boolean",
- "description": "Whether the client buyer will be visible to sellers."
+ "description": "Whether the client buyer will be visible to sellers.",
+ "type": "boolean"
},
"entityId": {
"description": "Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
@@ -2283,36 +2599,69 @@
"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",
+ "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."
+ },
+ "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": {
+ "type": "string",
+ "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."
+ },
+ "entityType": {
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined client entity type. Should not be used.",
+ "An advertiser.",
+ "A brand.",
+ "An advertising agency."
+ ],
+ "enum": [
+ "ENTITY_TYPE_UNSPECIFIED",
+ "ADVERTISER",
+ "BRAND",
+ "AGENCY"
+ ],
+ "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`."
+ },
+ "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"
}
},
"id": "Client"
},
- "ListCreativeStatusBreakdownByCreativeResponse": {
- "description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the filteredBids.creatives.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
- "filteredBidCreativeRows": {
- "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.",
- "type": "array",
- "items": {
- "$ref": "FilteredBidCreativeRow"
- }
- }
- },
- "id": "ListCreativeStatusBreakdownByCreativeResponse"
- },
"Correction": {
"description": "@OutputOnly Shows any corrections that were applied to this creative.",
"type": "object",
"properties": {
+ "contexts": {
+ "description": "The contexts for the correction.",
+ "type": "array",
+ "items": {
+ "$ref": "ServingContext"
+ }
+ },
+ "details": {
+ "description": "Additional details about what was corrected.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"type": {
- "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.",
@@ -2341,55 +2690,16 @@
"FLASH_ATTRIBUTE_REMOVED",
"VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED"
],
- "description": "The type of correction that was applied to the creative."
- },
- "contexts": {
- "type": "array",
- "items": {
- "$ref": "ServingContext"
- },
- "description": "The contexts for the correction."
- },
- "details": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Additional details about what was corrected."
+ "description": "The type of correction that was applied to the creative.",
+ "type": "string"
}
},
"id": "Correction"
},
"FilterSet": {
+ "description": "A set of filters that is applied to a request for data.\nWithin a filter set, an AND operation is performed across the filters\nrepresented by each field. An OR operation is performed across the filters\nrepresented by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR\nseller_network_id=56)\"",
"type": "object",
"properties": {
- "platforms": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "PLATFORM_UNSPECIFIED",
- "DESKTOP",
- "TABLET",
- "MOBILE"
- ]
- },
- "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)."
- },
- "relativeDateRange": {
- "$ref": "RelativeDateRange",
- "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
- },
- "name": {
- "type": "string",
- "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."
- },
"sellerNetworkIds": {
"type": "array",
"items": {
@@ -2403,23 +2713,18 @@
"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.",
+ "The ad impression appears on the web.",
+ "The ad impression appears in an app."
+ ],
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"WEB",
"APP"
],
"description": "The environment on which to filter; optional.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined environment; indicates that no environment\nfilter will be applied.",
- "The ad impression appears on the web.",
- "The ad impression appears in an app."
- ]
- },
- "dealId": {
- "type": "string",
- "description": "The ID of the deal on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e. one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.",
- "format": "int64"
+ "type": "string"
},
"format": {
"enum": [
@@ -2435,19 +2740,24 @@
"The ad impression is video format."
]
},
+ "dealId": {
+ "type": "string",
+ "description": "The ID of the deal on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e. one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.",
+ "format": "int64"
+ },
"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"
+ ],
+ "description": "The granularity of time intervals if a time series breakdown is desired;\noptional."
},
"realtimeTimeRange": {
"$ref": "RealtimeTimeRange",
@@ -2457,12 +2767,12 @@
"description": "The list of formats on which to filter; may be empty. The filters\nrepresented by multiple formats are ORed together (i.e. if non-empty,\nresults must match any one of the formats).",
"type": "array",
"items": {
+ "type": "string",
"enum": [
"FORMAT_UNSPECIFIED",
"DISPLAY",
"VIDEO"
- ],
- "type": "string"
+ ]
},
"enumDescriptions": [
"A placeholder for an undefined format; indicates that no format filter\nwill be applied.",
@@ -2471,15 +2781,58 @@
]
},
"creativeId": {
+ "description": "The ID of the creative on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e. one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.",
+ "type": "string"
+ },
+ "relativeDateRange": {
+ "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone.",
+ "$ref": "RelativeDateRange"
+ },
+ "platforms": {
+ "enumDescriptions": [
+ "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.",
+ "The ad impression appears on a desktop.",
+ "The ad impression appears on a tablet.",
+ "The ad impression appears on a mobile device."
+ ],
+ "description": "The list of platforms on which to filter; may be empty. The filters\nrepresented by multiple platforms are ORed together (i.e. if non-empty,\nresults must match any one of the platforms).",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "PLATFORM_UNSPECIFIED",
+ "DESKTOP",
+ "TABLET",
+ "MOBILE"
+ ]
+ }
+ },
+ "name": {
"type": "string",
- "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."
+ "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."
}
},
- "id": "FilterSet",
- "description": "A set of filters that is applied to a request for data.\nWithin a filter set, an AND operation is performed across the filters\nrepresented by each field. An OR operation is performed across the filters\nrepresented by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR\nseller_network_id=56)\""
+ "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.",
+ "type": "string"
+ },
+ "associations": {
+ "description": "The list of associations.",
+ "type": "array",
+ "items": {
+ "$ref": "CreativeDealAssociation"
+ }
+ }
+ },
+ "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": {
"rowDimensions": {
@@ -2496,34 +2849,10 @@
"description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status."
}
},
- "id": "CalloutStatusRow"
- },
- "ListDealAssociationsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results."
- },
- "associations": {
- "description": "The list of associations.",
- "type": "array",
- "items": {
- "$ref": "CreativeDealAssociation"
- }
- }
- },
- "id": "ListDealAssociationsResponse",
- "description": "A response for listing creative and deal associations"
- },
- "StopWatchingCreativeRequest": {
- "description": "A request for stopping notifications for changes to creative Status.",
- "type": "object",
- "properties": {},
- "id": "StopWatchingCreativeRequest"
+ "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."
},
"Disapproval": {
- "type": "object",
"properties": {
"details": {
"description": "Additional details about the reason for disapproval.",
@@ -2533,6 +2862,7 @@
}
},
"reason": {
+ "description": "The categorized reason for disapproval.",
"type": "string",
"enumDescriptions": [
"The length of the image animation is longer than allowed.",
@@ -2725,37 +3055,43 @@
"MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED",
"PERSONAL_LOANS",
"UNSUPPORTED_FLASH_CONTENT"
- ],
- "description": "The categorized reason for disapproval."
+ ]
}
},
"id": "Disapproval",
- "description": "@OutputOnly The reason and details for a disapproval."
+ "description": "@OutputOnly The reason and details for a disapproval.",
+ "type": "object"
+ },
+ "StopWatchingCreativeRequest": {
+ "description": "A request for stopping notifications for changes to creative Status.",
+ "type": "object",
+ "properties": {},
+ "id": "StopWatchingCreativeRequest"
},
"ServingRestriction": {
"description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).",
"type": "object",
"properties": {
"status": {
- "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."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "DISAPPROVAL",
+ "PENDING_REVIEW"
]
},
"disapprovalReasons": {
- "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"type": "array",
"items": {
"$ref": "Disapproval"
- }
+ },
+ "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod."
},
"contexts": {
"type": "array",
@@ -2772,9 +3108,9 @@
"type": "object",
"properties": {
"year": {
- "type": "integer",
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
- "format": "int32"
+ "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.",
@@ -2807,9 +3143,15 @@
"id": "Empty"
},
"AppContext": {
+ "description": "@OutputOnly The app type the restriction applies to for mobile device.",
"type": "object",
"properties": {
"appTypes": {
+ "enumDescriptions": [
+ "Native app context.",
+ "Mobile web app context."
+ ],
+ "description": "The app types this restriction applies to.",
"type": "array",
"items": {
"type": "string",
@@ -2817,39 +3159,37 @@
"NATIVE",
"WEB"
]
- },
- "enumDescriptions": [
- "Native app context.",
- "Mobile web app context."
- ],
- "description": "The app types this restriction applies to."
+ }
}
},
- "id": "AppContext",
- "description": "@OutputOnly The app type the restriction applies to for mobile device."
+ "id": "AppContext"
},
"ListFilteredBidsResponse": {
"description": "Response message for listing all reasons that bids were filtered from the\nauction.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the filteredBids.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
"creativeStatusRows": {
+ "description": "List of rows, with counts of filtered bids aggregated by filtering reason\n(i.e. creative status).",
"type": "array",
"items": {
"$ref": "CreativeStatusRow"
- },
- "description": "List of rows, with counts of filtered bids aggregated by filtering reason\n(i.e. creative status)."
+ }
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the filteredBids.list\nmethod to retrieve the next page of results.",
+ "type": "string"
}
},
"id": "ListFilteredBidsResponse"
},
"SecurityContext": {
- "type": "object",
"properties": {
"securities": {
+ "enumDescriptions": [
+ "Matches impressions that require insecure compatibility.",
+ "Matches impressions that require SSL compatibility."
+ ],
+ "description": "The security types in this context.",
"type": "array",
"items": {
"enum": [
@@ -2857,65 +3197,61 @@
"SSL"
],
"type": "string"
- },
- "enumDescriptions": [
- "Matches impressions that require insecure compatibility.",
- "Matches impressions that require SSL compatibility."
- ],
- "description": "The security types in this context."
+ }
}
},
"id": "SecurityContext",
- "description": "@OutputOnly A security context."
+ "description": "@OutputOnly A security context.",
+ "type": "object"
},
"HtmlContent": {
+ "description": "HTML content for a creative.",
"type": "object",
"properties": {
- "height": {
- "description": "The height of the HTML snippet in pixels.",
- "format": "int32",
- "type": "integer"
- },
"width": {
"description": "The width of the HTML snippet in pixels.",
"format": "int32",
"type": "integer"
},
"snippet": {
- "description": "The HTML snippet that displays the ad when inserted in the web page.",
- "type": "string"
+ "type": "string",
+ "description": "The HTML snippet that displays the ad when inserted in the web page."
+ },
+ "height": {
+ "description": "The height of the HTML snippet in pixels.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "HtmlContent",
- "description": "HTML content for a creative."
+ "id": "HtmlContent"
},
"ListCreativesResponse": {
+ "description": "A response for listing creatives.",
"type": "object",
"properties": {
- "nextPageToken": {
- "type": "string",
- "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."
- },
"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",
- "description": "A response for listing creatives."
+ "id": "ListCreativesResponse"
},
"ListFilteredBidRequestsResponse": {
"type": "object",
"properties": {
"calloutStatusRows": {
+ "description": "List of rows, with counts of filtered bid requests aggregated by callout\nstatus.",
"type": "array",
"items": {
"$ref": "CalloutStatusRow"
- },
- "description": "List of rows, with counts of filtered bid requests aggregated by callout\nstatus."
+ }
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in the subsequent call to the filteredBidRequests.list\nmethod to retrieve the next page of results.",
@@ -2926,22 +3262,22 @@
"description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer."
},
"ListBidMetricsResponse": {
+ "description": "Response message for listing the metrics that are measured in number of bids.",
"type": "object",
"properties": {
- "bidMetricsRows": {
- "description": "List of rows, each containing a set of bid metrics.",
- "type": "array",
- "items": {
- "$ref": "BidMetricsRow"
- }
- },
"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": {
+ "type": "array",
+ "items": {
+ "$ref": "BidMetricsRow"
+ },
+ "description": "List of rows, each containing a set of bid metrics."
}
},
- "id": "ListBidMetricsResponse",
- "description": "Response message for listing the metrics that are measured in number of bids."
+ "id": "ListBidMetricsResponse"
},
"Reason": {
"description": "A specific filtering status and how many times it occurred.",
@@ -2953,63 +3289,72 @@
"type": "integer"
},
"count": {
- "type": "string",
"description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
}
},
"id": "Reason"
},
- "ListNonBillableWinningBidsResponse": {
+ "VideoContent": {
+ "description": "Video content for a creative.",
"type": "object",
"properties": {
- "nextPageToken": {
- "type": "string",
- "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."
- },
- "nonBillableWinningBidStatusRows": {
- "description": "List of rows, with counts of bids not billed aggregated by reason.",
- "type": "array",
- "items": {
- "$ref": "NonBillableWinningBidStatusRow"
- }
+ "videoUrl": {
+ "description": "The URL to fetch a video ad.",
+ "type": "string"
}
},
- "id": "ListNonBillableWinningBidsResponse",
- "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid."
+ "id": "VideoContent"
},
"ListLosingBidsResponse": {
+ "description": "Response message for listing all reasons that bids lost in the auction.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the losingBids.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
"creativeStatusRows": {
"description": "List of rows, with counts of losing bids aggregated by loss reason (i.e.\ncreative status).",
"type": "array",
"items": {
"$ref": "CreativeStatusRow"
}
+ },
+ "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."
+ "id": "ListLosingBidsResponse"
},
- "VideoContent": {
+ "ListNonBillableWinningBidsResponse": {
+ "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.",
"type": "object",
"properties": {
- "videoUrl": {
- "type": "string",
- "description": "The URL to fetch a video ad."
+ "nonBillableWinningBidStatusRows": {
+ "description": "List of rows, with counts of bids not billed aggregated by reason.",
+ "type": "array",
+ "items": {
+ "$ref": "NonBillableWinningBidStatusRow"
+ }
+ },
+ "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"
}
},
- "id": "VideoContent",
- "description": "Video content for a creative."
+ "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": {
"$ref": "MetricValue",
"description": "The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid."
@@ -3018,86 +3363,62 @@
"$ref": "MetricValue",
"description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange."
},
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
"availableImpressions": {
"$ref": "MetricValue",
"description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable."
},
- "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."
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
}
},
- "id": "ImpressionMetricsRow",
- "description": "The set of metrics that are measured in numbers of impressions, representing\nhow many impressions with the specified dimension values were considered\neligible at each stage of the bidding funnel."
+ "id": "ImpressionMetricsRow"
},
"AuctionContext": {
+ "id": "AuctionContext",
+ "description": "@OutputOnly The auction type the restriction applies to.",
"type": "object",
"properties": {
"auctionTypes": {
+ "description": "The auction types this restriction applies to.",
"type": "array",
"items": {
+ "type": "string",
"enum": [
"OPEN_AUCTION",
"DIRECT_DEALS"
- ],
- "type": "string"
+ ]
},
"enumDescriptions": [
"The restriction applies to open auction.",
"The restriction applies to direct deals."
- ],
- "description": "The auction types this restriction applies to."
+ ]
}
- },
- "id": "AuctionContext",
- "description": "@OutputOnly The auction type the restriction applies to."
+ }
},
"ListImpressionMetricsResponse": {
+ "description": "Response message for listing the metrics that are measured in number of\nimpressions.",
"type": "object",
"properties": {
"impressionMetricsRows": {
- "description": "List of rows, each containing a set of impression metrics.",
"type": "array",
"items": {
"$ref": "ImpressionMetricsRow"
- }
+ },
+ "description": "List of rows, each containing a set of impression metrics."
},
"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",
- "description": "Response message for listing the metrics that are measured in number of\nimpressions."
+ "id": "ListImpressionMetricsResponse"
},
"BidMetricsRow": {
+ "id": "BidMetricsRow",
"description": "The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;",
"type": "object",
"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."
@@ -3107,31 +3428,47 @@
"description": "The number of bids that were permitted to compete in the auction."
},
"rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
+ "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": {
+ "id": "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"
- }
+ },
+ "description": "List of rows, with counts of bid responses aggregated by callout status."
},
"nextPageToken": {
- "type": "string",
- "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."
+ "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": {
@@ -3148,10 +3485,10 @@
"description": "The number of bids with the specified status."
}
},
- "id": "CreativeStatusRow",
- "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status."
+ "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": {
@@ -3160,15 +3497,14 @@
"type": "string"
}
},
- "id": "RealtimeTimeRange",
- "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set."
+ "id": "RealtimeTimeRange"
},
"NonBillableWinningBidStatusRow": {
+ "id": "NonBillableWinningBidStatusRow",
"description": "The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status.",
"type": "object",
"properties": {
"status": {
- "type": "string",
"enumDescriptions": [
"A placeholder for an undefined status.\nThis value will never be returned in responses.",
"The buyer was not billed because the ad was not rendered by the\npublisher.",
@@ -3179,7 +3515,8 @@
"AD_NOT_RENDERED",
"INVALID_IMPRESSION"
],
- "description": "The status specifying why the winning bids were not billed."
+ "description": "The status specifying why the winning bids were not billed.",
+ "type": "string"
},
"rowDimensions": {
"$ref": "RowDimensions",
@@ -3189,43 +3526,42 @@
"$ref": "MetricValue",
"description": "The number of bids with the specified status."
}
- },
- "id": "NonBillableWinningBidStatusRow"
+ }
},
"FilteredBidDetailRow": {
+ "id": "FilteredBidDetailRow",
+ "description": "The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail.",
"type": "object",
"properties": {
"rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
+ "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."
+ "description": "The number of bids with the specified detail.",
+ "$ref": "MetricValue"
},
"detailId": {
- "type": "integer",
"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"
+ "format": "int32",
+ "type": "integer"
}
- },
- "id": "FilteredBidDetailRow",
- "description": "The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail."
+ }
},
"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": {
- "$ref": "Date",
- "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date."
- },
"startDate": {
- "$ref": "Date",
- "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date."
+ "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"
+ },
+ "endDate": {
+ "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date.",
+ "$ref": "Date"
}
},
- "id": "AbsoluteDateRange",
- "description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an absolute\ndate range is run at a later date more than 30 days after start_date, it will\nfail."
+ "id": "AbsoluteDateRange"
},
"AddDealAssociationRequest": {
"description": "A request for associating a deal and a creative.",
@@ -3239,40 +3575,40 @@
"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"
+ "type": "string",
+ "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."
}
},
- "id": "WatchCreativeRequest",
- "description": "A request for watching changes to creative Status."
+ "id": "WatchCreativeRequest"
},
"TimeInterval": {
+ "id": "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": {
"type": "string",
"description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
"format": "google-datetime"
+ },
+ "endTime": {
+ "type": "string",
+ "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.",
+ "format": "google-datetime"
}
- },
- "id": "TimeInterval",
- "description": "An interval of time, with an absolute start and end."
+ }
},
"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."
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
},
"bidCount": {
"$ref": "MetricValue",
@@ -3286,29 +3622,47 @@
"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"
+ },
+ "durationDays": {
+ "description": "The number of days in the requested date range. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "RelativeDateRange"
+ "id": "RelativeDateRange",
+ "description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends today.\nI.e. the limits for these values are:\noffset_days \u003e= 0\nduration_days \u003e= 1\noffset_days + duration_days \u003c= 30"
},
"NativeContent": {
- "description": "Native content for a creative.",
- "type": "object",
"properties": {
- "appIcon": {
+ "image": {
"$ref": "Image",
- "description": "The app icon, for app download ads."
+ "description": "A large image."
+ },
+ "clickTrackingUrl": {
+ "type": "string",
+ "description": "The URL to use for click tracking."
+ },
+ "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.",
@@ -3327,394 +3681,46 @@
"description": "The URL to fetch a native video ad.",
"type": "string"
},
- "logo": {
- "$ref": "Image",
- "description": "A smaller image, for the advertiser's logo."
- },
"clickLinkUrl": {
- "type": "string",
- "description": "The URL that the browser/SDK will load when the user clicks the ad."
+ "description": "The URL that the browser/SDK will load when the user clicks the ad.",
+ "type": "string"
+ },
+ "logo": {
+ "description": "A smaller image, for the advertiser's logo.",
+ "$ref": "Image"
},
"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": {
- "type": "string",
- "description": "The name of the advertiser or sponsor, to be displayed in the ad creative."
- },
- "storeUrl": {
- "description": "The URL to the app store to purchase/download the promoted app.",
- "type": "string"
- },
- "headline": {
- "type": "string",
- "description": "A short title for the ad."
}
},
- "id": "NativeContent"
+ "id": "NativeContent",
+ "description": "Native content for a creative.",
+ "type": "object"
},
"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"
+ },
+ "clients": {
+ "type": "array",
+ "items": {
+ "$ref": "Client"
+ },
+ "description": "The returned list of clients."
}
},
"id": "ListClientsResponse"
- },
- "ListBidResponsesWithoutBidsResponse": {
- "description": "Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
- "type": "object",
- "properties": {
- "bidResponseWithoutBidsStatusRows": {
- "type": "array",
- "items": {
- "$ref": "BidResponseWithoutBidsStatusRow"
- },
- "description": "List of rows, with counts of bid responses without bids aggregated by\nstatus."
- },
- "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": {
- "all": {
- "enum": [
- "SIMPLE_CONTEXT"
- ],
- "description": "Matches all contexts.",
- "type": "string",
- "enumDescriptions": [
- "A simple context."
- ]
- },
- "appType": {
- "$ref": "AppContext",
- "description": "Matches impressions for a particular app type."
- },
- "securityType": {
- "$ref": "SecurityContext",
- "description": "Matches impressions for a particular security type."
- },
- "platform": {
- "$ref": "PlatformContext",
- "description": "Matches impressions coming from a particular platform."
- },
- "location": {
- "$ref": "LocationContext",
- "description": "Matches impressions coming from users *or* publishers in a specific\nlocation."
- },
- "auctionType": {
- "$ref": "AuctionContext",
- "description": "Matches impressions for a particular auction type."
- }
- },
- "id": "ServingContext"
- },
- "Image": {
- "type": "object",
- "properties": {
- "width": {
- "description": "Image width in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "url": {
- "type": "string",
- "description": "The URL of the image."
- },
- "height": {
- "type": "integer",
- "description": "Image height in pixels.",
- "format": "int32"
- }
- },
- "id": "Image",
- "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved."
- },
- "ListFilterSetsResponse": {
- "description": "Response message for listing filter sets.",
- "type": "object",
- "properties": {
- "filterSets": {
- "type": "array",
- "items": {
- "$ref": "FilterSet"
- },
- "description": "The filter sets belonging to the buyer."
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results."
- }
- },
- "id": "ListFilterSetsResponse"
- },
- "BidResponseWithoutBidsStatusRow": {
- "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.",
- "type": "object",
- "properties": {
- "impressionCount": {
- "$ref": "MetricValue",
- "description": "The number of impressions for which there was a bid response with the\nspecified status."
- },
- "status": {
- "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."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "RESPONSES_WITHOUT_BIDS",
- "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
- "RESPONSES_WITHOUT_BIDS_FOR_DEAL"
- ],
- "description": "The status specifying why the bid responses were considered to have no\napplicable bids."
- },
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- }
- },
- "id": "BidResponseWithoutBidsStatusRow"
- },
- "ClientUserInvitation": {
- "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.",
- "type": "object",
- "properties": {
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
- "format": "int64",
- "type": "string"
- },
- "invitationId": {
- "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
- "format": "int64",
- "type": "string"
- },
- "email": {
- "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.",
- "type": "string"
- }
- },
- "id": "ClientUserInvitation"
- },
- "ListClientUserInvitationsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results."
- },
- "invitations": {
- "description": "The returned list of client users.",
- "type": "array",
- "items": {
- "$ref": "ClientUserInvitation"
- }
- }
- },
- "id": "ListClientUserInvitationsResponse"
- },
- "ListClientUsersResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results."
- },
- "users": {
- "type": "array",
- "items": {
- "$ref": "ClientUser"
- },
- "description": "The returned list of client users."
- }
- },
- "id": "ListClientUsersResponse"
- },
- "ListCreativeStatusBreakdownByDetailResponse": {
- "description": "Response message for listing all details associated with a given filtered bid\nreason.",
- "type": "object",
- "properties": {
- "filteredBidDetailRows": {
- "type": "array",
- "items": {
- "$ref": "FilteredBidDetailRow"
- },
- "description": "List of rows, with counts of bids with a given creative status aggregated\nby detail."
- },
- "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"
- },
- "LocationContext": {
- "description": "@OutputOnly The Geo criteria the restriction applies to.",
- "type": "object",
- "properties": {
- "geoCriteriaIds": {
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs."
- }
- },
- "id": "LocationContext"
- },
- "PlatformContext": {
- "description": "@OutputOnly The type of platform the restriction applies to.",
- "type": "object",
- "properties": {
- "platforms": {
- "description": "The platforms this restriction applies to.",
- "type": "array",
- "items": {
- "enum": [
- "DESKTOP",
- "ANDROID",
- "IOS"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "Desktop platform.",
- "Android platform.",
- "iOS platform."
- ]
- }
- },
- "id": "PlatformContext"
- },
- "MetricValue": {
- "description": "A metric value, with an expected value and a variance; represents a count\nthat may be either exact or estimated (i.e. when sampled).",
- "type": "object",
- "properties": {
- "variance": {
- "description": "The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value",
- "format": "int64",
- "type": "string"
- },
- "value": {
- "description": "The expected value of the metric.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "MetricValue"
- },
- "ClientUser": {
- "type": "object",
- "properties": {
- "status": {
- "enum": [
- "USER_STATUS_UNSPECIFIED",
- "PENDING",
- "ACTIVE",
- "DISABLED"
- ],
- "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."
- ]
- },
- "userId": {
- "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.",
- "format": "int64",
- "type": "string"
- },
- "email": {
- "description": "User's email address. The value of this field\nis ignored in an update operation.",
- "type": "string"
- },
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "ClientUser",
- "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."
- },
- "CreativeDealAssociation": {
- "description": "The association between a creative and a deal.",
- "type": "object",
- "properties": {
- "accountId": {
- "description": "The account the creative belongs to.",
- "type": "string"
- },
- "creativeId": {
- "type": "string",
- "description": "The ID of the creative associated with the deal."
- },
- "dealsId": {
- "type": "string",
- "description": "The externalDealId for the deal associated with the creative."
- }
- },
- "id": "CreativeDealAssociation"
}
},
- "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": "AdExchangeBuyerII",
"auth": {
"oauth2": {
@@ -3724,11 +3730,5 @@
}
}
}
- },
- "rootUrl": "https://adexchangebuyer.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "adexchangebuyer2",
- "batchPath": "batch",
- "title": "Ad Exchange Buyer API II",
- "ownerName": "Google"
+ }
}
diff --git a/adexperiencereport/v1/adexperiencereport-api.json b/adexperiencereport/v1/adexperiencereport-api.json
index 1463c4b..3ccf438 100644
--- a/adexperiencereport/v1/adexperiencereport-api.json
+++ b/adexperiencereport/v1/adexperiencereport-api.json
@@ -9,44 +9,15 @@
"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": {
- "mobileSummary": {
- "description": "Summary for the mobile review of the site.",
- "$ref": "PlatformSummary"
- },
- "reviewedSite": {
- "description": "The name of the site reviewed.",
- "type": "string"
- },
- "desktopSummary": {
- "description": "Summary for the desktop review of the site.",
- "$ref": "PlatformSummary"
- }
- },
- "id": "SiteSummaryResponse"
- },
"PlatformSummary": {
- "description": "Summary of the ad experience rating of a site for a specific platform.",
- "type": "object",
"properties": {
"betterAdsStatus": {
+ "enum": [
+ "UNKNOWN",
+ "PASSING",
+ "WARNING",
+ "FAILING"
+ ],
"description": "The status of the site reviewed for the Better Ads Standards.",
"type": "string",
"enumDescriptions": [
@@ -54,12 +25,6 @@
"Passing.",
"Warning.",
"Failing."
- ],
- "enum": [
- "UNKNOWN",
- "PASSING",
- "WARNING",
- "FAILING"
]
},
"enforcementTime": {
@@ -76,12 +41,12 @@
"description": "The assigned regions for the site and platform.",
"type": "array",
"items": {
- "type": "string",
"enum": [
"REGION_UNKNOWN",
"REGION_A",
"REGION_B"
- ]
+ ],
+ "type": "string"
}
},
"filterStatus": {
@@ -116,7 +81,42 @@
"type": "string"
}
},
- "id": "PlatformSummary"
+ "id": "PlatformSummary",
+ "description": "Summary of the ad experience rating of a site for a specific platform.",
+ "type": "object"
+ },
+ "ViolatingSitesResponse": {
+ "properties": {
+ "violatingSites": {
+ "description": "A list of summaries of violating sites.",
+ "type": "array",
+ "items": {
+ "$ref": "SiteSummaryResponse"
+ }
+ }
+ },
+ "id": "ViolatingSitesResponse",
+ "description": "Response message for ListViolatingSites.",
+ "type": "object"
+ },
+ "SiteSummaryResponse": {
+ "properties": {
+ "desktopSummary": {
+ "$ref": "PlatformSummary",
+ "description": "Summary for the desktop review of the site."
+ },
+ "mobileSummary": {
+ "description": "Summary for the mobile review of the site.",
+ "$ref": "PlatformSummary"
+ },
+ "reviewedSite": {
+ "description": "The name of the site reviewed.",
+ "type": "string"
+ }
+ },
+ "id": "SiteSummaryResponse",
+ "description": "Response message for GetSiteSummary.",
+ "type": "object"
}
},
"icons": {
@@ -141,6 +141,25 @@
"title": "Google Ad Experience Report API",
"ownerName": "Google",
"resources": {
+ "violatingSites": {
+ "methods": {
+ "list": {
+ "description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\".",
+ "response": {
+ "$ref": "ViolatingSitesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/xapi.zoo"
+ ],
+ "parameters": {},
+ "flatPath": "v1/violatingSites",
+ "path": "v1/violatingSites",
+ "id": "adexperiencereport.violatingSites.list"
+ }
+ }
+ },
"sites": {
"methods": {
"get": {
@@ -169,59 +188,10 @@
"description": "Gets a summary of the ad experience rating of a site."
}
}
- },
- "violatingSites": {
- "methods": {
- "list": {
- "description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\".",
- "response": {
- "$ref": "ViolatingSitesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/xapi.zoo"
- ],
- "parameters": {},
- "flatPath": "v1/violatingSites",
- "path": "v1/violatingSites",
- "id": "adexperiencereport.violatingSites.list"
- }
- }
}
},
"parameters": {
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -233,7 +203,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",
@@ -241,20 +213,20 @@
"type": "string"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"oauth_token": {
"location": "query",
@@ -276,6 +248,34 @@
"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": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
}
},
"version": "v1",
diff --git a/analyticsreporting/v4/analyticsreporting-api.json b/analyticsreporting/v4/analyticsreporting-api.json
index f8d9f56..f97139d 100644
--- a/analyticsreporting/v4/analyticsreporting-api.json
+++ b/analyticsreporting/v4/analyticsreporting-api.json
@@ -1,134 +1,337 @@
{
- "resources": {
- "reports": {
- "methods": {
- "batchGet": {
- "flatPath": "v4/reports:batchGet",
- "path": "v4/reports:batchGet",
- "id": "analyticsreporting.reports.batchGet",
- "request": {
- "$ref": "GetReportsRequest"
- },
- "description": "Returns the Analytics data.",
- "response": {
- "$ref": "GetReportsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- }
- },
- "parameters": {
- "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": {
- "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": {
- "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": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- }
- },
- "version": "v4",
- "baseUrl": "https://analyticsreporting.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Accesses Analytics report data.",
- "servicePath": "",
- "basePath": "",
"revision": "20180124",
"documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/",
"id": "analyticsreporting:v4",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ReportData": {
- "id": "ReportData",
- "description": "The data part of the report.",
+ "DimensionFilterClause": {
+ "properties": {
+ "operator": {
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "OR",
+ "AND"
+ ],
+ "description": "The operator for combining multiple dimension filters. If unspecified, it\nis treated as an `OR`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified operator. It is treated as an `OR`.",
+ "The logical `OR` operator.",
+ "The logical `AND` operator."
+ ]
+ },
+ "filters": {
+ "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionFilter"
+ }
+ }
+ },
+ "id": "DimensionFilterClause",
+ "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.",
+ "type": "object"
+ },
+ "GetReportsResponse": {
+ "properties": {
+ "reports": {
+ "description": "Responses corresponding to each of the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Report"
+ }
+ },
+ "queryCost": {
+ "description": "The amount of resource quota tokens deducted to execute the query. Includes\nall responses.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "resourceQuotasRemaining": {
+ "description": "The amount of resource quota remaining for the property.",
+ "$ref": "ResourceQuotasRemaining"
+ }
+ },
+ "id": "GetReportsResponse",
+ "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.",
+ "type": "object"
+ },
+ "SequenceSegment": {
+ "properties": {
+ "firstStepShouldMatchFirstHit": {
+ "description": "If set, first step condition must match the first hit of the visitor (in\nthe date range).",
+ "type": "boolean"
+ },
+ "segmentSequenceSteps": {
+ "description": "The list of steps in the sequence.",
+ "type": "array",
+ "items": {
+ "$ref": "SegmentSequenceStep"
+ }
+ }
+ },
+ "id": "SequenceSegment",
+ "description": "Sequence conditions consist of one or more steps, where each step is defined\nby one or more dimension/metric conditions. Multiple steps can be combined\nwith special sequence operators.",
+ "type": "object"
+ },
+ "SegmentMetricFilter": {
+ "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",
+ "HIT",
+ "SESSION",
+ "USER"
+ ],
+ "description": "Scope for a metric defines the level at which that metric is defined. The\nspecified metric scope must be equal to or greater than its primary scope\nas defined in the data model. The primary scope is defined by if the\nsegment is selecting users or sessions.",
+ "type": "string"
+ },
+ "maxComparisonValue": {
+ "description": "Max comparison value is only used for `BETWEEN` operator.",
+ "type": "string"
+ },
+ "comparisonValue": {
+ "description": "The value to compare against. If the operator is `BETWEEN`, this value is\ntreated as minimum comparison value.",
+ "type": "string"
+ },
+ "operator": {
+ "enum": [
+ "UNSPECIFIED_OPERATOR",
+ "LESS_THAN",
+ "GREATER_THAN",
+ "EQUAL",
+ "BETWEEN"
+ ],
+ "description": "Specifies is the operation to perform to compare the metric. The default\nis `EQUAL`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified operator is treated as `LESS_THAN` operator.",
+ "Checks if the metric value is less than comparison value.",
+ "Checks if the metric value is greater than comparison value.",
+ "Equals operator.",
+ "For between operator, both the minimum and maximum are exclusive.\nWe will use `LT` and `GT` for comparison."
+ ]
+ }
+ },
+ "id": "SegmentMetricFilter"
+ },
+ "DateRangeValues": {
+ "properties": {
+ "pivotValueRegions": {
+ "description": "The values of each pivot region.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotValueRegion"
+ }
+ },
+ "values": {
+ "description": "Each value corresponds to each Metric in the request.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "DateRangeValues",
+ "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"
+ }
+ }
+ },
+ "id": "CohortGroup"
+ },
+ "GetReportsRequest": {
+ "properties": {
+ "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",
+ "description": "The batch request containing multiple report request.",
+ "type": "object"
+ },
+ "Pivot": {
+ "properties": {
+ "dimensions": {
+ "description": "A list of dimensions to show as pivot columns. A Pivot can have a maximum\nof 4 dimensions. Pivot dimensions are part of the restriction on the\ntotal number of dimensions allowed in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Dimension"
+ }
+ },
+ "dimensionFilterClauses": {
+ "description": "DimensionFilterClauses are logically combined with an `AND` operator: only\ndata that is included by all these DimensionFilterClauses contributes to\nthe values in this pivot region. Dimension filters can be used to restrict\nthe columns shown in the pivot region. For example if you have\n`ga:browser` as the requested dimension in the pivot region, and you\nspecify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen only those two browsers would show up as columns.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionFilterClause"
+ }
+ },
+ "maxGroupCount": {
+ "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startGroup": {
+ "description": "If k metrics were requested, then the response will contain some\ndata-dependent multiple of k columns in the report. E.g., if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Firefox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of the groups\nof columns is determined by descending order of \"total\" for the first of\nthe k values. Ties are broken by lexicographic ordering of the first\npivot dimension, then lexicographic ordering of the second pivot\ndimension, and so on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nThe following let you choose which of the groups of k columns are\nincluded in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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",
+ "description": "The Pivot describes the pivot section in the request.\nThe Pivot helps rearrange the information in the table for certain reports\nby pivoting your data on a second dimension.",
+ "type": "object"
+ },
+ "PivotHeaderEntry": {
+ "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.",
+ "type": "object",
+ "properties": {
+ "dimensionNames": {
+ "description": "The name of the dimensions in the pivot response.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "metric": {
+ "$ref": "MetricHeaderEntry",
+ "description": "The metric header for the metric in the pivot."
+ },
+ "dimensionValues": {
+ "description": "The values for the dimensions in the pivot.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "PivotHeaderEntry"
+ },
+ "SegmentFilter": {
+ "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"
+ },
+ "sequenceSegment": {
+ "description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators.",
+ "$ref": "SequenceSegment"
+ }
+ },
+ "id": "SegmentFilter"
+ },
+ "SegmentDefinition": {
+ "properties": {
+ "segmentFilters": {
+ "description": "A segment is defined by a set of segment filters which are combined\ntogether with a logical `AND` operation.",
+ "type": "array",
+ "items": {
+ "$ref": "SegmentFilter"
+ }
+ }
+ },
+ "id": "SegmentDefinition",
+ "description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation.",
+ "type": "object"
+ },
+ "ResourceQuotasRemaining": {
+ "properties": {
+ "hourlyQuotaTokensRemaining": {
+ "description": "Hourly resource quota tokens remaining.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "dailyQuotaTokensRemaining": {
+ "description": "Daily resource quota remaining remaining.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ResourceQuotasRemaining",
+ "description": "The resource quota tokens remaining for the property after the request is\ncompleted.",
+ "type": "object"
+ },
+ "MetricHeaderEntry": {
+ "properties": {
+ "name": {
+ "description": "The name of the header.",
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "METRIC_TYPE_UNSPECIFIED",
+ "INTEGER",
+ "FLOAT",
+ "CURRENCY",
+ "PERCENT",
+ "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."
+ ]
+ }
+ },
+ "id": "MetricHeaderEntry",
+ "description": "Header for the metrics.",
+ "type": "object"
+ },
+ "ReportData": {
+ "properties": {
"rowCount": {
"description": "Total number of matching rows for this query.",
"format": "int32",
@@ -187,21 +390,32 @@
"type": "string"
}
}
- }
+ },
+ "id": "ReportData",
+ "description": "The data part of the report.",
+ "type": "object"
},
"DimensionFilter": {
"description": "Dimension filter specifies the filtering options on a dimension.",
"type": "object",
"properties": {
- "caseSensitive": {
- "description": "Should the match be case sensitive? Default is false.",
- "type": "boolean"
- },
"dimensionName": {
"description": "The dimension to filter on. A DimensionFilter must contain a dimension.",
"type": "string"
},
"operator": {
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "REGEXP",
+ "BEGINS_WITH",
+ "ENDS_WITH",
+ "PARTIAL",
+ "EXACT",
+ "NUMERIC_EQUAL",
+ "NUMERIC_GREATER_THAN",
+ "NUMERIC_LESS_THAN",
+ "IN_LIST"
+ ],
"description": "How to match the dimension to the expression. The default is REGEXP.",
"type": "string",
"enumDescriptions": [
@@ -215,18 +429,6 @@
"Checks if the dimension is numerically greater than the match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions.",
"Checks if the dimension is numerically less than the match expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.",
"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."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "REGEXP",
- "BEGINS_WITH",
- "ENDS_WITH",
- "PARTIAL",
- "EXACT",
- "NUMERIC_EQUAL",
- "NUMERIC_GREATER_THAN",
- "NUMERIC_LESS_THAN",
- "IN_LIST"
]
},
"not": {
@@ -239,79 +441,37 @@
"items": {
"type": "string"
}
+ },
+ "caseSensitive": {
+ "description": "Should the match be case sensitive? Default is false.",
+ "type": "boolean"
}
},
"id": "DimensionFilter"
},
- "Segment": {
- "id": "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"
- }
- }
- },
- "OrderBy": {
- "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": {
- "type": "string",
- "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."
- },
- "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",
- "description": "Specifies the sorting options.",
- "type": "object"
- },
"SegmentDimensionFilter": {
- "description": "Dimension filter specifies the filtering options on a dimension.",
- "type": "object",
"properties": {
+ "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": [
@@ -325,18 +485,6 @@
"Integer comparison filters.\ncase sensitivity is ignored for these and the expression\nis assumed to be a string representing an integer.\nFailure conditions:\n\n- if expression is not a valid int64, the client should expect\n an error.\n- input dimensions that are not valid int64 values will never match the\n filter.\n\nChecks if the dimension is numerically less than the match expression.",
"Checks if the dimension is numerically greater than the match\nexpression.",
"Checks if the dimension is numerically between the minimum and maximum\nof the match expression, boundaries excluded."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "REGEXP",
- "BEGINS_WITH",
- "ENDS_WITH",
- "PARTIAL",
- "EXACT",
- "IN_LIST",
- "NUMERIC_LESS_THAN",
- "NUMERIC_GREATER_THAN",
- "NUMERIC_BETWEEN"
]
},
"expressions": {
@@ -353,51 +501,111 @@
"minComparisonValue": {
"description": "Minimum comparison values for `BETWEEN` match type.",
"type": "string"
+ }
+ },
+ "id": "SegmentDimensionFilter",
+ "description": "Dimension filter specifies the filtering options on a dimension.",
+ "type": "object"
+ },
+ "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"
},
- "maxComparisonValue": {
- "description": "Maximum comparison values for `BETWEEN` match type.",
+ "orderType": {
+ "enumDescriptions": [
+ "Unspecified order type will be treated as sort based on value.",
+ "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
+ "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges. Usable only if there are\nexactly two date ranges.",
+ "The sort order is based on weighted value of the chosen column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
+ "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
+ "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
+ ],
+ "enum": [
+ "ORDER_TYPE_UNSPECIFIED",
+ "VALUE",
+ "DELTA",
+ "SMART",
+ "HISTOGRAM_BUCKET",
+ "DIMENSION_AS_INTEGER"
+ ],
+ "description": "The order type. The default orderType is `VALUE`.",
+ "type": "string"
+ },
+ "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": "SegmentDimensionFilter"
+ "id": "OrderBy",
+ "description": "Specifies the sorting options.",
+ "type": "object"
+ },
+ "Segment": {
+ "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",
+ "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"
},
"SegmentSequenceStep": {
- "description": "A segment sequence definition.",
- "type": "object",
"properties": {
- "matchType": {
- "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."
- ],
- "enum": [
- "UNSPECIFIED_MATCH_TYPE",
- "PRECEDES",
- "IMMEDIATELY_PRECEDES"
- ],
- "description": "Specifies if the step immediately precedes or can be any time before the\nnext step."
- },
"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"
+ "id": "SegmentSequenceStep",
+ "description": "A segment sequence definition.",
+ "type": "object"
},
"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": {
- "expression": {
- "type": "string",
- "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results."
- },
"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": [
@@ -407,26 +615,22 @@
"Currency metric.",
"Percentage metric.",
"Time metric in `HH:MM:SS` format."
- ],
- "enum": [
- "METRIC_TYPE_UNSPECIFIED",
- "INTEGER",
- "FLOAT",
- "CURRENCY",
- "PERCENT",
- "TIME"
]
},
"alias": {
"description": "An alias for the metric expression is an alternate name for the\nexpression. The alias can be used for filtering and sorting. This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe alias is also used in the response column header.",
"type": "string"
+ },
+ "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"
+ "id": "Metric",
+ "description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period.",
+ "type": "object"
},
"PivotValueRegion": {
- "description": "The metric values in the pivot region.",
- "type": "object",
"properties": {
"values": {
"description": "The values of the metrics in each of the pivot regions.",
@@ -436,26 +640,28 @@
}
}
},
- "id": "PivotValueRegion"
+ "id": "PivotValueRegion",
+ "description": "The metric values in the pivot region.",
+ "type": "object"
},
"Report": {
- "description": "The data response corresponding to the request.",
- "type": "object",
"properties": {
- "columnHeader": {
- "description": "The column headers.",
- "$ref": "ColumnHeader"
- },
"data": {
"description": "Response data.",
"$ref": "ReportData"
},
"nextPageToken": {
- "type": "string",
- "description": "Page token to retrieve the next page of results in the list."
+ "description": "Page token to retrieve the next page of results in the list.",
+ "type": "string"
+ },
+ "columnHeader": {
+ "$ref": "ColumnHeader",
+ "description": "The column headers."
}
},
- "id": "Report"
+ "id": "Report",
+ "description": "The data response corresponding to the request.",
+ "type": "object"
},
"PivotHeader": {
"description": "The headers for each of the pivot sections defined in the request.",
@@ -480,28 +686,56 @@
"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"
},
- "ReportRequest": {
- "description": "The main request class which specifies the Reporting API request.",
- "type": "object",
+ "MetricFilter": {
"properties": {
- "metrics": {
- "type": "array",
- "items": {
- "$ref": "Metric"
- },
- "description": "The metrics requested.\nRequests must specify at least one metric. Requests can have a\ntotal of 10 metrics."
+ "operator": {
+ "enumDescriptions": [
+ "If the operator is not specified, it is treated as `EQUAL`.",
+ "Should the value of the metric be exactly equal to the comparison value.",
+ "Should the value of the metric be less than to the comparison value.",
+ "Should the value of the metric be greater than to the comparison value.",
+ "Validates if the metric is missing.\nDoesn't take comparisonValue into account."
+ ],
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "EQUAL",
+ "LESS_THAN",
+ "GREATER_THAN",
+ "IS_MISSING"
+ ],
+ "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_MISSING`, checks if the metric is missing and would ignore the\ncomparisonValue.",
+ "type": "string"
},
+ "not": {
+ "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
+ "type": "boolean"
+ },
+ "metricName": {
+ "description": "The metric that will be filtered on. A metricFilter must contain a metric\nname. A metric name can be an alias earlier defined as a metric or it can\nalso be a metric expression.",
+ "type": "string"
+ },
+ "comparisonValue": {
+ "description": "The value to compare against.",
+ "type": "string"
+ }
+ },
+ "id": "MetricFilter",
+ "description": "MetricFilter specifies the filter on a metric.",
+ "type": "object"
+ },
+ "ReportRequest": {
+ "properties": {
"dimensionFilterClauses": {
"description": "The dimension filter clauses for filtering Dimension Values. They are\nlogically combined with the `AND` operator. Note that filtering occurs\nbefore any dimensions are aggregated, so that the returned metrics\nrepresent the total for only the relevant dimensions.",
"type": "array",
@@ -524,7 +758,6 @@
}
},
"samplingLevel": {
- "type": "string",
"enumDescriptions": [
"If the `samplingLevel` field is unspecified the `DEFAULT` sampling level\nis used.",
"Returns response with a sample size that balances speed and\naccuracy.",
@@ -537,7 +770,8 @@
"SMALL",
"LARGE"
],
- "description": "The desired report\n[sample](https://support.google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `samplingLevel` definition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\n for details."
+ "description": "The desired report\n[sample](https://support.google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `samplingLevel` definition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\n for details.",
+ "type": "string"
},
"dimensions": {
"description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
@@ -546,10 +780,6 @@
"$ref": "Dimension"
}
},
- "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"
- },
"dateRanges": {
"description": "Date ranges in the request. The request can have a maximum of 2 date\nranges. The response will contain a set of metric values for each\ncombination of the dimensions for each date range in the request. So, if\nthere are two date ranges, there will be two set of metric values, one for\nthe original date range and one for the second date range.\nThe `reportRequest.dateRanges` field should not be specified for cohorts\nor Lifetime value requests.\nIf a date range is not provided, the default date range is (startDate:\ncurrent date - 7 days, endDate: current date - 1 day). Every\n[ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `dateRanges` definition.",
"type": "array",
@@ -557,6 +787,10 @@
"$ref": "DateRange"
}
},
+ "pageToken": {
+ "description": "A continuation token to get the next page of the results. Adding this to\nthe request will return the rows after the pageToken. The pageToken should\nbe the value returned in the nextPageToken parameter in the response to\nthe GetReports request.",
+ "type": "string"
+ },
"pivots": {
"description": "The pivot definitions. Requests can have a maximum of 2 pivots.",
"type": "array",
@@ -588,61 +822,31 @@
"description": "If set to true, hides the minimum and maximum across all matching rows.\nThe default is false and the value ranges are returned.",
"type": "boolean"
},
+ "cohortGroup": {
+ "description": "Cohort group associated with this request. If there is a cohort group\nin the request the `ga:cohort` dimension must be present.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `cohortGroup` definition.",
+ "$ref": "CohortGroup"
+ },
"filtersExpression": {
"description": "Dimension or metric filters that restrict the data returned for your\nrequest. To use the `filtersExpression`, supply a dimension or metric on\nwhich to filter, followed by the filter expression. For example, the\nfollowing expression selects `ga:browser` dimension which starts with\nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric filters, see\n[Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).",
"type": "string"
},
- "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."
- },
"viewId": {
- "type": "string",
- "description": "The Analytics\n[view ID](https://support.google.com/analytics/answer/1009618)\nfrom which to retrieve data. Every [ReportRequest](#ReportRequest)\nwithin a `batchGet` method must contain the same `viewId`."
- }
- },
- "id": "ReportRequest"
- },
- "MetricFilter": {
- "description": "MetricFilter specifies the filter on a metric.",
- "type": "object",
- "properties": {
- "comparisonValue": {
- "description": "The value to compare against.",
+ "description": "The Analytics\n[view ID](https://support.google.com/analytics/answer/1009618)\nfrom which to retrieve data. Every [ReportRequest](#ReportRequest)\nwithin a `batchGet` method must contain the same `viewId`.",
"type": "string"
},
- "operator": {
- "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_MISSING`, checks if the metric is missing and would ignore the\ncomparisonValue.",
- "type": "string",
- "enumDescriptions": [
- "If the operator is not specified, it is treated as `EQUAL`.",
- "Should the value of the metric be exactly equal to the comparison value.",
- "Should the value of the metric be less than to the comparison value.",
- "Should the value of the metric be greater than to the comparison value.",
- "Validates if the metric is missing.\nDoesn't take comparisonValue into account."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "EQUAL",
- "LESS_THAN",
- "GREATER_THAN",
- "IS_MISSING"
- ]
- },
- "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"
+ "metrics": {
+ "description": "The metrics requested.\nRequests must specify at least one metric. Requests can have a\ntotal of 10 metrics.",
+ "type": "array",
+ "items": {
+ "$ref": "Metric"
+ }
}
},
- "id": "MetricFilter"
+ "id": "ReportRequest",
+ "description": "The main request class which specifies the Reporting API request.",
+ "type": "object"
},
"Dimension": {
- "description": "[Dimensions](https://support.google.com/analytics/answer/1033861)\nare attributes of your data. For example, the dimension `ga:city`\nindicates the city, for example, \"Paris\" or \"New York\", from which\na session originates.",
- "type": "object",
"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.",
@@ -657,12 +861,18 @@
"type": "string"
}
},
- "id": "Dimension"
+ "id": "Dimension",
+ "description": "[Dimensions](https://support.google.com/analytics/answer/1033861)\nare attributes of your data. For example, the dimension `ga:city`\nindicates the city, for example, \"Paris\" or \"New York\", from which\na session originates.",
+ "type": "object"
},
"DynamicSegment": {
"description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.",
"type": "object",
"properties": {
+ "sessionSegment": {
+ "$ref": "SegmentDefinition",
+ "description": "Session Segment to select sessions to include in the segment."
+ },
"name": {
"description": "The name of the dynamic segment.",
"type": "string"
@@ -670,10 +880,6 @@
"userSegment": {
"$ref": "SegmentDefinition",
"description": "User Segment to select users to include in the segment."
- },
- "sessionSegment": {
- "description": "Session Segment to select sessions to include in the segment.",
- "$ref": "SegmentDefinition"
}
},
"id": "DynamicSegment"
@@ -683,18 +889,16 @@
"type": "object",
"properties": {
"orFiltersForSegment": {
+ "description": "A list of segment filters groups which are combined with logical `AND`\noperator.",
"type": "array",
"items": {
"$ref": "OrFiltersForSegment"
- },
- "description": "A list of segment filters groups which are combined with logical `AND`\noperator."
+ }
}
},
"id": "SimpleSegment"
},
"ColumnHeader": {
- "description": "Column headers.",
- "type": "object",
"properties": {
"dimensions": {
"description": "The dimension names in the response.",
@@ -704,11 +908,13 @@
}
},
"metricHeader": {
- "$ref": "MetricHeader",
- "description": "Metric headers for the metrics in the response."
+ "description": "Metric headers for the metrics in the response.",
+ "$ref": "MetricHeader"
}
},
- "id": "ColumnHeader"
+ "id": "ColumnHeader",
+ "description": "Column headers.",
+ "type": "object"
},
"SegmentFilterClause": {
"description": "Filter Clause to be used in a segment definition, can be wither a metric or\na dimension filter.",
@@ -723,60 +929,12 @@
"type": "boolean"
},
"dimensionFilter": {
- "$ref": "SegmentDimensionFilter",
- "description": "Dimension Filter for the segment definition."
+ "description": "Dimension Filter for the segment definition.",
+ "$ref": "SegmentDimensionFilter"
}
},
"id": "SegmentFilterClause"
},
- "ReportRow": {
- "id": "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"
- }
- }
- }
- },
- "Cohort": {
- "description": "Defines a cohort. A cohort is a group of users who share a common\ncharacteristic. For example, all users with the same acquisition date\nbelong to the same cohort.",
- "type": "object",
- "properties": {
- "name": {
- "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
- "type": "string"
- },
- "dateRange": {
- "description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users\nwhose first visit date is between start date and end date defined in the\nDateRange. The date ranges should be aligned for cohort requests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day long,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\nat Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshould be aligned to the month (starting at the first and ending on the\nlast day of the month).\nFor LTV requests there are no such restrictions.\nYou do not need to supply a date range for the\n`reportsRequest.dateRanges` field.",
- "$ref": "DateRange"
- },
- "type": {
- "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."
- ]
- }
- },
- "id": "Cohort"
- },
"MetricFilterClause": {
"description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined.",
"type": "object",
@@ -805,8 +963,55 @@
},
"id": "MetricFilterClause"
},
+ "Cohort": {
+ "properties": {
+ "name": {
+ "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
+ "type": "string"
+ },
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users\nwhose first visit date is between start date and end date defined in the\nDateRange. The date ranges should be aligned for cohort requests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day long,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\nat Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshould be aligned to the month (starting at the first and ending on the\nlast day of the month).\nFor LTV requests there are no such restrictions.\nYou do not need to supply a date range for the\n`reportsRequest.dateRanges` field."
+ },
+ "type": {
+ "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."
+ ]
+ }
+ },
+ "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"
+ },
+ "ReportRow": {
+ "properties": {
+ "metrics": {
+ "description": "List of metrics for each requested DateRange.",
+ "type": "array",
+ "items": {
+ "$ref": "DateRangeValues"
+ }
+ },
+ "dimensions": {
+ "description": "List of requested dimensions.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ReportRow",
+ "description": "A row in the report.",
+ "type": "object"
+ },
"OrFiltersForSegment": {
- "id": "OrFiltersForSegment",
"description": "A list of segment filters in the `OR` group are combined with the logical OR\noperator.",
"type": "object",
"properties": {
@@ -817,18 +1022,17 @@
"$ref": "SegmentFilterClause"
}
}
- }
+ },
+ "id": "OrFiltersForSegment"
},
"MetricHeader": {
- "description": "The headers for the metrics.",
- "type": "object",
"properties": {
"pivotHeaders": {
+ "description": "Headers for the pivots in the response.",
"type": "array",
"items": {
"$ref": "PivotHeader"
- },
- "description": "Headers for the pivots in the response."
+ }
},
"metricHeaderEntries": {
"description": "Headers for the metrics in the response.",
@@ -838,338 +1042,15 @@
}
}
},
- "id": "MetricHeader"
- },
- "DimensionFilterClause": {
- "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.",
- "type": "object",
- "properties": {
- "operator": {
- "enumDescriptions": [
- "Unspecified operator. It is treated as an `OR`.",
- "The logical `OR` operator.",
- "The logical `AND` operator."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "OR",
- "AND"
- ],
- "description": "The operator for combining multiple dimension filters. If unspecified, it\nis treated as an `OR`.",
- "type": "string"
- },
- "filters": {
- "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
- "type": "array",
- "items": {
- "$ref": "DimensionFilter"
- }
- }
- },
- "id": "DimensionFilterClause"
- },
- "GetReportsResponse": {
- "properties": {
- "resourceQuotasRemaining": {
- "description": "The amount of resource quota remaining for the property.",
- "$ref": "ResourceQuotasRemaining"
- },
- "reports": {
- "description": "Responses corresponding to each of the request.",
- "type": "array",
- "items": {
- "$ref": "Report"
- }
- },
- "queryCost": {
- "description": "The amount of resource quota tokens deducted to execute the query. Includes\nall responses.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GetReportsResponse",
- "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.",
+ "id": "MetricHeader",
+ "description": "The headers for the metrics.",
"type": "object"
- },
- "SequenceSegment": {
- "type": "object",
- "properties": {
- "firstStepShouldMatchFirstHit": {
- "description": "If set, first step condition must match the first hit of the visitor (in\nthe date range).",
- "type": "boolean"
- },
- "segmentSequenceSteps": {
- "description": "The list of steps in the sequence.",
- "type": "array",
- "items": {
- "$ref": "SegmentSequenceStep"
- }
- }
- },
- "id": "SequenceSegment",
- "description": "Sequence conditions consist of one or more steps, where each step is defined\nby one or more dimension/metric conditions. Multiple steps can be combined\nwith special sequence operators."
- },
- "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": {
- "enum": [
- "UNSPECIFIED_SCOPE",
- "PRODUCT",
- "HIT",
- "SESSION",
- "USER"
- ],
- "description": "Scope for a metric defines the level at which that metric is defined. The\nspecified metric scope must be equal to or greater than its primary scope\nas defined in the data model. The primary scope is defined by if the\nsegment is selecting users or sessions.",
- "type": "string",
- "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."
- ]
- },
- "maxComparisonValue": {
- "description": "Max comparison value is only used for `BETWEEN` operator.",
- "type": "string"
- },
- "comparisonValue": {
- "description": "The value to compare against. If the operator is `BETWEEN`, this value is\ntreated as minimum comparison value.",
- "type": "string"
- },
- "operator": {
- "description": "Specifies is the operation to perform to compare the metric. The default\nis `EQUAL`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified operator is treated as `LESS_THAN` operator.",
- "Checks if the metric value is less than comparison value.",
- "Checks if the metric value is greater than comparison value.",
- "Equals operator.",
- "For between operator, both the minimum and maximum are exclusive.\nWe will use `LT` and `GT` for comparison."
- ],
- "enum": [
- "UNSPECIFIED_OPERATOR",
- "LESS_THAN",
- "GREATER_THAN",
- "EQUAL",
- "BETWEEN"
- ]
- }
- },
- "id": "SegmentMetricFilter"
- },
- "DateRangeValues": {
- "properties": {
- "values": {
- "description": "Each value corresponds to each Metric in the request.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "pivotValueRegions": {
- "description": "The values of each pivot region.",
- "type": "array",
- "items": {
- "$ref": "PivotValueRegion"
- }
- }
- },
- "id": "DateRangeValues",
- "description": "Used to return a list of metrics for a single DateRange / dimension\ncombination",
- "type": "object"
- },
- "CohortGroup": {
- "type": "object",
- "properties": {
- "cohorts": {
- "description": "The definition for the cohort.",
- "type": "array",
- "items": {
- "$ref": "Cohort"
- }
- },
- "lifetimeValue": {
- "description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Cohort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifetime Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be aligned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDate`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will correspond to the values in the web interface\n LifeTime value report.\n- The Lifetime Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days after a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not be aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
- "type": "boolean"
- }
- },
- "id": "CohortGroup",
- "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 }"
- },
- "GetReportsRequest": {
- "description": "The batch request containing multiple report request.",
- "type": "object",
- "properties": {
- "useResourceQuotas": {
- "description": "Enables\n[resource based quotas](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4),\n(defaults to `False`). If this field is set to `True` the\nper view (profile) quotas are governed by the computational\ncost of the request. Note that using cost based quotas will\nhigher enable sampling rates. (10 Million for `SMALL`,\n100M for `LARGE`. See the\n[limits and quotas documentation](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4) for details.",
- "type": "boolean"
- },
- "reportRequests": {
- "description": "Requests, each request will have a separate response.\nThere can be a maximum of 5 requests. All requests should have the same\n`dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.",
- "type": "array",
- "items": {
- "$ref": "ReportRequest"
- }
- }
- },
- "id": "GetReportsRequest"
- },
- "Pivot": {
- "description": "The Pivot describes the pivot section in the request.\nThe Pivot helps rearrange the information in the table for certain reports\nby pivoting your data on a second dimension.",
- "type": "object",
- "properties": {
- "maxGroupCount": {
- "type": "integer",
- "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.",
- "format": "int32"
- },
- "startGroup": {
- "type": "integer",
- "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"
- },
- "metrics": {
- "description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics allowed in the request.",
- "type": "array",
- "items": {
- "$ref": "Metric"
- }
- },
- "dimensions": {
- "description": "A list of dimensions to show as pivot columns. A Pivot can have a maximum\nof 4 dimensions. Pivot dimensions are part of the restriction on the\ntotal number of dimensions allowed in the request.",
- "type": "array",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensionFilterClauses": {
- "description": "DimensionFilterClauses are logically combined with an `AND` operator: only\ndata that is included by all these DimensionFilterClauses contributes to\nthe values in this pivot region. Dimension filters can be used to restrict\nthe columns shown in the pivot region. For example if you have\n`ga:browser` as the requested dimension in the pivot region, and you\nspecify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen only those two browsers would show up as columns.",
- "type": "array",
- "items": {
- "$ref": "DimensionFilterClause"
- }
- }
- },
- "id": "Pivot"
- },
- "PivotHeaderEntry": {
- "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",
- "items": {
- "type": "string"
- }
- },
- "metric": {
- "description": "The metric header for the metric in the pivot.",
- "$ref": "MetricHeaderEntry"
- }
- },
- "id": "PivotHeaderEntry",
- "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response."
- },
- "SegmentFilter": {
- "description": "SegmentFilter defines the segment to be either a simple or a sequence\nsegment. A simple segment condition contains dimension and metric conditions\nto select the sessions or users. A sequence segment condition can be used to\nselect users or sessions based on sequential conditions.",
- "type": "object",
- "properties": {
- "sequenceSegment": {
- "$ref": "SequenceSegment",
- "description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators."
- },
- "not": {
- "description": "If true, match the complement of simple or sequence segment.\nFor example, to match all visits not from \"New York\", we can define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segmentFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegment\": [{\n \"segmentFilterClauses\":[{\n \"dimensionFilter\": {\n \"dimensionName\": \"ga:city\",\n \"expressions\": [\"New York\"]\n }\n }]\n }]\n },\n \"not\": \"True\"\n }]\n },",
- "type": "boolean"
- },
- "simpleSegment": {
- "$ref": "SimpleSegment",
- "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined"
- }
- },
- "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.",
- "type": "array",
- "items": {
- "$ref": "SegmentFilter"
- }
- }
- },
- "id": "SegmentDefinition"
- },
- "MetricHeaderEntry": {
- "id": "MetricHeaderEntry",
- "description": "Header for the metrics.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the header.",
- "type": "string"
- },
- "type": {
- "enumDescriptions": [
- "Metric type is unspecified.",
- "Integer metric.",
- "Float metric.",
- "Currency metric.",
- "Percentage metric.",
- "Time metric in `HH:MM:SS` format."
- ],
- "enum": [
- "METRIC_TYPE_UNSPECIFIED",
- "INTEGER",
- "FLOAT",
- "CURRENCY",
- "PERCENT",
- "TIME"
- ],
- "description": "The type of the metric, for example `INTEGER`.",
- "type": "string"
- }
- }
- },
- "ResourceQuotasRemaining": {
- "description": "The resource quota tokens remaining for the property after the request is\ncompleted.",
- "type": "object",
- "properties": {
- "hourlyQuotaTokensRemaining": {
- "type": "integer",
- "description": "Hourly resource quota tokens remaining.",
- "format": "int32"
- },
- "dailyQuotaTokensRemaining": {
- "description": "Daily resource quota remaining remaining.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ResourceQuotasRemaining"
}
},
"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": "AnalyticsReporting",
"auth": {
@@ -1189,5 +1070,124 @@
"name": "analyticsreporting",
"batchPath": "batch",
"title": "Google Analytics Reporting API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "reports": {
+ "methods": {
+ "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",
+ "path": "v4/reports:batchGet",
+ "id": "analyticsreporting.reports.batchGet"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "alt": {
+ "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": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v4",
+ "baseUrl": "https://analyticsreporting.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Accesses Analytics report data.",
+ "servicePath": "",
+ "basePath": ""
}
diff --git a/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json b/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
index 8f5c462..97a90d2 100644
--- a/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
+++ b/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
@@ -1,62 +1,41 @@
{
- "ownerName": "Google",
+ "batchPath": "batch",
+ "revision": "20180125",
+ "documentationLink": "https://developers.google.com/zero-touch/",
+ "id": "androiddeviceprovisioning:v1",
+ "title": "Android Device Provisioning Partner API",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": true,
"resources": {
"customers": {
- "methods": {
- "list": {
- "flatPath": "v1/customers",
- "path": "v1/customers",
- "id": "androiddeviceprovisioning.customers.list",
- "description": "Lists the user's customer accounts.",
- "response": {
- "$ref": "CustomerListCustomersResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "description": "The maximum number of customers to show in a page of results.\nA number between 1 and 1000 (inclusive).",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "pageToken": {
- "description": "A token specifying which result page to return.",
- "type": "string",
- "location": "query"
- }
- }
- }
- },
"resources": {
"devices": {
"methods": {
"unclaim": {
- "flatPath": "v1/customers/{customersId}/devices:unclaim",
- "path": "v1/{+parent}/devices:unclaim",
"id": "androiddeviceprovisioning.customers.devices.unclaim",
+ "path": "v1/{+parent}/devices: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.",
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Empty"
+ },
"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"
+ "type": "string",
+ "pattern": "^customers/[^/]+$",
+ "location": "path"
}
- }
+ },
+ "flatPath": "v1/customers/{customersId}/devices:unclaim"
},
"removeConfiguration": {
"response": {
@@ -78,16 +57,12 @@
"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"
- }
+ },
+ "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"
},
@@ -97,43 +72,47 @@
"httpMethod": "POST",
"parameters": {
"parent": {
- "location": "path",
"description": "Required. The customer managing the device. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.",
"required": true,
"type": "string",
- "pattern": "^customers/[^/]+$"
- }
- },
- "flatPath": "v1/customers/{customersId}/devices:applyConfiguration",
- "path": "v1/{+parent}/devices:applyConfiguration",
- "id": "androiddeviceprovisioning.customers.devices.applyConfiguration"
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "CustomerListDevicesResponse"
- },
- "parameters": {
- "parent": {
- "description": "Required. The customer managing the devices. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.",
- "required": true,
- "type": "string",
"pattern": "^customers/[^/]+$",
"location": "path"
- },
+ }
+ },
+ "flatPath": "v1/customers/{customersId}/devices:applyConfiguration",
+ "path": "v1/{+parent}/devices:applyConfiguration",
+ "id": "androiddeviceprovisioning.customers.devices.applyConfiguration",
+ "description": "Applies a Configuration to the device to register the device for zero-touch\nenrollment. After applying a configuration to a device, the device\nautomatically provisions itself on first boot, or next factory reset.",
+ "request": {
+ "$ref": "CustomerApplyConfigurationRequest"
+ }
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "CustomerListDevicesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
"pageToken": {
+ "location": "query",
"description": "A token specifying which result page to return.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
"description": "The maximum number of devices to show in a page of results.\nMust be between 1 and 100 inclusive.",
"format": "int64",
"type": "string"
+ },
+ "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/[^/]+$"
}
},
"flatPath": "v1/customers/{customersId}/devices",
@@ -142,26 +121,26 @@
"description": "Lists a customer's devices."
},
"get": {
- "id": "androiddeviceprovisioning.customers.devices.get",
- "path": "v1/{+name}",
"description": "Gets the details of a device.",
- "httpMethod": "GET",
"response": {
"$ref": "Device"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
"parameters": {
"name": {
- "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",
- "pattern": "^customers/[^/]+/devices/[^/]+$"
+ "pattern": "^customers/[^/]+/devices/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v1/customers/{customersId}/devices/{devicesId}"
+ "flatPath": "v1/customers/{customersId}/devices/{devicesId}",
+ "path": "v1/{+name}",
+ "id": "androiddeviceprovisioning.customers.devices.get"
}
}
},
@@ -177,11 +156,11 @@
"httpMethod": "DELETE",
"parameters": {
"name": {
+ "pattern": "^customers/[^/]+/configurations/[^/]+$",
+ "location": "path",
"description": "Required. The configuration to delete. An API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the\nconfiguration is applied to any devices, the API call fails.",
"required": true,
- "type": "string",
- "pattern": "^customers/[^/]+/configurations/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
@@ -200,11 +179,11 @@
"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/[^/]+$"
+ "pattern": "^customers/[^/]+/configurations/[^/]+$",
+ "location": "path"
}
},
"flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
@@ -212,10 +191,6 @@
"id": "androiddeviceprovisioning.customers.configurations.get"
},
"patch": {
- "description": "Updates a configuration's field values.",
- "request": {
- "$ref": "Configuration"
- },
"response": {
"$ref": "Configuration"
},
@@ -224,25 +199,30 @@
],
"httpMethod": "PATCH",
"parameters": {
- "updateMask": {
- "location": "query",
- "description": "Required. The field mask applied to the target `Configuration` before\nupdating the fields. To learn more about using field masks, read\n[FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in\nthe Protocol Buffers documentation.",
- "format": "google-fieldmask",
- "type": "string"
- },
"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"
+ "type": "string",
+ "pattern": "^customers/[^/]+/configurations/[^/]+$",
+ "location": "path"
+ },
+ "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"
}
},
"flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
"path": "v1/{+name}",
- "id": "androiddeviceprovisioning.customers.configurations.patch"
+ "id": "androiddeviceprovisioning.customers.configurations.patch",
+ "request": {
+ "$ref": "Configuration"
+ },
+ "description": "Updates a configuration's field values."
},
"list": {
+ "description": "Lists a customer's configurations.",
"response": {
"$ref": "CustomerListConfigurationsResponse"
},
@@ -261,10 +241,16 @@
},
"flatPath": "v1/customers/{customersId}/configurations",
"path": "v1/{+parent}/configurations",
- "id": "androiddeviceprovisioning.customers.configurations.list",
- "description": "Lists a customer's configurations."
+ "id": "androiddeviceprovisioning.customers.configurations.list"
},
"create": {
+ "flatPath": "v1/customers/{customersId}/configurations",
+ "path": "v1/{+parent}/configurations",
+ "id": "androiddeviceprovisioning.customers.configurations.create",
+ "request": {
+ "$ref": "Configuration"
+ },
+ "description": "Creates a new configuration. Once created, a customer can apply the\nconfiguration to devices.",
"response": {
"$ref": "Configuration"
},
@@ -280,13 +266,6 @@
"required": true,
"type": "string"
}
- },
- "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"
}
}
}
@@ -294,6 +273,14 @@
"dpcs": {
"methods": {
"list": {
+ "description": "Lists the DPCs (device policy controllers) that support zero-touch\nenrollment.",
+ "response": {
+ "$ref": "CustomerListDpcsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
"parameters": {
"parent": {
"location": "path",
@@ -305,193 +292,95 @@
},
"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"
+ "id": "androiddeviceprovisioning.customers.dpcs.list"
}
}
}
+ },
+ "methods": {
+ "list": {
+ "description": "Lists the user's customer accounts.",
+ "response": {
+ "$ref": "CustomerListCustomersResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A token specifying which result page to return.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of customers to show in a page of results.\nA number between 1 and 1000 (inclusive).",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1/customers",
+ "path": "v1/customers",
+ "id": "androiddeviceprovisioning.customers.list"
+ }
}
},
"partners": {
"resources": {
"devices": {
"methods": {
- "unclaimAsync": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "partnerId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "partnerId": {
- "pattern": "^[^/]+$",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Partner ID."
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync",
- "path": "v1/partners/{+partnerId}/devices:unclaimAsync",
- "id": "androiddeviceprovisioning.partners.devices.unclaimAsync",
- "description": "Unclaim devices asynchronously.",
- "request": {
- "$ref": "UnclaimDevicesRequest"
- }
- },
- "metadata": {
- "response": {
- "$ref": "DeviceMetadata"
- },
- "parameterOrder": [
- "metadataOwnerId",
- "deviceId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "metadataOwnerId": {
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The owner of the newly set metadata. Set this to the partner ID.",
- "pattern": "^[^/]+$"
- },
- "deviceId": {
- "description": "ID of the partner.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata",
- "path": "v1/partners/{+metadataOwnerId}/devices/{+deviceId}/metadata",
- "id": "androiddeviceprovisioning.partners.devices.metadata",
- "description": "Update the metadata.",
- "request": {
- "$ref": "UpdateDeviceMetadataRequest"
- }
- },
- "updateMetadataAsync": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "partnerId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "partnerId": {
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Partner ID.",
- "pattern": "^[^/]+$"
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync",
- "path": "v1/partners/{+partnerId}/devices:updateMetadataAsync",
- "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync",
- "request": {
- "$ref": "UpdateDeviceMetadataInBatchRequest"
- },
- "description": "Set metadata in batch asynchronously."
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Device"
- },
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^partners/[^/]+/devices/[^/]+$",
- "location": "path",
- "description": "Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`."
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices/{devicesId}",
- "id": "androiddeviceprovisioning.partners.devices.get",
- "path": "v1/{+name}",
- "description": "Get a device."
- },
"unclaim": {
- "request": {
- "$ref": "UnclaimDeviceRequest"
- },
- "description": "Unclaim the device identified by the `device_id` or the `deviceIdentifier`.",
- "httpMethod": "POST",
- "parameterOrder": [
- "partnerId"
- ],
"response": {
"$ref": "Empty"
},
- "parameters": {
- "partnerId": {
- "location": "path",
- "description": "ID of the partner.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices:unclaim",
- "id": "androiddeviceprovisioning.partners.devices.unclaim",
- "path": "v1/partners/{+partnerId}/devices:unclaim"
- },
- "findByOwner": {
- "httpMethod": "POST",
"parameterOrder": [
"partnerId"
],
- "response": {
- "$ref": "FindDevicesByOwnerResponse"
- },
+ "httpMethod": "POST",
"parameters": {
"partnerId": {
+ "format": "int64",
+ "required": true,
+ "type": "string",
"location": "path",
"description": "ID of the partner.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "type": "string",
- "required": true
+ "pattern": "^[^/]+$"
}
},
- "flatPath": "v1/partners/{partnersId}/devices:findByOwner",
- "id": "androiddeviceprovisioning.partners.devices.findByOwner",
- "path": "v1/partners/{+partnerId}/devices:findByOwner",
+ "flatPath": "v1/partners/{partnersId}/devices:unclaim",
+ "path": "v1/partners/{+partnerId}/devices:unclaim",
+ "id": "androiddeviceprovisioning.partners.devices.unclaim",
+ "request": {
+ "$ref": "UnclaimDeviceRequest"
+ },
+ "description": "Unclaim the device identified by the `device_id` or the `deviceIdentifier`."
+ },
+ "findByOwner": {
"request": {
"$ref": "FindDevicesByOwnerRequest"
},
- "description": "Find devices by ownership."
+ "description": "Find devices by ownership.",
+ "response": {
+ "$ref": "FindDevicesByOwnerResponse"
+ },
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "partnerId": {
+ "format": "int64",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "ID of the partner.",
+ "pattern": "^[^/]+$"
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/devices:findByOwner",
+ "path": "v1/partners/{+partnerId}/devices:findByOwner",
+ "id": "androiddeviceprovisioning.partners.devices.findByOwner"
},
"claim": {
- "flatPath": "v1/partners/{partnersId}/devices:claim",
- "path": "v1/partners/{+partnerId}/devices:claim",
- "id": "androiddeviceprovisioning.partners.devices.claim",
- "request": {
- "$ref": "ClaimDeviceRequest"
- },
- "description": "Claim the device identified by device identifier.",
"response": {
"$ref": "ClaimDeviceResponse"
},
@@ -501,44 +390,49 @@
"httpMethod": "POST",
"parameters": {
"partnerId": {
+ "pattern": "^[^/]+$",
"format": "int64",
"required": true,
"type": "string",
"location": "path",
- "description": "ID of the partner.",
- "pattern": "^[^/]+$"
+ "description": "ID of the partner."
}
+ },
+ "flatPath": "v1/partners/{partnersId}/devices:claim",
+ "path": "v1/partners/{+partnerId}/devices:claim",
+ "id": "androiddeviceprovisioning.partners.devices.claim",
+ "description": "Claim the device identified by device identifier.",
+ "request": {
+ "$ref": "ClaimDeviceRequest"
}
},
"claimAsync": {
- "httpMethod": "POST",
- "parameterOrder": [
- "partnerId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "partnerId": {
- "location": "path",
- "description": "Partner ID.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices:claimAsync",
- "id": "androiddeviceprovisioning.partners.devices.claimAsync",
"path": "v1/partners/{+partnerId}/devices:claimAsync",
+ "id": "androiddeviceprovisioning.partners.devices.claimAsync",
"description": "Claim devices asynchronously.",
"request": {
"$ref": "ClaimDevicesRequest"
- }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "partnerId": {
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Partner ID.",
+ "pattern": "^[^/]+$"
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/devices:claimAsync"
},
"findByIdentifier": {
- "path": "v1/partners/{+partnerId}/devices:findByIdentifier",
- "id": "androiddeviceprovisioning.partners.devices.findByIdentifier",
"request": {
"$ref": "FindDevicesByDeviceIdentifierRequest"
},
@@ -552,43 +446,131 @@
"httpMethod": "POST",
"parameters": {
"partnerId": {
+ "format": "int64",
+ "required": true,
+ "type": "string",
"location": "path",
"description": "ID of the partner.",
+ "pattern": "^[^/]+$"
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier",
+ "path": "v1/partners/{+partnerId}/devices:findByIdentifier",
+ "id": "androiddeviceprovisioning.partners.devices.findByIdentifier"
+ },
+ "unclaimAsync": {
+ "path": "v1/partners/{+partnerId}/devices:unclaimAsync",
+ "id": "androiddeviceprovisioning.partners.devices.unclaimAsync",
+ "description": "Unclaim devices asynchronously.",
+ "request": {
+ "$ref": "UnclaimDevicesRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "partnerId": {
+ "description": "Partner ID.",
"pattern": "^[^/]+$",
"format": "int64",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
- "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier"
+ "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync"
+ },
+ "metadata": {
+ "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.",
+ "response": {
+ "$ref": "DeviceMetadata"
+ },
+ "parameterOrder": [
+ "metadataOwnerId",
+ "deviceId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "metadataOwnerId": {
+ "description": "The owner of the newly set metadata. Set this to the partner ID.",
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "deviceId": {
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the partner.",
+ "pattern": "^[^/]+$"
+ }
+ }
+ },
+ "updateMetadataAsync": {
+ "path": "v1/partners/{+partnerId}/devices:updateMetadataAsync",
+ "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync",
+ "request": {
+ "$ref": "UpdateDeviceMetadataInBatchRequest"
+ },
+ "description": "Set metadata in batch asynchronously.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "partnerId": {
+ "format": "int64",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Partner ID.",
+ "pattern": "^[^/]+$"
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync"
+ },
+ "get": {
+ "id": "androiddeviceprovisioning.partners.devices.get",
+ "path": "v1/{+name}",
+ "description": "Get a device.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Device"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^partners/[^/]+/devices/[^/]+$"
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/devices/{devicesId}"
}
}
},
"customers": {
"methods": {
- "list": {
- "response": {
- "$ref": "ListCustomersResponse"
- },
- "parameterOrder": [
- "partnerId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "partnerId": {
- "location": "path",
- "description": "The ID of the partner.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "required": true,
- "type": "string"
- }
- },
- "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."
- },
"create": {
"flatPath": "v1/partners/{partnersId}/customers",
"path": "v1/{+parent}/customers",
@@ -613,6 +595,29 @@
"pattern": "^partners/[^/]+$"
}
}
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "response": {
+ "$ref": "ListCustomersResponse"
+ },
+ "parameters": {
+ "partnerId": {
+ "location": "path",
+ "description": "The ID of the partner.",
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/customers",
+ "id": "androiddeviceprovisioning.partners.customers.list",
+ "path": "v1/partners/{+partnerId}/customers",
+ "description": "Lists the customers that are enrolled to the reseller identified by the\n`partnerId` argument. This list includes customers that the reseller\ncreated and customers that enrolled themselves using the portal."
}
}
}
@@ -621,14 +626,13 @@
"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.",
+ "httpMethod": "GET",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
"parameters": {
"name": {
"description": "The name of the operation resource.",
@@ -639,34 +643,14 @@
}
},
"flatPath": "v1/operations/{operationsId}",
+ "id": "androiddeviceprovisioning.operations.get",
"path": "v1/{+name}",
- "id": "androiddeviceprovisioning.operations.get"
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
}
}
}
},
"parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "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",
@@ -681,9 +665,9 @@
]
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"alt": {
"type": "string",
@@ -707,9 +691,9 @@
"location": "query"
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"quotaUser": {
"location": "query",
@@ -723,437 +707,38 @@
"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": {
+ "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": "OAuth bearer token.",
+ "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": {
- "DevicesLongRunningOperationMetadata": {
- "description": "Long running operation metadata.",
- "type": "object",
- "properties": {
- "progress": {
- "description": "Processing progress from 0 to 100.",
- "format": "int32",
- "type": "integer"
- },
- "devicesCount": {
- "description": "Number of devices parsed in your requests.",
- "format": "int32",
- "type": "integer"
- },
- "processingStatus": {
- "type": "string",
- "enumDescriptions": [
- "Invalid code. Shouldn't be used.",
- "Pending.",
- "In progress.",
- "Processed.\nThis doesn't mean all items were processed sucessfully, you should\ncheck the `response` field for the result of every item."
- ],
- "enum": [
- "BATCH_PROCESS_STATUS_UNSPECIFIED",
- "BATCH_PROCESS_PENDING",
- "BATCH_PROCESS_IN_PROGRESS",
- "BATCH_PROCESS_PROCESSED"
- ],
- "description": "The overall processing status."
- }
- },
- "id": "DevicesLongRunningOperationMetadata"
- },
- "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"
- },
- "customerId": {
- "description": "The customer to claim for.",
- "format": "int64",
- "type": "string"
- },
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "The device identifier of the device to claim."
- }
- },
- "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"
- }
- }
- },
- "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"
- },
- "UpdateMetadataArguments": {
- "description": "Identifies metdata updates to one device.",
- "type": "object",
- "properties": {
- "deviceIdentifier": {
- "description": "Device identifier.",
- "$ref": "DeviceIdentifier"
- },
- "deviceMetadata": {
- "description": "The metadata to update.",
- "$ref": "DeviceMetadata"
- },
- "deviceId": {
- "description": "Device ID of the device.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "UpdateMetadataArguments"
- },
- "ClaimDeviceResponse": {
- "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",
- "description": "Response message containing device id of the claim.",
- "type": "object"
- },
- "DeviceReference": {
- "description": "A `DeviceReference` is an API abstraction that lets you supply a _device_\nargument to a method using one of the following identifier types:\n\n* A numeric API resource ID.\n* Real-world hardware IDs, such as IMEI number, belonging to the manufactured\n device.\n\nMethods that operate on devices take a `DeviceReference` as a parameter type\nbecause it's more flexible for the caller. To learn more about device\nidentifiers, read [Identifiers](/zero-touch/guides/identifiers).",
- "type": "object",
- "properties": {
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "The hardware IDs of the device."
- },
- "deviceId": {
- "type": "string",
- "description": "The ID of the device.",
- "format": "int64"
- }
- },
- "id": "DeviceReference"
- },
- "Device": {
- "description": "An Android device registered for zero-touch enrollment.",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Output only. The API resource name in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server."
- },
- "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"
- },
- "claims": {
- "description": "Output only. The provisioning claims for a device. Devices claimed for\nzero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.\nCall\n`partners.devices.unclaim`\nor\n`partners.devices.unclaimAsync`\nto remove the device from zero-touch enrollment.",
- "type": "array",
- "items": {
- "$ref": "DeviceClaim"
- }
- },
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "The hardware IDs that identify a manufactured device. To learn more, read\n[Identifiers](/zero-touch/guides/identifiers)."
- },
- "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)."
- }
- },
- "id": "Device"
- },
- "CreateCustomerRequest": {
- "type": "object",
- "properties": {
- "customer": {
- "$ref": "Company",
- "description": "Required. The company data to populate the new customer. Must contain a\nvalue for `companyName` and at least one `owner_email` that's associated\nwith a Google Account. The values for `companyId` and `name` must be empty."
- }
- },
- "id": "CreateCustomerRequest",
- "description": "Request message to create a customer."
- },
- "Company": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Output only. The API resource name of the company in the format\n`partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`. Assigned by the server.",
- "type": "string"
- },
- "companyName": {
- "description": "Required. The name of the company. For example _XYZ Corp_. Characters\nallowed are: Latin letters, numerals, hyphens, and spaces. Displayed to the\ncustomer's employees in the zero-touch enrollment portal.",
- "type": "string"
- },
- "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"
- }
- },
- "ownerEmails": {
- "description": "Input only. Email address of customer's users in the owner role. At least\none `owner_email` is required. Each email address must be associated with a\nGoogle Account. Owners share the same access as admins but can also add,\ndelete, and edit your organization's portal users.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "companyId": {
- "description": "Output only. The ID of the company. Assigned by the server.",
- "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": {
- "description": "The metdata to set.",
- "$ref": "DeviceMetadata"
- }
- },
- "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": {
- "isDefault": {
- "type": "boolean",
- "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`."
- },
- "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"
- },
- "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": {
- "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by\nthe server.",
- "type": "string"
- },
- "configurationName": {
- "description": "Required. A short name that describes the configuration's purpose. For\nexample, _Sales team_ or _Temporary employees_. The zero-touch enrollment\nportal displays this name to IT admins.",
- "type": "string"
- },
- "contactPhone": {
- "description": "Required. The telephone number that device users can call, using another\ndevice, to get help. Zero-touch enrollment shows this number to device\nusers before device provisioning. Accepts numerals, spaces, the plus sign,\nhyphens, and parentheses.",
- "type": "string"
- },
- "companyName": {
- "description": "Required. The name of the organization. Zero-touch enrollment shows this\norganization name to device users during device provisioning.",
- "type": "string"
- },
- "configurationId": {
- "description": "Output only. The ID of the configuration. Assigned by the server.",
- "format": "int64",
- "type": "string"
- },
- "dpcResourcePath": {
- "description": "Required. The resource name of the selected DPC (device policy controller)\nin the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,\ncall\n`customers.dpcs.list`.",
- "type": "string"
- }
- },
- "id": "Configuration"
- },
- "PartnerUnclaim": {
- "description": "Identifies one unclaim request.",
- "type": "object",
- "properties": {
- "deviceId": {
- "description": "Device ID of the device.",
- "format": "int64",
- "type": "string"
- },
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "Device identifier of the device."
- },
- "sectionType": {
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "Section type to unclaim.",
- "type": "string"
- }
- },
- "id": "PartnerUnclaim"
- },
- "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"
- }
- }
- },
- "id": "CustomerListDpcsResponse"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "FindDevicesByDeviceIdentifierResponse": {
- "properties": {
- "devices": {
- "description": "Found devices.",
- "type": "array",
- "items": {
- "$ref": "Device"
- }
- },
- "nextPageToken": {
- "description": "Page token of the next page.",
- "type": "string"
- }
- },
- "id": "FindDevicesByDeviceIdentifierResponse",
- "description": "Response containing found devices.",
- "type": "object"
- },
- "PartnerClaim": {
- "type": "object",
- "properties": {
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "Device identifier of the device."
- },
- "deviceMetadata": {
- "description": "Metadata to set at claim.",
- "$ref": "DeviceMetadata"
- },
- "sectionType": {
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "Section type to claim.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ]
- },
- "customerId": {
- "description": "Customer ID to claim for.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "PartnerClaim",
- "description": "Identifies one claim request."
- },
- "UnclaimDeviceRequest": {
- "properties": {
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "The device identifier you used when you claimed this device."
- },
- "sectionType": {
- "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": {
- "description": "The device ID returned by `ClaimDevice`.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "UnclaimDeviceRequest",
- "description": "Request message to unclaim a device.",
- "type": "object"
- },
- "DeviceMetadata": {
- "description": "Metadata entries that can be attached to a `Device`. To learn more, read\n[Device metadata](/zero-touch/guides/metadata).",
- "type": "object",
- "properties": {
- "entries": {
- "description": "Metadata entries recorded as key-value pairs.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "id": "DeviceMetadata"
- },
"CustomerListCustomersResponse": {
"description": "Response message for listing my customers.",
"type": "object",
@@ -1191,7 +776,6 @@
"id": "CustomerListDevicesResponse"
},
"DevicesLongRunningOperationResponse": {
- "type": "object",
"properties": {
"successCount": {
"description": "Number of succeesfully processed ones.",
@@ -1207,22 +791,23 @@
}
},
"id": "DevicesLongRunningOperationResponse",
- "description": "Long running operation response."
+ "description": "Long running operation response.",
+ "type": "object"
},
"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": {
"sectionType": {
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
"description": "Output only. The type of claim made on the device.",
"type": "string",
"enumDescriptions": [
"Unspecified section type.",
"Zero-touch enrollment section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
]
},
"ownerCompanyId": {
@@ -1234,30 +819,23 @@
"id": "DeviceClaim"
},
"PerDeviceStatusInBatch": {
- "id": "PerDeviceStatusInBatch",
"description": "Stores the processing result for each device.",
"type": "object",
"properties": {
+ "errorIdentifier": {
+ "description": "Error identifier.",
+ "type": "string"
+ },
"errorMessage": {
"description": "Error message.",
"type": "string"
},
"deviceId": {
- "type": "string",
"description": "Device ID of the device if process succeeds.",
- "format": "int64"
+ "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": [
@@ -1269,32 +847,33 @@
"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": {
- "type": "string",
- "description": "Error identifier."
- }
- }
- },
- "ClaimDevicesRequest": {
- "description": "Request to claim devices asynchronously in batch.",
- "type": "object",
- "properties": {
- "claims": {
- "description": "List of claims.",
- "type": "array",
- "items": {
- "$ref": "PartnerClaim"
- }
}
},
- "id": "ClaimDevicesRequest"
+ "id": "PerDeviceStatusInBatch"
},
"FindDevicesByOwnerRequest": {
"description": "Request to find devices by customers.",
"type": "object",
"properties": {
+ "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",
@@ -1315,58 +894,32 @@
"SECTION_TYPE_UNSPECIFIED",
"SECTION_TYPE_ZERO_TOUCH"
]
- },
- "customerId": {
- "description": "List of customer IDs to search for.",
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- }
}
},
"id": "FindDevicesByOwnerRequest"
},
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
+ "ClaimDevicesRequest": {
"properties": {
- "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`."
- },
- "metadata": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`."
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
+ "claims": {
+ "description": "List of claims.",
+ "type": "array",
+ "items": {
+ "$ref": "PartnerClaim"
+ }
}
},
- "id": "Operation"
+ "id": "ClaimDevicesRequest",
+ "description": "Request to claim devices asynchronously in batch.",
+ "type": "object"
},
"DeviceIdentifier": {
- "id": "DeviceIdentifier",
"description": "Encapsulates hardware and product IDs to identify a manufactured device. To\nlearn more, read [Identifiers](/zero-touch/guides/identifiers).",
"type": "object",
"properties": {
+ "imei": {
+ "description": "The device’s IMEI number. Validated on input.",
+ "type": "string"
+ },
"meid": {
"description": "The device’s MEID number.",
"type": "string"
@@ -1378,14 +931,47 @@
"serialNumber": {
"description": "The manufacturer's serial number for the device. This value might not be\nunique.",
"type": "string"
- },
- "imei": {
- "type": "string",
- "description": "The device’s IMEI number. Validated on input."
}
- }
+ },
+ "id": "DeviceIdentifier"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "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"
},
"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": {
@@ -1397,12 +983,26 @@
"type": "string"
},
"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."
+ "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."
+ "id": "Dpc"
+ },
+ "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": {
+ "description": "Required. The device the configuration is applied to.",
+ "$ref": "DeviceReference"
+ }
+ },
+ "id": "CustomerApplyConfigurationRequest"
},
"UnclaimDevicesRequest": {
"description": "Request to unclaim devices asynchronously in batch.",
@@ -1418,36 +1018,53 @@
},
"id": "UnclaimDevicesRequest"
},
- "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"
},
+ "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"
+ },
"FindDevicesByDeviceIdentifierRequest": {
"description": "Request to find devices.",
"type": "object",
"properties": {
+ "limit": {
+ "description": "Number of devices to show.",
+ "format": "int64",
+ "type": "string"
+ },
"deviceIdentifier": {
"$ref": "DeviceIdentifier",
"description": "The device identifier to search."
@@ -1455,41 +1072,23 @@
"pageToken": {
"description": "Page token.",
"type": "string"
- },
- "limit": {
- "description": "Number of devices to show.",
- "format": "int64",
- "type": "string"
}
},
"id": "FindDevicesByDeviceIdentifierRequest"
},
- "Status": {
+ "CustomerListConfigurationsResponse": {
+ "description": "Response message of customer's listing configuration.",
"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.",
+ "configurations": {
+ "description": "The configurations.",
"type": "array",
"items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
+ "$ref": "Configuration"
}
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
}
},
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons."
+ "id": "CustomerListConfigurationsResponse"
},
"OperationPerDevice": {
"description": "Operation the server received for every device.",
@@ -1514,21 +1113,8 @@
},
"id": "OperationPerDevice"
},
- "CustomerListConfigurationsResponse": {
- "properties": {
- "configurations": {
- "description": "The configurations.",
- "type": "array",
- "items": {
- "$ref": "Configuration"
- }
- }
- },
- "id": "CustomerListConfigurationsResponse",
- "description": "Response message of customer's listing configuration.",
- "type": "object"
- },
"FindDevicesByOwnerResponse": {
+ "description": "Response containing found devices.",
"type": "object",
"properties": {
"devices": {
@@ -1543,8 +1129,7 @@
"type": "string"
}
},
- "id": "FindDevicesByOwnerResponse",
- "description": "Response containing found devices."
+ "id": "FindDevicesByOwnerResponse"
},
"CustomerRemoveConfigurationRequest": {
"description": "Request message for customer to remove the configuration from device.",
@@ -1556,13 +1141,433 @@
}
},
"id": "CustomerRemoveConfigurationRequest"
+ },
+ "ClaimDeviceRequest": {
+ "description": "Request message to claim a device on behalf of a customer.",
+ "type": "object",
+ "properties": {
+ "deviceIdentifier": {
+ "description": "The device identifier of the device to claim.",
+ "$ref": "DeviceIdentifier"
+ },
+ "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"
+ },
+ "customerId": {
+ "description": "The customer to claim for.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "ClaimDeviceRequest"
+ },
+ "DevicesLongRunningOperationMetadata": {
+ "description": "Long running operation metadata.",
+ "type": "object",
+ "properties": {
+ "processingStatus": {
+ "enumDescriptions": [
+ "Invalid code. Shouldn't be used.",
+ "Pending.",
+ "In progress.",
+ "Processed.\nThis doesn't mean all items were processed sucessfully, you should\ncheck the `response` field for the result of every item."
+ ],
+ "enum": [
+ "BATCH_PROCESS_STATUS_UNSPECIFIED",
+ "BATCH_PROCESS_PENDING",
+ "BATCH_PROCESS_IN_PROGRESS",
+ "BATCH_PROCESS_PROCESSED"
+ ],
+ "description": "The overall processing status.",
+ "type": "string"
+ },
+ "progress": {
+ "description": "Processing progress from 0 to 100.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "devicesCount": {
+ "description": "Number of devices parsed in your requests.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DevicesLongRunningOperationMetadata"
+ },
+ "UpdateDeviceMetadataInBatchRequest": {
+ "description": "Request to update device metadata in batch.",
+ "type": "object",
+ "properties": {
+ "updates": {
+ "description": "List of metadata updates.",
+ "type": "array",
+ "items": {
+ "$ref": "UpdateMetadataArguments"
+ }
+ }
+ },
+ "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": {
+ "description": "Identifies metdata updates to one device.",
+ "type": "object",
+ "properties": {
+ "deviceId": {
+ "description": "Device ID of the device.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deviceIdentifier": {
+ "description": "Device identifier.",
+ "$ref": "DeviceIdentifier"
+ },
+ "deviceMetadata": {
+ "description": "The metadata to update.",
+ "$ref": "DeviceMetadata"
+ }
+ },
+ "id": "UpdateMetadataArguments"
+ },
+ "DeviceReference": {
+ "description": "A `DeviceReference` is an API abstraction that lets you supply a _device_\nargument to a method using one of the following identifier types:\n\n* A numeric API resource ID.\n* Real-world hardware IDs, such as IMEI number, belonging to the manufactured\n device.\n\nMethods that operate on devices take a `DeviceReference` as a parameter type\nbecause it's more flexible for the caller. To learn more about device\nidentifiers, read [Identifiers](/zero-touch/guides/identifiers).",
+ "type": "object",
+ "properties": {
+ "deviceId": {
+ "description": "The ID of the device.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "The hardware IDs of the device."
+ }
+ },
+ "id": "DeviceReference"
+ },
+ "Device": {
+ "description": "An Android device registered for zero-touch enrollment.",
+ "type": "object",
+ "properties": {
+ "deviceIdentifier": {
+ "description": "The hardware IDs that identify a manufactured device. To learn more, read\n[Identifiers](/zero-touch/guides/identifiers).",
+ "$ref": "DeviceIdentifier"
+ },
+ "deviceMetadata": {
+ "description": "The metadata attached to the device. Structured as key-value pairs. To\nlearn more, read [Device metadata](/zero-touch/guides/metadata).",
+ "$ref": "DeviceMetadata"
+ },
+ "name": {
+ "description": "Output only. The API resource name in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "Output only. The ID of the device. Assigned by the server.",
+ "format": "int64",
+ "type": "string"
+ },
+ "configuration": {
+ "description": "Not available to resellers.",
+ "type": "string"
+ },
+ "claims": {
+ "description": "Output only. The provisioning claims for a device. Devices claimed for\nzero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.\nCall\n`partners.devices.unclaim`\nor\n`partners.devices.unclaimAsync`\nto remove the device from zero-touch enrollment.",
+ "type": "array",
+ "items": {
+ "$ref": "DeviceClaim"
+ }
+ }
+ },
+ "id": "Device"
+ },
+ "CreateCustomerRequest": {
+ "properties": {
+ "customer": {
+ "$ref": "Company",
+ "description": "Required. The company data to populate the new customer. Must contain a\nvalue for `companyName` and at least one `owner_email` that's associated\nwith a Google Account. The values for `companyId` and `name` must be empty."
+ }
+ },
+ "id": "CreateCustomerRequest",
+ "description": "Request message to create a customer.",
+ "type": "object"
+ },
+ "Company": {
+ "description": "A customer resource in the zero-touch enrollment API.",
+ "type": "object",
+ "properties": {
+ "companyId": {
+ "description": "Output only. The ID of the company. Assigned by the server.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The API resource name of the company in the format\n`partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`. Assigned by the server.",
+ "type": "string"
+ },
+ "companyName": {
+ "description": "Required. The name of the company. For example _XYZ Corp_. Characters\nallowed are: Latin letters, numerals, hyphens, and spaces. Displayed to the\ncustomer's employees in the zero-touch enrollment portal.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "ownerEmails": {
+ "description": "Input only. Email address of customer's users in the owner role. At least\none `owner_email` is required. Each email address must be associated with a\nGoogle Account. Owners share the same access as admins but can also add,\ndelete, and edit your organization's portal users.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "Company"
+ },
+ "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": {
+ "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": {
+ "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by\nthe server.",
+ "type": "string"
+ },
+ "configurationName": {
+ "description": "Required. A short name that describes the configuration's purpose. For\nexample, _Sales team_ or _Temporary employees_. The zero-touch enrollment\nportal displays this name to IT admins.",
+ "type": "string"
+ },
+ "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"
+ },
+ "isDefault": {
+ "description": "Required. Whether this is the default configuration that zero-touch\nenrollment applies to any new devices the organization purchases in the\nfuture. Only one customer configuration can be the default. Setting this\nvalue to `true`, changes the previous default configuration's `isDefault`\nvalue to `false`.",
+ "type": "boolean"
+ },
+ "customMessage": {
+ "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"
+ }
+ },
+ "id": "Configuration"
+ },
+ "UpdateDeviceMetadataRequest": {
+ "description": "Request to set metadata for a device.",
+ "type": "object",
+ "properties": {
+ "deviceMetadata": {
+ "$ref": "DeviceMetadata",
+ "description": "The metdata to set."
+ }
+ },
+ "id": "UpdateDeviceMetadataRequest"
+ },
+ "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"
+ }
+ }
+ },
+ "id": "CustomerListDpcsResponse"
+ },
+ "PartnerUnclaim": {
+ "description": "Identifies one unclaim request.",
+ "type": "object",
+ "properties": {
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "Device identifier of the device."
+ },
+ "sectionType": {
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "Section type to unclaim.",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "Device ID of the device.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "PartnerUnclaim"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "FindDevicesByDeviceIdentifierResponse": {
+ "description": "Response containing found devices.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Page token of the next page.",
+ "type": "string"
+ },
+ "devices": {
+ "description": "Found devices.",
+ "type": "array",
+ "items": {
+ "$ref": "Device"
+ }
+ }
+ },
+ "id": "FindDevicesByDeviceIdentifierResponse"
+ },
+ "PartnerClaim": {
+ "description": "Identifies one claim request.",
+ "type": "object",
+ "properties": {
+ "deviceIdentifier": {
+ "description": "Device identifier of the device.",
+ "$ref": "DeviceIdentifier"
+ },
+ "deviceMetadata": {
+ "$ref": "DeviceMetadata",
+ "description": "Metadata to set at claim."
+ },
+ "sectionType": {
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "Section type to claim.",
+ "type": "string"
+ },
+ "customerId": {
+ "description": "Customer ID to claim for.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "PartnerClaim"
+ },
+ "UnclaimDeviceRequest": {
+ "description": "Request message to unclaim a device.",
+ "type": "object",
+ "properties": {
+ "deviceIdentifier": {
+ "description": "The device identifier you used when you claimed this device.",
+ "$ref": "DeviceIdentifier"
+ },
+ "sectionType": {
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "The section type to unclaim for.",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "The device ID returned by `ClaimDevice`.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "UnclaimDeviceRequest"
+ },
+ "DeviceMetadata": {
+ "description": "Metadata entries that can be attached to a `Device`. To learn more, read\n[Device metadata](/zero-touch/guides/metadata).",
+ "type": "object",
+ "properties": {
+ "entries": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata entries recorded as key-value pairs.",
+ "type": "object"
+ }
+ },
+ "id": "DeviceMetadata"
}
},
- "protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"version": "v1",
"baseUrl": "https://androiddeviceprovisioning.googleapis.com/",
"canonicalName": "Android Provisioning Partner",
@@ -1572,10 +1577,5 @@
"rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
- "name": "androiddeviceprovisioning",
- "batchPath": "batch",
- "revision": "20180125",
- "documentationLink": "https://developers.google.com/zero-touch/",
- "id": "androiddeviceprovisioning:v1",
- "title": "Android Device Provisioning Partner API"
+ "name": "androiddeviceprovisioning"
}
diff --git a/appengine/v1/appengine-api.json b/appengine/v1/appengine-api.json
index 1d723db..74b1e17 100644
--- a/appengine/v1/appengine-api.json
+++ b/appengine/v1/appengine-api.json
@@ -1,25 +1,32 @@
{
- "ownerDomain": "google.com",
- "name": "appengine",
- "batchPath": "batch",
- "revision": "20180118",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "id": "appengine:v1",
- "title": "Google App Engine Admin API",
"ownerName": "Google",
"discoveryVersion": "v1",
"version_module": true,
"resources": {
"apps": {
"methods": {
- "repair": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Operation"
},
- "parameterOrder": [
- "appsId"
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
],
- "httpMethod": "POST",
+ "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": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
@@ -28,688 +35,116 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/apps/{appsId}:repair",
"path": "v1/apps/{appsId}:repair",
"id": "appengine.apps.repair",
+ "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.",
"request": {
"$ref": "RepairApplicationRequest"
},
- "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": "v1/apps/{appsId}",
- "path": "v1/apps/{appsId}",
- "id": "appengine.apps.get",
- "description": "Gets information about an application.",
"response": {
- "$ref": "Application"
+ "$ref": "Operation"
},
"parameterOrder": [
"appsId"
],
+ "httpMethod": "POST"
+ },
+ "get": {
+ "description": "Gets information about an application.",
"httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "Application"
+ },
+ "parameters": {
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp."
+ }
+ },
"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.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
+ "flatPath": "v1/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "path": "v1/apps/{appsId}"
},
"patch": {
- "response": {
- "$ref": "Operation"
+ "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"
],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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 Application resource to update. Example: apps/myapp.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/apps/{appsId}",
- "path": "v1/apps/{appsId}",
- "id": "appengine.apps.patch",
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
- "request": {
- "$ref": "Application"
- }
- },
- "create": {
"response": {
"$ref": "Operation"
},
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp."
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/apps",
- "path": "v1/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/)."
+ "flatPath": "v1/apps/{appsId}",
+ "id": "appengine.apps.patch",
+ "path": "v1/apps/{appsId}"
}
},
"resources": {
- "authorizedDomains": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListAuthorizedDomainsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- },
- "appsId": {
- "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"
- }
- },
- "flatPath": "v1/apps/{appsId}/authorizedDomains",
- "path": "v1/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list",
- "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": {
- "location": "path",
- "description": "Part of `name`. The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/apps/{appsId}/operations",
- "path": "v1/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
- },
- "get": {
- "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"
- },
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "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"
- ],
- "flatPath": "v1/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "path": "v1/apps/{appsId}/operations/{operationsId}"
- }
- }
- },
- "domainMappings": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "domainMappingsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1/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": {
- "response": {
- "$ref": "ListDomainMappingsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/domainMappings",
- "path": "v1/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.list",
- "description": "Lists the domain mappings on an application."
- },
- "get": {
- "response": {
- "$ref": "DomainMapping"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "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": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.get",
- "description": "Gets the specified domain mapping."
- },
- "patch": {
- "path": "v1/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": {
- "domainMappingsId": {
- "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",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}"
- },
- "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": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "overrideStrategy": {
- "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
- "type": "string",
- "location": "query",
- "enum": [
- "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
- "STRICT",
- "OVERRIDE"
- ]
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/domainMappings",
- "path": "v1/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create"
- }
- }
- },
- "firewall": {
- "resources": {
- "ingressRules": {
- "methods": {
- "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": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.delete",
- "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "description": "Deletes the specified firewall rule."
- },
- "list": {
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules",
- "path": "v1/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.list",
- "description": "Lists the firewall rules of an application.",
- "response": {
- "$ref": "ListIngressRulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "matchingAddress": {
- "location": "query",
- "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- }
- },
- "create": {
- "id": "appengine.apps.firewall.ingressRules.create",
- "path": "v1/apps/{appsId}/firewall/ingressRules",
- "request": {
- "$ref": "FirewallRule"
- },
- "description": "Creates a firewall rule for the application.",
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "FirewallRule"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules"
- },
- "get": {
- "description": "Gets the specified firewall rule.",
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
- "required": true,
- "type": "string"
- },
- "ingressRulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.get"
- },
- "patch": {
- "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"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "ingressRulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
- },
- "batchUpdate": {
- "request": {
- "$ref": "BatchUpdateIngressRulesRequest"
- },
- "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list.",
- "response": {
- "$ref": "BatchUpdateIngressRulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "path": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "id": "appengine.apps.firewall.ingressRules.batchUpdate"
- }
- }
- }
- }
- },
- "locations": {
- "methods": {
- "list": {
- "id": "appengine.apps.locations.list",
- "path": "v1/apps/{appsId}/locations",
- "description": "Lists information about the supported locations for this service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameters": {
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "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"
- ],
- "flatPath": "v1/apps/{appsId}/locations"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "response": {
- "$ref": "Location"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "path": "v1/apps/{appsId}/locations/{locationsId}",
- "description": "Get information about a location."
- }
- }
- },
"authorizedCertificates": {
"methods": {
+ "create": {
+ "id": "appengine.apps.authorizedCertificates.create",
+ "path": "v1/apps/{appsId}/authorizedCertificates",
+ "description": "Uploads the specified SSL certificate.",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp."
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates"
+ },
"delete": {
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "description": "Deletes the specified SSL certificate.",
"response": {
"$ref": "Empty"
},
@@ -722,23 +157,19 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"authorizedCertificatesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
"location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string"
}
- },
- "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete",
- "description": "Deletes the specified SSL certificate."
+ }
},
"list": {
"flatPath": "v1/apps/{appsId}/authorizedCertificates",
@@ -752,41 +183,42 @@
"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"
+ "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": {
- "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"
+ "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": "Gets the specified SSL certificate.",
"response": {
"$ref": "AuthorizedCertificate"
},
@@ -801,375 +233,78 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "view": {
- "description": "Controls the set of fields returned in the GET response.",
+ "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"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string"
}
},
"flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
"path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get",
- "description": "Gets the specified SSL certificate."
+ "id": "appengine.apps.authorizedCertificates.get"
},
"patch": {
- "httpMethod": "PATCH",
+ "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.patch",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.",
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
"parameterOrder": [
"appsId",
"authorizedCertificatesId"
],
- "response": {
- "$ref": "AuthorizedCertificate"
- },
+ "httpMethod": "PATCH",
"parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
"required": true,
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
"type": "string",
"location": "path"
- },
- "authorizedCertificatesId": {
- "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. Updates are only supported on the certificate_raw_data and display_name fields.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "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."
- },
- "create": {
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/authorizedCertificates",
- "path": "v1/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.create",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Uploads the specified SSL certificate."
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
}
}
},
"services": {
"resources": {
"versions": {
- "resources": {
- "instances": {
- "methods": {
- "delete": {
- "description": "Stops a running instance.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
- },
- "list": {
- "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).",
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
- "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"
- },
- "versionsId": {
- "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"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances"
- },
- "get": {
- "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.",
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "debug": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "servicesId": {
- "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"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment."
- }
- }
- }
- },
"methods": {
- "create": {
- "request": {
- "$ref": "Version"
- },
- "description": "Deploys code and resource files to a new version.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "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.",
- "required": true,
- "type": "string"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create"
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete",
- "description": "Deletes an existing Version resource."
- },
"list": {
"response": {
"$ref": "ListVersionsResponse"
@@ -1179,23 +314,22 @@
"servicesId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
"required": true,
"type": "string",
"location": "path"
},
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
- },
"pageToken": {
+ "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"description": "Maximum results to return per page.",
@@ -1211,23 +345,20 @@
],
"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"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
"path": "v1/apps/{appsId}/services/{servicesId}/versions",
"id": "appengine.apps.services.versions.list",
"description": "Lists the versions of a service."
},
"get": {
- "id": "appengine.apps.services.versions.get",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
- "httpMethod": "GET",
"response": {
"$ref": "Version"
},
@@ -1236,33 +367,34 @@
"servicesId",
"versionsId"
],
+ "httpMethod": "GET",
"parameters": {
- "versionsId": {
+ "servicesId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1."
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
},
"view": {
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string",
"location": "query",
"enum": [
"BASIC",
"FULL"
- ]
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
- "type": "string",
- "location": "path"
+ ],
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string"
}
},
"scopes": [
@@ -1270,9 +402,14 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "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.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": {
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.patch",
"request": {
"$ref": "Version"
},
@@ -1288,10 +425,10 @@
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
+ "location": "query",
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
@@ -1315,9 +452,276 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "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"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create",
+ "description": "Deploys code and resource files to a new version.",
+ "request": {
+ "$ref": "Version"
+ }
+ },
+ "delete": {
+ "description": "Deletes an existing Version resource.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch"
+ "id": "appengine.apps.services.versions.delete",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
+ }
+ },
+ "resources": {
+ "instances": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "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": {
+ "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 Version resource. Example: apps/myapp/services/default/versions/v1.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "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": {
+ "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.",
+ "response": {
+ "$ref": "Instance"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "versionsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
+ },
+ "debug": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "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/services/default/versions/v1/instances/instance-1.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "versionsId": {
+ "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"
+ }
+ },
+ "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",
+ "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": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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": {
+ "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}",
+ "description": "Stops a running instance."
+ }
+ }
}
}
}
@@ -1332,9 +736,6 @@
"servicesId"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
@@ -1349,15 +750,15 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/apps/{appsId}/services/{servicesId}",
"path": "v1/apps/{appsId}/services/{servicesId}",
"id": "appengine.apps.services.delete",
"description": "Deletes the specified service and all enclosed versions."
},
"list": {
- "flatPath": "v1/apps/{appsId}/services",
- "path": "v1/apps/{appsId}/services",
- "id": "appengine.apps.services.list",
"description": "Lists all the services in the application.",
"response": {
"$ref": "ListServicesResponse"
@@ -1367,68 +768,71 @@
],
"httpMethod": "GET",
"parameters": {
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
"appsId": {
+ "location": "path",
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"pageToken": {
+ "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ ],
+ "flatPath": "v1/apps/{appsId}/services",
+ "path": "v1/apps/{appsId}/services",
+ "id": "appengine.apps.services.list"
},
"get": {
- "response": {
- "$ref": "Service"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"appsId",
"servicesId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Service"
+ },
"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/services/default.",
+ "required": true,
+ "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 requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
}
},
"flatPath": "v1/apps/{appsId}/services/{servicesId}",
- "path": "v1/apps/{appsId}/services/{servicesId}",
"id": "appengine.apps.services.get",
+ "path": "v1/apps/{appsId}/services/{servicesId}",
"description": "Gets the current configuration of the specified service."
},
"patch": {
- "description": "Updates the configuration of the specified service.",
"request": {
"$ref": "Service"
},
+ "description": "Updates the configuration of the specified service.",
"response": {
"$ref": "Operation"
},
@@ -1437,21 +841,18 @@
"servicesId"
],
"httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"updateMask": {
- "location": "query",
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"servicesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"appsId": {
"location": "path",
@@ -1465,35 +866,653 @@
"location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/apps/{appsId}/services/{servicesId}",
"path": "v1/apps/{appsId}/services/{servicesId}",
"id": "appengine.apps.services.patch"
}
}
+ },
+ "authorizedDomains": {
+ "methods": {
+ "list": {
+ "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": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/authorizedDomains",
+ "path": "v1/apps/{appsId}/authorizedDomains",
+ "id": "appengine.apps.authorizedDomains.list",
+ "description": "Lists all domains the user is authorized to administer."
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "required": true,
+ "type": "string"
+ },
+ "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",
+ "id": "appengine.apps.operations.list",
+ "path": "v1/apps/{appsId}/operations"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
+ "path": "v1/apps/{appsId}/operations/{operationsId}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
+ }
+ }
+ },
+ "domainMappings": {
+ "methods": {
+ "create": {
+ "path": "v1/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.create",
+ "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": {
+ "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
+ "STRICT",
+ "OVERRIDE"
+ ]
+ },
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/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.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.delete",
+ "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}"
+ },
+ "list": {
+ "description": "Lists the domain mappings on an application.",
+ "response": {
+ "$ref": "ListDomainMappingsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "appsId": {
+ "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"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/domainMappings",
+ "path": "v1/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.list"
+ },
+ "get": {
+ "response": {
+ "$ref": "DomainMapping"
+ },
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "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"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.get",
+ "description": "Gets the specified domain mapping."
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "domainMappingsId": {
+ "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",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1/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."
+ }
+ }
+ },
+ "firewall": {
+ "resources": {
+ "ingressRules": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListIngressRulesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results."
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "matchingAddress": {
+ "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules",
+ "path": "v1/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": {
+ "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",
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "description": "Creates a firewall rule for the application."
+ },
+ "get": {
+ "description": "Gets the specified firewall rule.",
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "ingressRulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.get"
+ },
+ "patch": {
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask"
+ },
+ "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"
+ }
+ },
+ "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"
+ }
+ },
+ "batchUpdate": {
+ "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.",
+ "response": {
+ "$ref": "BatchUpdateIngressRulesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the specified firewall rule.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100."
+ },
+ "ingressRulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.delete",
+ "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
+ }
+ }
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list",
+ "path": "v1/apps/{appsId}/locations"
+ },
+ "get": {
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "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"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/locations/{locationsId}",
+ "path": "v1/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get",
+ "description": "Get information about a location."
+ }
+ }
}
}
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ },
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
"location": "query"
},
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "fields": {
+ "callback": {
"location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
+ "description": "JSONP",
"type": "string"
},
"$.xgafv": {
@@ -1509,720 +1528,55 @@
"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": {
+ "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": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "description": "Data format for response."
},
"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",
+ "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": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
}
},
"schemas": {
- "FileInfo": {
+ "UrlMap": {
"properties": {
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
- "type": "string"
- },
- "sourceUrl": {
- "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- },
- "sha1Sum": {
- "description": "The SHA1 hash of the file, in hex.",
- "type": "string"
- }
- },
- "id": "FileInfo",
- "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"
- },
- "ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ScriptHandler"
- },
- "AuthorizedDomain": {
- "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
- "type": "object",
- "properties": {
- "name": {
- "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
- "type": "string"
- }
- },
- "id": "AuthorizedDomain"
- },
- "TrafficSplit": {
- "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
- "type": "object",
- "properties": {
- "shardBy": {
- "enumDescriptions": [
- "Diversion method unspecified.",
- "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
- "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
- "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share."
- ],
- "enum": [
- "UNSPECIFIED",
- "COOKIE",
- "IP",
- "RANDOM"
- ],
- "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
- "type": "string"
- },
- "allocations": {
- "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
- "type": "object",
- "additionalProperties": {
- "format": "double",
- "type": "number"
- }
- }
- },
- "id": "TrafficSplit"
- },
- "OperationMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Beta"
- }
- },
- "id": "OperationMetadataV1Beta"
- },
- "ListIngressRulesResponse": {
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "ingressRules": {
- "description": "The ingress FirewallRules for this application.",
- "type": "array",
- "items": {
- "$ref": "FirewallRule"
- }
- }
- },
- "id": "ListIngressRulesResponse",
- "description": "Response message for Firewall.ListIngressRules.",
- "type": "object"
- },
- "ListServicesResponse": {
- "description": "Response message for Services.ListServices.",
- "type": "object",
- "properties": {
- "services": {
- "description": "The services belonging to the requested application.",
- "type": "array",
- "items": {
- "$ref": "Service"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListServicesResponse"
- },
- "Deployment": {
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object",
- "properties": {
- "files": {
- "additionalProperties": {
- "$ref": "FileInfo"
- },
- "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
- "type": "object"
- },
- "zip": {
- "description": "The zip file for this deployment, if this is a zip deployment.",
- "$ref": "ZipInfo"
- },
- "container": {
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
- "$ref": "ContainerInfo"
- }
- },
- "id": "Deployment"
- },
- "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"
- },
- "BatchUpdateIngressRulesResponse": {
- "properties": {
- "ingressRules": {
- "description": "The full list of ingress FirewallRules for this application.",
- "type": "array",
- "items": {
- "$ref": "FirewallRule"
- }
- }
- },
- "id": "BatchUpdateIngressRulesResponse",
- "description": "Response message for Firewall.UpdateAllIngressRules.",
- "type": "object"
- },
- "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 in the App Engine flexible environment.",
- "type": "object"
- },
- "ListInstancesResponse": {
- "properties": {
- "instances": {
- "description": "The instances belonging to the requested version.",
- "type": "array",
- "items": {
- "$ref": "Instance"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListInstancesResponse",
- "description": "Response message for Instances.ListInstances.",
- "type": "object"
- },
- "ListDomainMappingsResponse": {
- "description": "Response message for DomainMappings.ListDomainMappings.",
- "type": "object",
- "properties": {
- "domainMappings": {
- "description": "The domain mappings for the application.",
- "type": "array",
- "items": {
- "$ref": "DomainMapping"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListDomainMappingsResponse"
- },
- "OperationMetadataV1Alpha": {
- "properties": {
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Alpha"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Alpha",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object",
- "properties": {
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- },
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "service": {
- "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule"
- },
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "versions": {
- "description": "The versions belonging to the requested service.",
- "type": "array",
- "items": {
- "$ref": "Version"
- }
- }
- },
- "id": "ListVersionsResponse"
- },
- "ListAuthorizedDomainsResponse": {
- "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "domains": {
- "description": "The authorized domains belonging to the user.",
- "type": "array",
- "items": {
- "$ref": "AuthorizedDomain"
- }
- }
- },
- "id": "ListAuthorizedDomainsResponse"
- },
- "DomainMapping": {
- "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",
- "description": "A domain serving an App Engine application.",
- "type": "object"
- },
- "ApiEndpointHandler": {
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler",
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "AutomaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object",
- "properties": {
- "requestUtilization": {
- "$ref": "RequestUtilization",
- "description": "Target scaling by request utilization."
- },
- "maxIdleInstances": {
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "standardSchedulerSettings": {
- "$ref": "StandardSchedulerSettings",
- "description": "Scheduler settings for standard environment."
- },
- "minIdleInstances": {
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
- "format": "int32",
- "type": "integer"
- },
- "maxTotalInstances": {
- "description": "Maximum number of instances that should be started to handle requests.",
- "format": "int32",
- "type": "integer"
- },
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "networkUtilization": {
- "description": "Target scaling by network usage.",
- "$ref": "NetworkUtilization"
- },
- "maxConcurrentRequests": {
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "format": "int32",
- "type": "integer"
- },
- "coolDownPeriod": {
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable in the App Engine flexible environment.",
- "format": "google-duration",
- "type": "string"
- },
- "maxPendingLatency": {
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
- },
- "diskUtilization": {
- "$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"
- },
- "ZipInfo": {
- "description": "The zip file information for a zip deployment.",
- "type": "object",
- "properties": {
- "filesCount": {
- "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
- "format": "int32",
- "type": "integer"
- },
- "sourceUrl": {
- "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- }
- },
- "id": "ZipInfo"
- },
- "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": {
- "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"
- }
- },
- "id": "AuthorizedCertificate"
- },
- "ResourceRecord": {
- "description": "A DNS resource record.",
- "type": "object",
- "properties": {
- "type": {
- "description": "Resource record type. Example: AAAA.",
+ "redirectHttpResponseCode": {
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
"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."
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
],
"enum": [
- "RECORD_TYPE_UNSPECIFIED",
- "A",
- "AAAA",
- "CNAME"
+ "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"
]
},
- "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": {
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- },
- "name": {
- "description": "Name of the library. Example: \"django\".",
- "type": "string"
- }
- },
- "id": "Library"
- },
- "ListLocationsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- }
- },
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
- },
- "ContainerInfo": {
- "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "image": {
- "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
- "type": "string"
- }
- },
- "id": "ContainerInfo"
- },
- "RequestUtilization": {
- "properties": {
- "targetConcurrentRequests": {
- "description": "Target number of concurrent requests.",
- "format": "int32",
- "type": "integer"
- },
- "targetRequestCountPerSecond": {
- "description": "Target requests per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "RequestUtilization",
- "description": "Target scaling by request utilization. Only applicable in the App Engine flexible environment.",
- "type": "object"
- },
- "EndpointsApiService": {
- "properties": {
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- },
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
- "type": "string"
- }
- },
- "id": "EndpointsApiService",
- "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
- "type": "object"
- },
- "UrlMap": {
- "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
- "type": "object",
- "properties": {
"securityLevel": {
- "description": "Security (HTTPS) enforcement for this URL.",
"type": "string",
"enumDescriptions": [
"Not specified.",
@@ -2237,7 +1591,8 @@
"SECURE_NEVER",
"SECURE_OPTIONAL",
"SECURE_ALWAYS"
- ]
+ ],
+ "description": "Security (HTTPS) enforcement for this URL."
},
"authFailAction": {
"enumDescriptions": [
@@ -2262,6 +1617,89 @@
"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"
+ },
+ "staticFiles": {
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
+ }
+ },
+ "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": {
+ "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",
+ "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)."
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object",
+ "properties": {
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ }
+ },
+ "id": "Operation"
+ },
+ "ApiConfigHandler": {
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "type": "object",
+ "properties": {
+ "login": {
"enumDescriptions": [
"Not specified. LOGIN_OPTIONAL is assumed.",
"Does not require that the user is signed in.",
@@ -2274,43 +1712,12 @@
"LOGIN_ADMIN",
"LOGIN_REQUIRED"
],
- "description": "Level of login required to access this resource.",
+ "description": "Level of login required to access this resource. Defaults to optional.",
"type": "string"
},
- "apiEndpoint": {
- "$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"
- },
- "redirectHttpResponseCode": {
- "enumDescriptions": [
- "Not specified. 302 is assumed.",
- "301 Moved Permanently code.",
- "302 Moved Temporarily code.",
- "303 See Other code.",
- "307 Temporary Redirect code."
- ],
- "enum": [
- "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
- "REDIRECT_HTTP_RESPONSE_CODE_301",
- "REDIRECT_HTTP_RESPONSE_CODE_302",
- "REDIRECT_HTTP_RESPONSE_CODE_303",
- "REDIRECT_HTTP_RESPONSE_CODE_307"
- ],
- "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
- "type": "string"
- }
- },
- "id": "UrlMap"
- },
- "ApiConfigHandler": {
- "properties": {
"url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
+ "type": "string",
+ "description": "URL to serve the endpoint at."
},
"securityLevel": {
"enumDescriptions": [
@@ -2331,6 +1738,7 @@
"type": "string"
},
"authFailAction": {
+ "type": "string",
"enumDescriptions": [
"Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
"Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
@@ -2341,68 +1749,14 @@
"AUTH_FAIL_ACTION_REDIRECT",
"AUTH_FAIL_ACTION_UNAUTHORIZED"
],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect."
},
"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"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
- }
- },
- "id": "Operation"
+ "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.",
@@ -2418,19 +1772,19 @@
"type": "boolean"
},
"httpHeaders": {
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
+ }
},
"uploadPathRegex": {
"description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
"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"
+ "type": "string",
+ "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."
},
"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.",
@@ -2443,8 +1797,24 @@
},
"id": "StaticFilesHandler"
},
+ "BasicScaling": {
+ "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",
+ "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."
+ },
"DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.",
"type": "object",
"properties": {
"targetReadBytesPerSecond": {
@@ -2468,26 +1838,11 @@
"type": "integer"
}
},
- "id": "DiskUtilization"
- },
- "BasicScaling": {
- "properties": {
- "maxInstances": {
- "description": "Maximum number of instances to create for this version.",
- "format": "int32",
- "type": "integer"
- },
- "idleTimeout": {
- "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "BasicScaling",
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "type": "object"
+ "id": "DiskUtilization",
+ "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment."
},
"CpuUtilization": {
+ "id": "CpuUtilization",
"description": "Target scaling by CPU usage.",
"type": "object",
"properties": {
@@ -2501,10 +1856,10 @@
"format": "double",
"type": "number"
}
- },
- "id": "CpuUtilization"
+ }
},
"Status": {
+ "id": "Status",
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
@@ -2512,33 +1867,28 @@
"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": {
+ "type": "integer",
"description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
+ "type": "string",
+ "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."
}
- },
- "id": "Status"
+ }
},
"IdentityAwareProxy": {
"description": "Identity-Aware Proxy",
"type": "object",
"properties": {
- "enabled": {
- "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.",
- "type": "boolean"
- },
"oauth2ClientSecret": {
"description": "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"
@@ -2550,6 +1900,10 @@
"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"
@@ -2575,8 +1929,8 @@
"type": "boolean"
},
"flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
+ "type": "boolean",
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly"
}
},
"id": "LocationMetadata"
@@ -2585,10 +1939,6 @@
"description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
"type": "object",
"properties": {
- "id": {
- "description": "Relative name of the service within the application. Example: default.@OutputOnly",
- "type": "string"
- },
"name": {
"description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
@@ -2596,13 +1946,15 @@
"split": {
"$ref": "TrafficSplit",
"description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
+ },
+ "id": {
+ "type": "string",
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly"
}
},
"id": "Service"
},
"ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -2616,12 +1968,18 @@
}
}
},
- "id": "ListOperationsResponse"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "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",
@@ -2636,17 +1994,13 @@
"format": "google-datetime",
"type": "string"
},
+ "target": {
+ "type": "string",
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly"
+ },
"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"
@@ -2655,18 +2009,14 @@
"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": {
+ "type": "integer",
"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"
+ "format": "int32"
},
"action": {
"enum": [
@@ -2681,27 +2031,31 @@
"Matching requests are allowed.",
"Matching requests are denied."
]
+ },
+ "description": {
+ "description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
+ "type": "string"
}
},
"id": "FirewallRule"
},
"ListAuthorizedCertificatesResponse": {
- "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "Continuation token for fetching the next page of results.",
"type": "string"
},
"certificates": {
- "description": "The SSL certificates the user is authorized to administer.",
"type": "array",
"items": {
"$ref": "AuthorizedCertificate"
- }
+ },
+ "description": "The SSL certificates the user is authorized to administer."
}
},
- "id": "ListAuthorizedCertificatesResponse"
+ "id": "ListAuthorizedCertificatesResponse",
+ "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
+ "type": "object"
},
"CreateVersionMetadataV1Beta": {
"description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
@@ -2725,57 +2079,6 @@
},
"id": "FeatureSettings"
},
- "OperationMetadataV1": {
- "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",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "SslSettings": {
- "description": "SSL configuration for a DomainMapping resource.",
- "type": "object",
- "properties": {
- "certificateId": {
- "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.",
- "type": "string"
- }
- },
- "id": "SslSettings"
- },
"ErrorHandler": {
"description": "Custom static error page to be served when an error occurs.",
"type": "object",
@@ -2809,40 +2112,87 @@
},
"id": "ErrorHandler"
},
- "Network": {
+ "SslSettings": {
+ "description": "SSL configuration for a DomainMapping resource.",
+ "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.",
+ "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": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.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"
}
},
- "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.",
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
}
},
- "id": "Network",
- "description": "Extra network settings. Only applicable in the App Engine flexible environment.",
- "type": "object"
+ "id": "OperationMetadataV1"
},
"Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
"properties": {
- "locationId": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ }
+ },
+ "gcrDomain": {
+ "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
"type": "string"
},
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "type": "string",
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration"
+ },
+ "locationId": {
+ "type": "string",
+ "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"
+ },
"servingStatus": {
"enum": [
"UNSPECIFIED",
@@ -2864,16 +2214,16 @@
"type": "string"
},
"featureSettings": {
- "$ref": "FeatureSettings",
- "description": "The feature specific settings to be used in the application."
+ "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"
},
- "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"
@@ -2881,40 +2231,57 @@
"defaultBucket": {
"description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
"type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
+ }
+ },
+ "id": "Application",
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "type": "object"
+ },
+ "Network": {
+ "id": "Network",
+ "description": "Extra network settings. Only applicable in the App Engine flexible environment.",
+ "type": "object",
+ "properties": {
+ "forwardedPorts": {
"type": "array",
"items": {
- "$ref": "UrlDispatchRule"
- }
+ "type": "string"
+ },
+ "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."
},
- "gcrDomain": {
- "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
+ "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": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
- "format": "google-duration",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "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": "Application"
+ }
},
"Instance": {
"properties": {
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "vmDebugEnabled": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "requests": {
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
"type": "string"
},
+ "vmName": {
+ "type": "string",
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly"
+ },
"qps": {
"description": "Average queries per second (QPS) over the last minute.@OutputOnly",
"format": "float",
@@ -2937,59 +2304,46 @@
"format": "int32",
"type": "integer"
},
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
- "type": "string"
+ "vmIp": {
+ "type": "string",
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly"
},
"memoryUsage": {
"description": "Total memory in use (bytes).@OutputOnly",
"format": "int64",
"type": "string"
},
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
"type": "string"
},
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "availability": {
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
"errors": {
"description": "Number of errors since this instance was started.@OutputOnly",
"format": "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"
+ },
"startTime": {
"description": "Time that this instance was started.@OutputOnly",
"format": "google-datetime",
"type": "string"
- },
- "vmDebugEnabled": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
}
},
"id": "Instance",
@@ -2997,19 +2351,7 @@
"type": "object"
},
"LivenessCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
- "type": "object",
"properties": {
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "failureThreshold": {
- "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
- "format": "uint32",
- "type": "integer"
- },
"initialDelay": {
"description": "The initial delay before starting to execute the checks.",
"format": "google-duration",
@@ -3020,9 +2362,9 @@
"type": "string"
},
"successThreshold": {
+ "type": "integer",
"description": "Number of consecutive successful checks required before considering the VM healthy.",
- "format": "uint32",
- "type": "integer"
+ "format": "uint32"
},
"host": {
"description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
@@ -3032,9 +2374,21 @@
"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": {
+ "type": "integer",
+ "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
+ "format": "uint32"
}
},
- "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.",
@@ -3050,16 +2404,43 @@
},
"id": "BatchUpdateIngressRulesRequest"
},
+ "NetworkUtilization": {
+ "type": "object",
+ "properties": {
+ "targetSentPacketsPerSecond": {
+ "description": "Target packets sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedBytesPerSecond": {
+ "description": "Target bytes received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSecond": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentBytesPerSecond": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "NetworkUtilization",
+ "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment."
+ },
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
"labels": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object"
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n"
},
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
@@ -3070,47 +2451,30 @@
"type": "string"
},
"metadata": {
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object"
}
},
"id": "Location"
},
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "targetReceivedPacketsPerSecond": {
- "description": "Target packets received per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentBytesPerSecond": {
- "description": "Target bytes sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentPacketsPerSecond": {
- "description": "Target packets sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedBytesPerSecond": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "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",
@@ -3133,34 +2497,25 @@
"description": "Number of consecutive failed health checks required before an instance is restarted.",
"format": "uint32",
"type": "integer"
- },
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- },
- "timeout": {
- "description": "Time before the health check is considered failed.",
- "format": "google-duration",
- "type": "string"
}
},
"id": "HealthCheck"
},
"ReadinessCheck": {
+ "id": "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",
- "type": "integer"
- },
"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",
@@ -3170,22 +2525,21 @@
"description": "The request path.",
"type": "string"
},
- "host": {
- "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
"successThreshold": {
"description": "Number of consecutive successful checks required before receiving traffic.",
"format": "uint32",
"type": "integer"
},
+ "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"
}
- },
- "id": "ReadinessCheck"
+ }
},
"DebugInstanceRequest": {
"description": "Request message for Instances.DebugInstance.",
@@ -3199,49 +2553,40 @@
"id": "DebugInstanceRequest"
},
"StandardSchedulerSettings": {
- "description": "Scheduler settings for standard environment.",
"type": "object",
"properties": {
- "targetCpuUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling.",
- "format": "double",
- "type": "number"
- },
"targetThroughputUtilization": {
+ "type": "number",
"description": "Target throughput utilization ratio to maintain when scaling",
- "format": "double",
- "type": "number"
+ "format": "double"
},
"maxInstances": {
+ "type": "integer",
"description": "Maximum number of instances for an app version. Set to zero to disable max_instances configuration.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"minInstances": {
"description": "Minimum number of instances for an app version. Set to zero to disable min_instances configuration.",
"format": "int32",
"type": "integer"
+ },
+ "targetCpuUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling.",
+ "format": "double",
+ "type": "number"
}
},
- "id": "StandardSchedulerSettings"
+ "id": "StandardSchedulerSettings",
+ "description": "Scheduler settings for standard environment."
},
"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": {
+ "type": "string",
"description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"user": {
"description": "User who requested this operation.@OutputOnly",
@@ -3250,25 +2595,168 @@
"target": {
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
+ },
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
}
},
"id": "OperationMetadataV1Beta5"
},
"CreateVersionMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
- "type": "object",
"properties": {
"cloudBuildId": {
"description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
"type": "string"
}
},
- "id": "CreateVersionMetadataV1Alpha"
+ "id": "CreateVersionMetadataV1Alpha",
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
+ "type": "object"
},
"Version": {
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
"type": "object",
"properties": {
+ "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."
+ },
+ "versionUrl": {
+ "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
+ "type": "string"
+ },
+ "vm": {
+ "description": "Whether to deploy this version in a container on a virtual machine.",
+ "type": "boolean"
+ },
+ "instanceClass": {
+ "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
+ "type": "string"
+ },
+ "servingStatus": {
+ "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Currently serving. Instances are created according to the scaling settings of the version.",
+ "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
+ ],
+ "enum": [
+ "SERVING_STATUS_UNSPECIFIED",
+ "SERVING",
+ "STOPPED"
+ ]
+ },
+ "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": {
+ "$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",
+ "items": {
+ "$ref": "ErrorHandler"
+ }
+ },
+ "defaultExpiration": {
+ "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "libraries": {
+ "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.",
+ "type": "array",
+ "items": {
+ "$ref": "Library"
+ }
+ },
+ "nobuildFilesRegex": {
+ "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
+ "type": "string"
+ },
+ "basicScaling": {
+ "$ref": "BasicScaling",
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
+ },
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
+ "type": "string"
+ },
+ "createdBy": {
+ "description": "Email address of the user who created this version.@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
+ "type": "string"
+ },
+ "envVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
+ },
+ "livenessCheck": {
+ "$ref": "LivenessCheck",
+ "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
+ },
+ "network": {
+ "$ref": "Network",
+ "description": "Extra network settings. Only applicable in the App Engine flexible environment."
+ },
"betaSettings": {
"additionalProperties": {
"type": "string"
@@ -3295,8 +2783,8 @@
}
},
"automaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "$ref": "AutomaticScaling"
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
},
"diskUsageBytes": {
"description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly",
@@ -3304,8 +2792,8 @@
"type": "string"
},
"healthCheck": {
- "$ref": "HealthCheck",
- "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set."
+ "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set.",
+ "$ref": "HealthCheck"
},
"threadsafe": {
"description": "Whether multiple requests can be dispatched to this version at once.",
@@ -3322,153 +2810,17 @@
"name": {
"description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
"type": "string"
- },
- "apiConfig": {
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
- "$ref": "ApiConfigHandler"
- },
- "endpointsApiService": {
- "$ref": "EndpointsApiService",
- "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app."
- },
- "vm": {
- "description": "Whether to deploy this version in a container on a virtual machine.",
- "type": "boolean"
- },
- "versionUrl": {
- "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
- "type": "string"
- },
- "instanceClass": {
- "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
- "type": "string"
- },
- "servingStatus": {
- "enum": [
- "SERVING_STATUS_UNSPECIFIED",
- "SERVING",
- "STOPPED"
- ],
- "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Currently serving. Instances are created according to the scaling settings of the version.",
- "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
- ]
- },
- "runtimeApiVersion": {
- "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref",
- "type": "string"
- },
- "deployment": {
- "$ref": "Deployment",
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
- },
- "createTime": {
- "description": "Time that this version was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
- },
- "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"
- }
- },
- "errorHandlers": {
- "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "ErrorHandler"
- }
- },
- "defaultExpiration": {
- "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
- "format": "google-duration",
- "type": "string"
- },
- "libraries": {
- "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "Library"
- }
- },
- "nobuildFilesRegex": {
- "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
- "type": "string"
- },
- "basicScaling": {
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "$ref": "BasicScaling"
- },
- "runtime": {
- "description": "Desired runtime. Example: python27.",
- "type": "string"
- },
- "createdBy": {
- "description": "Email address of the user who created this version.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
- "type": "string"
- },
- "envVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object"
- },
- "livenessCheck": {
- "$ref": "LivenessCheck",
- "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
- },
- "network": {
- "description": "Extra network settings. Only applicable in the App Engine flexible environment.",
- "$ref": "Network"
}
},
"id": "Version"
},
"RepairApplicationRequest": {
- "description": "Request message for 'Applications.RepairApplication'.",
- "type": "object",
"properties": {},
- "id": "RepairApplicationRequest"
+ "id": "RepairApplicationRequest",
+ "description": "Request message for 'Applications.RepairApplication'.",
+ "type": "object"
},
"CertificateRawData": {
- "description": "An SSL certificate obtained from a certificate authority.",
- "type": "object",
"properties": {
"publicCertificate": {
"description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
@@ -3479,12 +2831,653 @@
"type": "string"
}
},
- "id": "CertificateRawData"
+ "id": "CertificateRawData",
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "type": "object"
+ },
+ "FileInfo": {
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "type": "object",
+ "properties": {
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "type": "string"
+ },
+ "sourceUrl": {
+ "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ }
+ },
+ "id": "FileInfo"
+ },
+ "ScriptHandler": {
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "type": "object",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ScriptHandler"
+ },
+ "AuthorizedDomain": {
+ "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly"
+ }
+ },
+ "id": "AuthorizedDomain"
+ },
+ "TrafficSplit": {
+ "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
+ "type": "object",
+ "properties": {
+ "shardBy": {
+ "enum": [
+ "UNSPECIFIED",
+ "COOKIE",
+ "IP",
+ "RANDOM"
+ ],
+ "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
+ "type": "string",
+ "enumDescriptions": [
+ "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."
+ ]
+ },
+ "allocations": {
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object"
+ }
+ },
+ "id": "TrafficSplit"
+ },
+ "OperationMetadataV1Beta": {
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Beta"
+ },
+ "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": {
+ "type": "string",
+ "description": "User who requested this operation.@OutputOnly"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "type": "string",
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta",
+ "description": "Metadata for the given google.longrunning.Operation."
+ },
+ "ListServicesResponse": {
+ "description": "Response message for Services.ListServices.",
+ "type": "object",
+ "properties": {
+ "services": {
+ "type": "array",
+ "items": {
+ "$ref": "Service"
+ },
+ "description": "The services belonging to the requested application."
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListServicesResponse"
+ },
+ "ListIngressRulesResponse": {
+ "description": "Response message for Firewall.ListIngressRules.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "ingressRules": {
+ "description": "The ingress FirewallRules for this application.",
+ "type": "array",
+ "items": {
+ "$ref": "FirewallRule"
+ }
+ }
+ },
+ "id": "ListIngressRulesResponse"
+ },
+ "Resources": {
+ "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",
+ "description": "Machine resources for a version."
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "Deployment"
+ },
+ "BatchUpdateIngressRulesResponse": {
+ "description": "Response message for Firewall.UpdateAllIngressRules.",
+ "type": "object",
+ "properties": {
+ "ingressRules": {
+ "description": "The full list of ingress FirewallRules for this application.",
+ "type": "array",
+ "items": {
+ "$ref": "FirewallRule"
+ }
+ }
+ },
+ "id": "BatchUpdateIngressRulesResponse"
+ },
+ "Volume": {
+ "description": "Volumes mounted within the app container. Only applicable in the App Engine flexible environment.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "ListInstancesResponse": {
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "type": "array",
+ "items": {
+ "$ref": "Instance"
+ }
+ }
+ },
+ "id": "ListInstancesResponse"
+ },
+ "ListDomainMappingsResponse": {
+ "description": "Response message for DomainMappings.ListDomainMappings.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "domainMappings": {
+ "description": "The domain mappings for the application.",
+ "type": "array",
+ "items": {
+ "$ref": "DomainMapping"
+ }
+ }
+ },
+ "id": "ListDomainMappingsResponse"
+ },
+ "OperationMetadataV1Alpha": {
+ "type": "object",
+ "properties": {
+ "method": {
+ "type": "string",
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Alpha"
+ },
+ "warning": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Durable messages that persist on every operation poll. @OutputOnly"
+ },
+ "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."
+ },
+ "UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
+ },
+ "service": {
+ "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "type": "string"
+ }
+ },
+ "id": "UrlDispatchRule"
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "type": "object",
+ "properties": {
+ "versions": {
+ "description": "The versions belonging to the requested service.",
+ "type": "array",
+ "items": {
+ "$ref": "Version"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "Continuation token for fetching the next page of results."
+ }
+ },
+ "id": "ListVersionsResponse"
+ },
+ "ListAuthorizedDomainsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "domains": {
+ "type": "array",
+ "items": {
+ "$ref": "AuthorizedDomain"
+ },
+ "description": "The authorized domains belonging to the user."
+ }
+ },
+ "id": "ListAuthorizedDomainsResponse",
+ "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "ApiEndpointHandler": {
+ "id": "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"
+ }
+ }
+ },
+ "DomainMapping": {
+ "description": "A domain serving an App Engine application.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Relative name of the domain serving the application. Example: example.com.",
+ "type": "string"
+ },
+ "resourceRecords": {
+ "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "ResourceRecord"
+ }
+ },
+ "name": {
+ "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "sslSettings": {
+ "$ref": "SslSettings",
+ "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
+ }
+ },
+ "id": "DomainMapping"
+ },
+ "ZipInfo": {
+ "description": "The zip file information for a zip deployment.",
+ "type": "object",
+ "properties": {
+ "filesCount": {
+ "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceUrl": {
+ "type": "string",
+ "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'."
+ }
+ },
+ "id": "ZipInfo"
+ },
+ "AutomaticScaling": {
+ "properties": {
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
+ },
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ },
+ "maxIdleInstances": {
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "standardSchedulerSettings": {
+ "$ref": "StandardSchedulerSettings",
+ "description": "Scheduler settings for standard environment."
+ },
+ "minIdleInstances": {
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxTotalInstances": {
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "maxConcurrentRequests": {
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "coolDownPeriod": {
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable in the App Engine flexible environment.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxPendingLatency": {
+ "type": "string",
+ "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"
+ },
+ "cpuUtilization": {
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
+ }
+ },
+ "id": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "type": "object"
+ },
+ "AuthorizedCertificate": {
+ "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
+ "type": "string"
+ },
+ "certificateRawData": {
+ "$ref": "CertificateRawData",
+ "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
+ },
+ "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": {
+ "type": "string",
+ "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'."
+ },
+ "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": {
+ "type": "object",
+ "properties": {
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ }
+ },
+ "id": "Library",
+ "description": "Third-party Python runtime library that is required by the application."
+ },
+ "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"
+ },
+ "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"
+ },
+ "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"
}
},
"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",
@@ -3492,14 +3485,14 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/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"
}
}
}
@@ -3508,5 +3501,12 @@
"description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"servicePath": "",
"rootUrl": "https://appengine.googleapis.com/",
- "basePath": ""
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "appengine",
+ "batchPath": "batch",
+ "id": "appengine:v1",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "revision": "20180118",
+ "title": "Google App Engine Admin API"
}
diff --git a/appengine/v1alpha/appengine-api.json b/appengine/v1alpha/appengine-api.json
index a341766..4595766 100644
--- a/appengine/v1alpha/appengine-api.json
+++ b/appengine/v1alpha/appengine-api.json
@@ -1,246 +1,158 @@
{
- "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:v1alpha",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20180118",
"title": "Google App Engine Admin API",
"ownerName": "Google",
"discoveryVersion": "v1",
"resources": {
"apps": {
"resources": {
- "authorizedDomains": {
+ "authorizedCertificates": {
"methods": {
- "list": {
- "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": "v1alpha/apps/{appsId}/authorizedDomains",
- "path": "v1alpha/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list",
- "description": "Lists all domains the user is authorized to administer.",
- "response": {
- "$ref": "ListAuthorizedDomainsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET"
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "id": "appengine.apps.operations.list",
- "path": "v1alpha/apps/{appsId}/operations",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "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}/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.",
- "response": {
- "$ref": "Operation"
- },
+ "delete": {
+ "description": "Deletes the specified SSL certificate.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"appsId",
- "operationsId"
+ "authorizedCertificatesId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
- "appsId": {
- "description": "Part of `name`. The name of the operation resource.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "operationsId": {
+ "authorizedCertificatesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string"
}
},
- "flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}"
- }
- }
- },
- "locations": {
- "methods": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ },
"list": {
- "path": "v1alpha/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "description": "Lists information about the supported locations for this service.",
"response": {
- "$ref": "ListLocationsResponse"
+ "$ref": "ListAuthorizedCertificatesResponse"
},
"parameterOrder": [
"appsId"
],
"httpMethod": "GET",
"parameters": {
- "appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
"pageSize": {
"location": "query",
- "description": "The standard list page size.",
+ "description": "Maximum results to return per page.",
"format": "int32",
"type": "integer"
},
- "filter": {
+ "view": {
"location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/locations"
- },
- "get": {
- "path": "v1alpha/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Resource name for the location.",
- "required": true,
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "description": "Controls the set of fields returned in the LIST response.",
"type": "string"
},
- "locationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}"
- }
- }
- },
- "domainMappings": {
- "methods": {
- "delete": {
- "parameters": {
"appsId": {
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"required": true,
"type": "string",
"location": "path"
},
- "domainMappingsId": {
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.list",
+ "description": "Lists all SSL certificates the user is authorized to administer."
+ },
+ "get": {
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.get",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "description": "Gets the specified SSL certificate.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameters": {
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "description": "Controls the set of fields returned in the GET response.",
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameters": {
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "authorizedCertificatesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
@@ -250,6 +162,241 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.patch",
+ "path": "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"
+ },
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "authorizedDomains": {
+ "methods": {
+ "list": {
+ "description": "Lists all domains the user is authorized to administer.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListAuthorizedDomainsResponse"
+ },
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/authorizedDomains",
+ "id": "appengine.apps.authorizedDomains.list",
+ "path": "v1alpha/apps/{appsId}/authorizedDomains"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "list": {
+ "flatPath": "v1alpha/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list",
+ "path": "v1alpha/apps/{appsId}/operations",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
+ "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": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "get": {
+ "flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
+ "path": "v1alpha/apps/{appsId}/operations/{operationsId}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "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"
+ }
+ },
+ "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",
+ "id": "appengine.apps.locations.list",
+ "path": "v1alpha/apps/{appsId}/locations"
+ },
+ "get": {
+ "description": "Get information about a location.",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}",
+ "path": "v1alpha/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get"
+ }
+ }
+ },
+ "domainMappings": {
+ "methods": {
+ "delete": {
"flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
"path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
"id": "appengine.apps.domainMappings.delete",
@@ -261,9 +408,27 @@
"appsId",
"domainMappingsId"
],
- "httpMethod": "DELETE"
+ "httpMethod": "DELETE",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "domainMappingsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"list": {
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings",
"id": "appengine.apps.domainMappings.list",
"path": "v1alpha/apps/{appsId}/domainMappings",
"description": "Lists the domain mappings on an application.",
@@ -282,195 +447,6 @@
"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": "v1alpha/apps/{appsId}/domainMappings"
- },
- "get": {
- "response": {
- "$ref": "DomainMapping"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.get",
- "description": "Gets the specified domain mapping."
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "noManagedCertificate": {
- "location": "query",
- "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask.",
- "type": "boolean"
- },
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "domainMappingsId": {
- "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}/domainMappings/{domainMappingsId}",
- "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.patch",
- "request": {
- "$ref": "DomainMapping"
- },
- "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource."
- },
- "create": {
- "parameters": {
- "noManagedCertificate": {
- "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated.",
- "type": "boolean",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "overrideStrategy": {
- "location": "query",
- "enum": [
- "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
- "STRICT",
- "OVERRIDE"
- ],
- "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha/apps/{appsId}/domainMappings",
- "path": "v1alpha/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create",
- "request": {
- "$ref": "DomainMapping"
- },
- "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST"
- }
- }
- },
- "authorizedCertificates": {
- "methods": {
- "delete": {
- "description": "Deletes the specified SSL certificate.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListAuthorizedCertificatesResponse"
- },
- "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"
@@ -480,135 +456,133 @@
"description": "Maximum results to return per page.",
"format": "int32",
"type": "integer"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "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": "v1alpha/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.list",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates",
- "description": "Lists all SSL certificates the user is authorized to administer."
+ ]
},
"get": {
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get",
- "description": "Gets the specified SSL certificate.",
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.get",
+ "description": "Gets the specified domain mapping.",
"response": {
- "$ref": "AuthorizedCertificate"
+ "$ref": "DomainMapping"
},
"parameterOrder": [
"appsId",
- "authorizedCertificatesId"
+ "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": {
- "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": {
+ "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"
}
},
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ "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": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.patch",
+ "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
"httpMethod": "PATCH",
"parameterOrder": [
"appsId",
- "authorizedCertificatesId"
+ "domainMappingsId"
],
"response": {
- "$ref": "AuthorizedCertificate"
+ "$ref": "Operation"
},
"parameters": {
- "authorizedCertificatesId": {
+ "domainMappingsId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
},
+ "noManagedCertificate": {
+ "location": "query",
+ "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask.",
+ "type": "boolean"
+ },
"updateMask": {
- "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.",
+ "description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
},
"appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.patch",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated."
+ ]
},
"create": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "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": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"required": true,
"type": "string",
"location": "path"
+ },
+ "overrideStrategy": {
+ "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
+ "STRICT",
+ "OVERRIDE"
+ ]
+ },
+ "noManagedCertificate": {
+ "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated.",
+ "type": "boolean",
+ "location": "query"
}
},
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.create",
- "description": "Uploads the specified SSL certificate.",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
],
- "httpMethod": "POST"
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.create",
+ "path": "v1alpha/apps/{appsId}/domainMappings"
}
}
}
@@ -616,34 +590,19 @@
}
},
"parameters": {
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "default": "true",
+ "location": "query"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
@@ -664,9 +623,14 @@
"type": "string"
},
"fields": {
+ "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
"description": "V1 error format.",
@@ -681,11 +645,6 @@
"2"
]
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"alt": {
"description": "Data format for response.",
"default": "json",
@@ -701,9 +660,82 @@
"Responses with Content-Type of application/x-protobuf"
],
"location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
}
},
"schemas": {
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "type": "object",
+ "properties": {
+ "standardEnvironmentAvailable": {
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ },
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ }
+ },
+ "id": "LocationMetadata"
+ },
+ "OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Beta"
+ }
+ },
+ "id": "OperationMetadataV1Beta"
+ },
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"type": "object",
@@ -726,23 +758,6 @@
"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",
@@ -751,6 +766,23 @@
"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"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
}
},
"id": "OperationMetadata"
@@ -759,16 +791,16 @@
"description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
"certificates": {
"description": "The SSL certificates the user is authorized to administer.",
"type": "array",
"items": {
"$ref": "AuthorizedCertificate"
}
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
}
},
"id": "ListAuthorizedCertificatesResponse"
@@ -785,7 +817,6 @@
"id": "CreateVersionMetadataV1Beta"
},
"ManagedCertificate": {
- "id": "ManagedCertificate",
"description": "A certificate managed by App Engine.",
"type": "object",
"properties": {
@@ -795,6 +826,8 @@
"type": "string"
},
"status": {
+ "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
+ "type": "string",
"enumDescriptions": [
"",
"Certificate was successfully obtained and inserted into the serving system.",
@@ -814,31 +847,28 @@
"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"
+ ]
}
- }
- },
- "SslSettings": {
- "id": "SslSettings",
- "description": "SSL configuration for a DomainMapping resource.",
- "type": "object",
- "properties": {
- "isManagedCertificate": {
- "description": "Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly",
- "type": "boolean"
- },
- "certificateId": {
- "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.",
- "type": "string"
- }
- }
+ },
+ "id": "ManagedCertificate"
},
"OperationMetadataV1": {
+ "id": "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"
@@ -859,21 +889,23 @@
"description": "Time that this operation was created.@OutputOnly",
"format": "google-datetime",
"type": "string"
+ }
+ }
+ },
+ "SslSettings": {
+ "description": "SSL configuration for a DomainMapping resource.",
+ "type": "object",
+ "properties": {
+ "isManagedCertificate": {
+ "description": "Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly",
+ "type": "boolean"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "certificateId": {
+ "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.",
"type": "string"
}
},
- "id": "OperationMetadataV1"
+ "id": "SslSettings"
},
"ListDomainMappingsResponse": {
"description": "Response message for DomainMappings.ListDomainMappings.",
@@ -910,11 +942,6 @@
"createVersionMetadata": {
"$ref": "CreateVersionMetadataV1Alpha"
},
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"type": "array",
@@ -922,14 +949,19 @@
"type": "string"
}
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
"target": {
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
},
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
"ephemeralMessage": {
"description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
"type": "string"
@@ -940,20 +972,26 @@
"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"
}
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
}
},
"id": "ListAuthorizedDomainsResponse"
},
+ "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",
+ "properties": {}
+ },
"DomainMapping": {
"description": "A domain serving an App Engine application.",
"type": "object",
@@ -980,22 +1018,17 @@
},
"id": "DomainMapping"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
"Location": {
+ "id": "Location",
"description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
"labels": {
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
@@ -1006,20 +1039,43 @@
"type": "string"
},
"metadata": {
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object"
}
- },
- "id": "Location"
+ }
},
"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": {
+ "$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"
@@ -1039,35 +1095,12 @@
"id": {
"description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
"type": "string"
- },
- "displayName": {
- "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
- "type": "string"
- },
- "managedCertificate": {
- "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly",
- "$ref": "ManagedCertificate"
- },
- "certificateRawData": {
- "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.",
- "$ref": "CertificateRawData"
- },
- "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"
}
},
"id": "AuthorizedCertificate"
},
"ResourceRecord": {
+ "id": "ResourceRecord",
"description": "A DNS resource record.",
"type": "object",
"properties": {
@@ -1093,21 +1126,12 @@
"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"
+ }
},
"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"
@@ -1121,6 +1145,14 @@
"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"
@@ -1137,7 +1169,6 @@
"id": "CreateVersionMetadataV1Alpha"
},
"ListLocationsResponse": {
- "id": "ListLocationsResponse",
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
@@ -1152,7 +1183,8 @@
"$ref": "Location"
}
}
- }
+ },
+ "id": "ListLocationsResponse"
},
"CertificateRawData": {
"id": "CertificateRawData",
@@ -1170,25 +1202,10 @@
}
},
"Operation": {
+ "id": "Operation",
"description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object",
"properties": {
- "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"
- }
- },
"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"
@@ -1200,12 +1217,26 @@
},
"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"
+ }
},
"Status": {
- "id": "Status",
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
@@ -1229,87 +1260,56 @@
}
}
}
- }
+ },
+ "id": "Status"
},
"AuthorizedDomain": {
- "id": "AuthorizedDomain",
"description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
"type": "object",
"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"
- }
- }
- },
- "LocationMetadata": {
- "id": "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"
- }
- }
- },
- "OperationMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
+ "name": {
+ "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
"type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Beta"
}
},
- "id": "OperationMetadataV1Beta"
+ "id": "AuthorizedDomain"
}
},
"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": "v1alpha",
- "baseUrl": "https://appengine.googleapis.com/"
+ "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": "20180118",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "id": "appengine:v1alpha"
}
diff --git a/appengine/v1beta/appengine-api.json b/appengine/v1beta/appengine-api.json
index 4c68438..32df644 100644
--- a/appengine/v1beta/appengine-api.json
+++ b/appengine/v1beta/appengine-api.json
@@ -1,37 +1,63 @@
{
- "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": "20180118",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "id": "appengine:v1beta",
"title": "Google App Engine Admin API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
"apps": {
"methods": {
+ "create": {
+ "id": "appengine.apps.create",
+ "path": "v1beta/apps",
+ "request": {
+ "$ref": "Application"
+ },
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps"
+ },
+ "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": {
- "path": "v1beta/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/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"appsId": {
"location": "path",
@@ -40,15 +66,17 @@
"type": "string"
}
},
- "flatPath": "v1beta/apps/{appsId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "path": "v1beta/apps/{appsId}",
+ "description": "Gets information about an application."
},
"patch": {
- "path": "v1beta/apps/{appsId}",
- "id": "appengine.apps.patch",
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
- "request": {
- "$ref": "Application"
- },
"response": {
"$ref": "Operation"
},
@@ -73,58 +101,681 @@
"type": "string"
}
},
- "flatPath": "v1beta/apps/{appsId}"
- },
- "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/).",
+ "flatPath": "v1beta/apps/{appsId}",
+ "path": "v1beta/apps/{appsId}",
+ "id": "appengine.apps.patch",
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
"request": {
"$ref": "Application"
- },
- "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"
- },
- "repair": {
- "id": "appengine.apps.repair",
- "path": "v1beta/apps/{appsId}:repair",
- "request": {
- "$ref": "RepairApplicationRequest"
- },
- "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.",
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "appsId": {
- "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"
+ }
}
},
"resources": {
+ "domainMappings": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.delete",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}"
+ },
+ "list": {
+ "flatPath": "v1beta/apps/{appsId}/domainMappings",
+ "path": "v1beta/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.list",
+ "description": "Lists the domain mappings on an application.",
+ "response": {
+ "$ref": "ListDomainMappingsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "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"
+ ]
+ },
+ "get": {
+ "description": "Gets the specified domain mapping.",
+ "response": {
+ "$ref": "DomainMapping"
+ },
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "domainMappingsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.get"
+ },
+ "patch": {
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.patch",
+ "path": "v1beta/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",
+ "domainMappingsId"
+ ],
+ "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": {
+ "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"
+ ]
+ },
+ "create": {
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "overrideStrategy": {
+ "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
+ "STRICT",
+ "OVERRIDE"
+ ]
+ },
+ "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": "v1beta/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.create",
+ "path": "v1beta/apps/{appsId}/domainMappings"
+ }
+ }
+ },
+ "firewall": {
+ "resources": {
+ "ingressRules": {
+ "methods": {
+ "delete": {
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.delete",
+ "description": "Deletes the specified firewall rule.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "ingressRulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists the firewall rules of an application.",
+ "response": {
+ "$ref": "ListIngressRulesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "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"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "path": "v1beta/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": {
+ "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"
+ },
+ "get": {
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "ingressRulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
+ "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}/firewall/ingressRules/{ingressRulesId}",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.get",
+ "description": "Gets the specified firewall rule."
+ },
+ "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": {
+ "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.",
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/locations",
+ "path": "v1beta/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list"
+ },
+ "get": {
+ "path": "v1beta/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get",
+ "description": "Get information about a location.",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/locations/{locationsId}"
+ }
+ }
+ },
+ "authorizedCertificates": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListAuthorizedCertificatesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "description": "Controls the set of fields returned in the LIST response.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.list",
+ "description": "Lists all SSL certificates the user is authorized to administer."
+ },
+ "get": {
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1beta/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"
+ ],
+ "parameters": {
+ "authorizedCertificatesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "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"
+ }
+ }
+ },
+ "patch": {
+ "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.patch"
+ },
+ "create": {
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "description": "Uploads the specified SSL certificate.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "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": "v1beta/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.create",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates"
+ },
+ "delete": {
+ "description": "Deletes the specified SSL certificate.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "authorizedCertificatesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.delete"
+ }
+ }
+ },
"services": {
"methods": {
"delete": {
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.delete",
+ "description": "Deletes the specified service and all enclosed versions.",
"response": {
"$ref": "Operation"
},
@@ -150,25 +801,16 @@
"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."
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}"
},
"list": {
- "description": "Lists all the services in the application.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListServicesResponse"
},
"parameterOrder": [
"appsId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"appsId": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
@@ -177,9 +819,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",
@@ -188,12 +830,17 @@
"type": "integer"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1beta/apps/{appsId}/services",
+ "id": "appengine.apps.services.list",
"path": "v1beta/apps/{appsId}/services",
- "id": "appengine.apps.services.list"
+ "description": "Lists all the services in the application."
},
"get": {
- "httpMethod": "GET",
"response": {
"$ref": "Service"
},
@@ -201,6 +848,12 @@
"appsId",
"servicesId"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"servicesId": {
"location": "path",
@@ -215,116 +868,286 @@
"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}",
- "id": "appengine.apps.services.get",
"path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.get",
"description": "Gets the current configuration of the specified service."
},
"patch": {
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.patch",
"request": {
"$ref": "Service"
},
"description": "Updates the configuration of the specified service.",
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"servicesId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "PATCH",
"parameters": {
"updateMask": {
+ "location": "query",
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"servicesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"migrateTraffic": {
+ "location": "query",
"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"
+ "type": "boolean"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch",
- "path": "v1beta/apps/{appsId}/services/{servicesId}"
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}"
}
},
"resources": {
"versions": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create",
+ "description": "Deploys code and resource files to a new version.",
+ "request": {
+ "$ref": "Version"
+ }
+ },
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.delete",
+ "description": "Deletes an existing Version resource."
+ },
+ "list": {
+ "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": {
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "view": {
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the List response.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions"
+ },
+ "get": {
+ "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": {
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.get",
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource."
+ },
+ "patch": {
+ "request": {
+ "$ref": "Version"
+ },
+ "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "PATCH",
+ "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": {
+ "location": "query",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ }
+ },
"resources": {
"instances": {
"methods": {
- "delete": {
- "description": "Stops a running instance.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
- },
"list": {
- "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).",
"httpMethod": "GET",
"parameterOrder": [
@@ -337,10 +1160,10 @@
},
"parameters": {
"servicesId": {
+ "location": "path",
"description": "Part of `parent`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"appsId": {
"description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
@@ -349,9 +1172,9 @@
"location": "path"
},
"pageToken": {
- "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"description": "Maximum results to return per page.",
@@ -370,10 +1193,16 @@
"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"
},
"get": {
- "httpMethod": "GET",
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.get",
+ "description": "Gets instance information.",
"response": {
"$ref": "Instance"
},
@@ -383,12 +1212,18 @@
"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",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"appsId": {
"location": "path",
@@ -408,24 +1243,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"
- ],
- "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"
},
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
"response": {
"$ref": "Operation"
},
@@ -436,13 +1260,10 @@
"instancesId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
@@ -450,248 +1271,75 @@
"location": "path"
},
"appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "versionsId": {
+ "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",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.services.versions.instances.debug"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
"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"
+ "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}/instances/{instancesId}:debug"
+ "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."
}
}
}
- },
- "methods": {
- "delete": {
- "description": "Deletes an existing Version resource.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "servicesId": {
- "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/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
- "list": {
- "description": "Lists the versions of a service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the List response.",
- "type": "string"
- },
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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",
- "id": "appengine.apps.services.versions.list",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions"
- },
- "get": {
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get",
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
- "response": {
- "$ref": "Version"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
- "type": "string"
- }
- },
- "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}/services/{servicesId}/versions/{versionsId}",
- "path": "v1beta/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/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": {
- "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"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "create": {
- "description": "Deploys code and resource files to a new version.",
- "request": {
- "$ref": "Version"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "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"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create"
- }
}
}
}
@@ -740,14 +1388,20 @@
"operations": {
"methods": {
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
"response": {
"$ref": "ListOperationsResponse"
},
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
"parameters": {
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
"filter": {
"location": "query",
"description": "The standard list filter.",
@@ -763,12 +1417,6 @@
"location": "query",
"description": "The standard list page token.",
"type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
}
},
"scopes": [
@@ -777,701 +1425,42 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1beta/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
"path": "v1beta/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
},
"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"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"appsId",
"operationsId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
- "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"
+ },
+ "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"
+ ],
"flatPath": "v1beta/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
"path": "v1beta/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get"
- }
- }
- },
- "domainMappings": {
- "methods": {
- "delete": {
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.delete",
- "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "DELETE",
- "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}"
- },
- "list": {
- "flatPath": "v1beta/apps/{appsId}/domainMappings",
- "path": "v1beta/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.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"
- ]
- },
- "get": {
- "description": "Gets the specified domain mapping.",
- "response": {
- "$ref": "DomainMapping"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.get"
- },
- "patch": {
- "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.patch",
- "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
- "request": {
- "$ref": "DomainMapping"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "create": {
- "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
- "request": {
- "$ref": "DomainMapping"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "overrideStrategy": {
- "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"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/domainMappings",
- "path": "v1beta/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create"
- }
- }
- },
- "firewall": {
- "resources": {
- "ingressRules": {
- "methods": {
- "list": {
- "description": "Lists the firewall rules of an application.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListIngressRulesResponse"
- },
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "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",
- "id": "appengine.apps.firewall.ingressRules.list",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules"
- },
- "create": {
- "request": {
- "$ref": "FirewallRule"
- },
- "description": "Creates a firewall rule for the application.",
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.create"
- },
- "get": {
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "ingressRulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "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": {
- "request": {
- "$ref": "FirewallRule"
- },
- "description": "Updates the specified firewall rule.",
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "ingressRulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "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 Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.patch"
- },
- "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.",
- "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"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.",
- "required": true,
- "type": "string"
- },
- "ingressRulesId": {
- "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."
- }
- }
- }
- }
- },
- "locations": {
- "methods": {
- "list": {
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/locations",
- "path": "v1beta/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list"
- },
- "get": {
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "locationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Resource name for the location.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/locations/{locationsId}",
- "path": "v1beta/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get"
- }
- }
- },
- "authorizedCertificates": {
- "methods": {
- "list": {
- "description": "Lists all SSL certificates the user is authorized to administer.",
- "response": {
- "$ref": "ListAuthorizedCertificatesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the LIST response.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
- "path": "v1beta/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.list"
- },
- "get": {
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "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"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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": {
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string"
- },
- "authorizedCertificatesId": {
- "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}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.patch",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated."
- },
- "create": {
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
- "path": "v1beta/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"
- ]
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string"
- },
- "authorizedCertificatesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "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.delete",
- "description": "Deletes the specified SSL certificate."
+ "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."
}
}
}
@@ -1479,56 +1468,67 @@
}
},
"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"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "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"
},
- "uploadType": {
+ "fields": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -1537,1588 +1537,29 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "default": "json"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
+ "type": "string"
}
},
"schemas": {
- "ManagedCertificate": {
- "properties": {
- "lastRenewalTime": {
- "description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "status": {
- "enumDescriptions": [
- "",
- "Certificate was successfully obtained and inserted into the serving system.",
- "Certificate is under active attempts to acquire or renew.",
- "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
- "All renewal attempts have been exhausted, likely due to an invalid DNS setup.",
- "Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
- "Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving."
- ],
- "enum": [
- "MANAGEMENT_STATUS_UNSPECIFIED",
- "OK",
- "PENDING",
- "FAILED_RETRYING_NOT_VISIBLE",
- "FAILED_PERMANENT",
- "FAILED_RETRYING_CAA_FORBIDDEN",
- "FAILED_RETRYING_CAA_CHECKING"
- ],
- "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
- "type": "string"
- }
- },
- "id": "ManagedCertificate",
- "description": "A certificate managed by App Engine.",
- "type": "object"
- },
- "ListInstancesResponse": {
- "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"
- },
- "ListDomainMappingsResponse": {
- "description": "Response message for DomainMappings.ListDomainMappings.",
- "type": "object",
- "properties": {
- "domainMappings": {
- "description": "The domain mappings for the application.",
- "type": "array",
- "items": {
- "$ref": "DomainMapping"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListDomainMappingsResponse"
- },
- "OperationMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Alpha"
- }
- },
- "id": "OperationMetadataV1Alpha"
- },
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object",
- "properties": {
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- },
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "service": {
- "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule"
- },
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "versions": {
- "description": "The versions belonging to the requested service.",
- "type": "array",
- "items": {
- "$ref": "Version"
- }
- }
- },
- "id": "ListVersionsResponse"
- },
- "ListAuthorizedDomainsResponse": {
- "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "domains": {
- "description": "The authorized domains belonging to the user.",
- "type": "array",
- "items": {
- "$ref": "AuthorizedDomain"
- }
- }
- },
- "id": "ListAuthorizedDomainsResponse"
- },
- "DomainMapping": {
- "description": "A domain serving an App Engine application.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Relative name of the domain serving the application. Example: example.com.",
- "type": "string"
- },
- "resourceRecords": {
- "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "ResourceRecord"
- }
- },
- "name": {
- "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
- "type": "string"
- },
- "sslSettings": {
- "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.",
- "$ref": "SslSettings"
- }
- },
- "id": "DomainMapping"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler"
- },
- "AutomaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object",
- "properties": {
- "requestUtilization": {
- "description": "Target scaling by request utilization.",
- "$ref": "RequestUtilization"
- },
- "maxIdleInstances": {
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "standardSchedulerSettings": {
- "$ref": "StandardSchedulerSettings",
- "description": "Scheduler settings for standard environment."
- },
- "minIdleInstances": {
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
- "format": "int32",
- "type": "integer"
- },
- "maxTotalInstances": {
- "description": "Maximum number of instances that should be started to handle requests.",
- "format": "int32",
- "type": "integer"
- },
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "networkUtilization": {
- "$ref": "NetworkUtilization",
- "description": "Target scaling by network usage."
- },
- "customMetrics": {
- "description": "Target scaling by user-provided metrics.",
- "type": "array",
- "items": {
- "$ref": "CustomMetric"
- }
- },
- "maxConcurrentRequests": {
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "format": "int32",
- "type": "integer"
- },
- "coolDownPeriod": {
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable in the App Engine flexible environment.",
- "format": "google-duration",
- "type": "string"
- },
- "maxPendingLatency": {
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
- },
- "diskUtilization": {
- "description": "Target scaling by disk usage.",
- "$ref": "DiskUtilization"
- },
- "minPendingLatency": {
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "AutomaticScaling"
- },
- "ZipInfo": {
- "description": "The zip file information for a zip deployment.",
- "type": "object",
- "properties": {
- "filesCount": {
- "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
- "format": "int32",
- "type": "integer"
- },
- "sourceUrl": {
- "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- }
- },
- "id": "ZipInfo"
- },
- "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",
- "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": [
- "A",
- "AAAA",
- "CNAME"
- ],
- "description": "Resource record type. Example: AAAA.",
- "type": "string",
- "enumDescriptions": [
- "An A resource record. Data is an IPv4 address.",
- "An AAAA resource record. Data is an IPv6 address.",
- "A CNAME resource record. Data is a domain name to be aliased."
- ]
- },
- "rrdata": {
- "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
- "type": "string"
- }
- },
- "id": "ResourceRecord"
- },
- "Library": {
- "properties": {
- "name": {
- "description": "Name of the library. Example: \"django\".",
- "type": "string"
- },
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- }
- },
- "id": "Library",
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListLocationsResponse"
- },
- "ContainerInfo": {
- "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "image": {
- "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
- "type": "string"
- }
- },
- "id": "ContainerInfo"
- },
- "RequestUtilization": {
- "properties": {
- "targetRequestCountPerSecond": {
- "description": "Target requests per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetConcurrentRequests": {
- "description": "Target number of concurrent requests.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "RequestUtilization",
- "description": "Target scaling by request utilization. Only applicable in the App Engine flexible environment.",
- "type": "object"
- },
- "UrlMap": {
- "properties": {
- "apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
- },
- "staticFiles": {
- "$ref": "StaticFilesHandler",
- "description": "Returns the contents of a file, such as an image, as the response."
- },
- "redirectHttpResponseCode": {
- "enumDescriptions": [
- "Not specified. 302 is assumed.",
- "301 Moved Permanently code.",
- "302 Moved Temporarily code.",
- "303 See Other code.",
- "307 Temporary Redirect code."
- ],
- "enum": [
- "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
- "REDIRECT_HTTP_RESPONSE_CODE_301",
- "REDIRECT_HTTP_RESPONSE_CODE_302",
- "REDIRECT_HTTP_RESPONSE_CODE_303",
- "REDIRECT_HTTP_RESPONSE_CODE_307"
- ],
- "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
- "type": "string"
- },
- "securityLevel": {
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "script": {
- "description": "Executes a script to handle the request that matches this URL pattern.",
- "$ref": "ScriptHandler"
- },
- "urlRegex": {
- "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
- "type": "string"
- },
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource.",
- "type": "string"
- }
- },
- "id": "UrlMap",
- "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
- "type": "object"
- },
- "EndpointsApiService": {
- "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
- "type": "object",
- "properties": {
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- },
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.",
- "type": "string"
- }
- },
- "id": "EndpointsApiService"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "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"
- },
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- }
- },
- "id": "Operation"
- },
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
- "properties": {
- "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"
- },
- "StaticFilesHandler": {
- "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
- "type": "object",
- "properties": {
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
- "expiration": {
- "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
- "format": "google-duration",
- "type": "string"
- },
- "httpHeaders": {
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- },
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
- "type": "string"
- },
- "path": {
- "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
- "type": "string"
- }
- },
- "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": {
- "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"
- },
- "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": {
- "properties": {
- "oauth2ClientSecret": {
- "description": "OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
- "type": "string"
- },
- "oauth2ClientSecretSha256": {
- "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
- "type": "string"
- },
- "enabled": {
- "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.",
- "type": "boolean"
- }
- },
- "id": "IdentityAwareProxy",
- "description": "Identity-Aware Proxy",
- "type": "object"
- },
- "ManualScaling": {
- "properties": {
- "instances": {
- "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ManualScaling",
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "type": "object"
- },
- "LocationMetadata": {
- "description": "Metadata for the given google.cloud.location.Location.",
- "type": "object",
- "properties": {
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- }
- },
- "id": "LocationMetadata"
- },
- "Service": {
- "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "split": {
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
- "$ref": "TrafficSplit"
- },
- "id": {
- "description": "Relative name of the service within the application. Example: default.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Service"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "FirewallRule": {
- "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
- "type": "object",
- "properties": {
- "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": {
- "description": "The action to take on matched requests.",
- "type": "string",
- "enumDescriptions": [
- "",
- "Matching requests are allowed.",
- "Matching requests are denied."
- ],
- "enum": [
- "UNSPECIFIED_ACTION",
- "ALLOW",
- "DENY"
- ]
- },
- "description": {
- "description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
- "type": "string"
- }
- },
- "id": "FirewallRule"
- },
- "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"
- },
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
- "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"
- },
- "CreateVersionMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
- "type": "object",
- "properties": {
- "cloudBuildId": {
- "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
- "type": "string"
- }
- },
- "id": "CreateVersionMetadataV1Beta"
- },
- "FeatureSettings": {
- "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
- "type": "object",
- "properties": {
- "useContainerOptimizedOs": {
- "description": "If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.",
- "type": "boolean"
- },
- "splitHealthChecks": {
- "description": "Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.",
- "type": "boolean"
- }
- },
- "id": "FeatureSettings"
- },
- "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"
- },
- "SslSettings": {
- "description": "SSL configuration for a DomainMapping resource.",
- "type": "object",
- "properties": {
- "pendingManagedCertificateId": {
- "description": "ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly",
- "type": "string"
- },
- "certificateId": {
- "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.",
- "type": "string"
- },
- "sslManagementType": {
- "description": "SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.",
- "type": "string",
- "enumDescriptions": [
- "SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.",
- "SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain."
- ],
- "enum": [
- "AUTOMATIC",
- "MANUAL"
- ]
- }
- },
- "id": "SslSettings"
- },
- "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"
- },
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
- "properties": {
- "codeBucket": {
- "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
- "type": "string"
- },
- "defaultBucket": {
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "UrlDispatchRule"
- }
- },
- "gcrDomain": {
- "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
- "format": "google-duration",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
- },
- "locationId": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
- "servingStatus": {
- "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"
- ],
- "description": "Serving status of this application.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "Application"
- },
- "Network": {
- "description": "Extra network settings. Only applicable in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation. for Only applicable in the App Engine flexible environment.",
- "type": "string"
- },
- "subnetworkName": {
- "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.",
- "type": "string"
- },
- "name": {
- "description": "Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network"
- },
- "Instance": {
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object",
- "properties": {
- "vmDebugEnabled": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "qps": {
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "format": "float",
- "type": "number"
- },
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
- },
- "averageLatency": {
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "memoryUsage": {
- "description": "Total memory in use (bytes).@OutputOnly",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
- "type": "string"
- },
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "availability": {
- "description": "Availability of the instance.@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ]
- },
- "startTime": {
- "description": "Time that this instance was started.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Instance"
- },
- "LivenessCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
- "type": "object",
- "properties": {
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "failureThreshold": {
- "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
- "format": "uint32",
- "type": "integer"
- },
- "initialDelay": {
- "description": "The initial delay before starting to execute the checks.",
- "format": "google-duration",
- "type": "string"
- },
- "path": {
- "description": "The request path.",
- "type": "string"
- },
- "successThreshold": {
- "description": "Number of consecutive successful checks required before considering the VM healthy.",
- "format": "uint32",
- "type": "integer"
- },
- "host": {
- "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "LivenessCheck"
- },
- "BatchUpdateIngressRulesRequest": {
- "properties": {
- "ingressRules": {
- "description": "A list of FirewallRules to replace the existing set.",
- "type": "array",
- "items": {
- "$ref": "FirewallRule"
- }
- }
- },
- "id": "BatchUpdateIngressRulesRequest",
- "description": "Request message for Firewall.BatchUpdateIngressRules.",
- "type": "object"
- },
- "CloudBuildOptions": {
- "description": "Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly.",
- "type": "object",
- "properties": {
- "cloudBuildTimeout": {
- "description": "The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.",
- "format": "google-duration",
- "type": "string"
- },
- "appYamlPath": {
- "description": "Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.",
- "type": "string"
- }
- },
- "id": "CloudBuildOptions"
- },
- "NetworkUtilization": {
- "properties": {
- "targetSentBytesPerSecond": {
- "description": "Target bytes sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentPacketsPerSecond": {
- "description": "Target packets sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedBytesPerSecond": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedPacketsPerSecond": {
- "description": "Target packets received per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "NetworkUtilization",
- "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.",
- "type": "object"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object"
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
- }
- },
- "id": "Location"
- },
- "HealthCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
- "type": "object",
- "properties": {
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
- },
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "restartThreshold": {
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "format": "uint32",
- "type": "integer"
- },
- "healthyThreshold": {
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- },
- "timeout": {
- "description": "Time before the health check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "unhealthyThreshold": {
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
- }
- },
- "id": "HealthCheck"
- },
- "ReadinessCheck": {
- "properties": {
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- },
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "failureThreshold": {
- "description": "Number of consecutive failed checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "appStartTimeout": {
- "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
- "format": "google-duration",
- "type": "string"
- },
- "path": {
- "description": "The request path.",
- "type": "string"
- },
- "host": {
- "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "successThreshold": {
- "description": "Number of consecutive successful checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
- }
- },
- "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).",
- "type": "string"
- }
- },
- "id": "DebugInstanceRequest",
- "description": "Request message for Instances.DebugInstance.",
- "type": "object"
- },
- "StandardSchedulerSettings": {
- "description": "Scheduler settings for standard environment.",
- "type": "object",
- "properties": {
- "targetThroughputUtilization": {
- "description": "Target throughput utilization ratio to maintain when scaling",
- "format": "double",
- "type": "number"
- },
- "maxInstances": {
- "description": "Maximum number of instances for an app version. Set to zero to disable max_instances configuration.",
- "format": "int32",
- "type": "integer"
- },
- "minInstances": {
- "description": "Minimum number of instances for an app version. Set to zero to disable min_instances configuration.",
- "format": "int32",
- "type": "integer"
- },
- "targetCpuUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "StandardSchedulerSettings"
- },
- "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"
- },
- "CreateVersionMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
- "type": "object",
- "properties": {
- "cloudBuildId": {
- "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
- "type": "string"
- }
- },
- "id": "CreateVersionMetadataV1Alpha"
- },
"Version": {
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
"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/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
"format": "google-duration",
@@ -3143,35 +1584,35 @@
"description": "Desired runtime. Example: python27.",
"type": "string"
},
- "createdBy": {
- "description": "Email address of the user who created this version.@OutputOnly",
- "type": "string"
- },
"id": {
"description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
"type": "string"
},
+ "createdBy": {
+ "description": "Email address of the user who created this version.@OutputOnly",
+ "type": "string"
+ },
"envVariables": {
+ "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object"
+ }
},
"livenessCheck": {
- "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.",
- "$ref": "LivenessCheck"
+ "$ref": "LivenessCheck",
+ "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
},
"network": {
"description": "Extra network settings. Only applicable in the App Engine flexible environment.",
"$ref": "Network"
},
"betaSettings": {
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "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.",
@@ -3201,8 +1642,8 @@
"type": "string"
},
"healthCheck": {
- "$ref": "HealthCheck",
- "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set."
+ "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set.",
+ "$ref": "HealthCheck"
},
"threadsafe": {
"description": "Whether multiple requests can be dispatched to this version at once.",
@@ -3221,28 +1662,26 @@
"type": "string"
},
"apiConfig": {
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
- "$ref": "ApiConfigHandler"
+ "$ref": "ApiConfigHandler",
+ "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
},
"endpointsApiService": {
"description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.",
"$ref": "EndpointsApiService"
},
- "versionUrl": {
- "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
- "type": "string"
- },
"vm": {
"description": "Whether to deploy this version in a container on a virtual machine.",
"type": "boolean"
},
+ "versionUrl": {
+ "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
+ "type": "string"
+ },
"instanceClass": {
"description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
"type": "string"
},
"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.",
@@ -3252,11 +1691,13 @@
"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."
+ "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",
@@ -3267,18 +1708,11 @@
"format": "google-datetime",
"type": "string"
},
+ "resources": {
+ "$ref": "Resources",
+ "description": "Machine resources for this version. Only applicable for VM runtimes."
+ },
"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": {
@@ -3294,19 +1728,48 @@
"INBOUND_SERVICE_WARMUP"
],
"type": "string"
- }
+ },
+ "enumDescriptions": [
+ "Not specified.",
+ "Allows an application to receive mail.",
+ "Allows an application to receive email-bound notifications.",
+ "Allows an application to receive error stanzas.",
+ "Allows an application to receive instant messages.",
+ "Allows an application to receive user subscription POSTs.",
+ "Allows an application to receive a user's chat presence.",
+ "Registers an application for notifications when a client connects or disconnects from a channel.",
+ "Enables warmup requests."
+ ]
},
- "resources": {
- "description": "Machine resources for this version. Only applicable for VM runtimes.",
- "$ref": "Resources"
+ "errorHandlers": {
+ "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
+ "type": "array",
+ "items": {
+ "$ref": "ErrorHandler"
+ }
}
},
"id": "Version"
},
"RepairApplicationRequest": {
- "properties": {},
- "id": "RepairApplicationRequest",
"description": "Request message for 'Applications.RepairApplication'.",
+ "type": "object",
+ "properties": {},
+ "id": "RepairApplicationRequest"
+ },
+ "CertificateRawData": {
+ "properties": {
+ "publicCertificate": {
+ "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
+ "type": "string"
+ },
+ "privateKey": {
+ "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
+ "type": "string"
+ }
+ },
+ "id": "CertificateRawData",
+ "description": "An SSL certificate obtained from a certificate authority.",
"type": "object"
},
"BuildInfo": {
@@ -3320,21 +1783,6 @@
},
"id": "BuildInfo"
},
- "CertificateRawData": {
- "description": "An SSL certificate obtained from a certificate authority.",
- "type": "object",
- "properties": {
- "publicCertificate": {
- "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
- "type": "string"
- },
- "privateKey": {
- "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
- "type": "string"
- }
- },
- "id": "CertificateRawData"
- },
"ScriptHandler": {
"description": "Executes a script to handle the request that matches the URL pattern.",
"type": "object",
@@ -3350,10 +1798,6 @@
"description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
"type": "object",
"properties": {
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
- "type": "string"
- },
"sourceUrl": {
"description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
"type": "string"
@@ -3361,6 +1805,10 @@
"sha1Sum": {
"description": "The SHA1 hash of the file, in hex.",
"type": "string"
+ },
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "type": "string"
}
},
"id": "FileInfo"
@@ -3369,13 +1817,13 @@
"description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
"type": "object",
"properties": {
- "id": {
- "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
- "type": "string"
- },
"name": {
"description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
"type": "string"
+ },
+ "id": {
+ "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
+ "type": "string"
}
},
"id": "AuthorizedDomain"
@@ -3401,12 +1849,12 @@
"type": "string"
},
"allocations": {
+ "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object",
"additionalProperties": {
"format": "double",
"type": "number"
- },
- "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
- "type": "object"
+ }
}
},
"id": "TrafficSplit"
@@ -3415,14 +1863,11 @@
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Beta"
- },
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"type": "array",
@@ -3430,19 +1875,14 @@
"type": "string"
}
},
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
},
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
},
- "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"
@@ -3450,28 +1890,18 @@
"method": {
"description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
"type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Beta"
}
},
"id": "OperationMetadataV1Beta"
},
- "ListServicesResponse": {
- "description": "Response message for Services.ListServices.",
- "type": "object",
- "properties": {
- "services": {
- "description": "The services belonging to the requested application.",
- "type": "array",
- "items": {
- "$ref": "Service"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListServicesResponse"
- },
"ListIngressRulesResponse": {
"description": "Response message for Firewall.ListIngressRules.",
"type": "object",
@@ -3490,6 +1920,24 @@
},
"id": "ListIngressRulesResponse"
},
+ "ListServicesResponse": {
+ "description": "Response message for Services.ListServices.",
+ "type": "object",
+ "properties": {
+ "services": {
+ "description": "The services belonging to the requested application.",
+ "type": "array",
+ "items": {
+ "$ref": "Service"
+ }
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListServicesResponse"
+ },
"Deployment": {
"description": "Code and application artifacts used to deploy a version to App Engine.",
"type": "object",
@@ -3551,6 +1999,10 @@
},
"Volume": {
"properties": {
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
+ },
"sizeGb": {
"description": "Volume size in gigabytes.",
"format": "double",
@@ -3559,10 +2011,6 @@
"name": {
"description": "Unique name for the volume.",
"type": "string"
- },
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
}
},
"id": "Volume",
@@ -3570,8 +2018,6 @@
"type": "object"
},
"BatchUpdateIngressRulesResponse": {
- "description": "Response message for Firewall.UpdateAllIngressRules.",
- "type": "object",
"properties": {
"ingressRules": {
"description": "The full list of ingress FirewallRules for this application.",
@@ -3581,21 +2027,12 @@
}
}
},
- "id": "BatchUpdateIngressRulesResponse"
+ "id": "BatchUpdateIngressRulesResponse",
+ "description": "Response message for Firewall.UpdateAllIngressRules.",
+ "type": "object"
},
"CustomMetric": {
- "description": "Allows autoscaling based on Stackdriver metrics.",
- "type": "object",
"properties": {
- "targetUtilization": {
- "description": "The target value for the metric.",
- "format": "double",
- "type": "number"
- },
- "targetType": {
- "description": "The type of the metric. Must be a string representing a Stackdriver metric type e.g. GAGUE, DELTA_PER_SECOND, etc.",
- "type": "string"
- },
"filter": {
"description": "Allows filtering on the metric's fields.",
"type": "string"
@@ -3608,9 +2045,1561 @@
"description": "May be used instead of target_utilization when an instance can handle a specific amount of work/resources and the metric value is equal to the current amount of work remaining. The autoscaler will try to keep the number of instances equal to the metric value divided by single_instance_assignment.",
"format": "double",
"type": "number"
+ },
+ "targetUtilization": {
+ "description": "The target value for the metric.",
+ "format": "double",
+ "type": "number"
+ },
+ "targetType": {
+ "description": "The type of the metric. Must be a string representing a Stackdriver metric type e.g. GAGUE, DELTA_PER_SECOND, etc.",
+ "type": "string"
}
},
- "id": "CustomMetric"
+ "id": "CustomMetric",
+ "description": "Allows autoscaling based on Stackdriver metrics.",
+ "type": "object"
+ },
+ "ManagedCertificate": {
+ "description": "A certificate managed by App Engine.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "enumDescriptions": [
+ "",
+ "Certificate was successfully obtained and inserted into the serving system.",
+ "Certificate is under active attempts to acquire or renew.",
+ "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
+ "All renewal attempts have been exhausted, likely due to an invalid DNS setup.",
+ "Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
+ "Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving."
+ ],
+ "enum": [
+ "MANAGEMENT_STATUS_UNSPECIFIED",
+ "OK",
+ "PENDING",
+ "FAILED_RETRYING_NOT_VISIBLE",
+ "FAILED_PERMANENT",
+ "FAILED_RETRYING_CAA_FORBIDDEN",
+ "FAILED_RETRYING_CAA_CHECKING"
+ ],
+ "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
+ "type": "string"
+ },
+ "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": {
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "type": "array",
+ "items": {
+ "$ref": "Instance"
+ }
+ }
+ },
+ "id": "ListInstancesResponse"
+ },
+ "ListDomainMappingsResponse": {
+ "description": "Response message for DomainMappings.ListDomainMappings.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Alpha"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Alpha"
+ },
+ "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": {
+ "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "domains": {
+ "description": "The authorized domains belonging to the user.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthorizedDomain"
+ }
+ }
+ },
+ "id": "ListAuthorizedDomainsResponse"
+ },
+ "ApiEndpointHandler": {
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "type": "object",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ApiEndpointHandler"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "DomainMapping": {
+ "description": "A domain serving an App Engine application.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Relative name of the domain serving the application. Example: example.com.",
+ "type": "string"
+ },
+ "resourceRecords": {
+ "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "ResourceRecord"
+ }
+ },
+ "name": {
+ "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "sslSettings": {
+ "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.",
+ "$ref": "SslSettings"
+ }
+ },
+ "id": "DomainMapping"
+ },
+ "ZipInfo": {
+ "properties": {
+ "filesCount": {
+ "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceUrl": {
+ "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ }
+ },
+ "id": "ZipInfo",
+ "description": "The zip file information for a zip deployment.",
+ "type": "object"
+ },
+ "AutomaticScaling": {
+ "properties": {
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
+ },
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ },
+ "maxIdleInstances": {
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "standardSchedulerSettings": {
+ "description": "Scheduler settings for standard environment.",
+ "$ref": "StandardSchedulerSettings"
+ },
+ "minIdleInstances": {
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxTotalInstances": {
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "customMetrics": {
+ "description": "Target scaling by user-provided metrics.",
+ "type": "array",
+ "items": {
+ "$ref": "CustomMetric"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "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"
+ },
+ "managedCertificate": {
+ "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly",
+ "$ref": "ManagedCertificate"
+ },
+ "certificateRawData": {
+ "$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": {
+ "rrdata": {
+ "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
+ "type": "string"
+ },
+ "name": {
+ "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "An A resource record. Data is an IPv4 address.",
+ "An AAAA resource record. Data is an IPv6 address.",
+ "A CNAME resource record. Data is a domain name to be aliased."
+ ],
+ "enum": [
+ "A",
+ "AAAA",
+ "CNAME"
+ ],
+ "description": "Resource record type. Example: AAAA.",
+ "type": "string"
+ }
+ },
+ "id": "ResourceRecord"
+ },
+ "Library": {
+ "properties": {
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ }
+ },
+ "id": "Library",
+ "description": "Third-party Python runtime library that is required by the application.",
+ "type": "object"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Location"
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "ContainerInfo": {
+ "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
+ "type": "object",
+ "properties": {
+ "image": {
+ "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
+ "type": "string"
+ }
+ },
+ "id": "ContainerInfo"
+ },
+ "RequestUtilization": {
+ "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": {
+ "properties": {
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "type": "string"
+ },
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.",
+ "type": "string"
+ }
+ },
+ "id": "EndpointsApiService",
+ "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
+ "type": "object"
+ },
+ "UrlMap": {
+ "properties": {
+ "login": {
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ],
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "description": "Level of login required to access this resource.",
+ "type": "string"
+ },
+ "apiEndpoint": {
+ "description": "Uses API Endpoints to handle requests.",
+ "$ref": "ApiEndpointHandler"
+ },
+ "staticFiles": {
+ "description": "Returns the contents of a file, such as an image, as the response.",
+ "$ref": "StaticFilesHandler"
+ },
+ "redirectHttpResponseCode": {
+ "enumDescriptions": [
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ],
+ "enum": [
+ "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
+ "REDIRECT_HTTP_RESPONSE_CODE_301",
+ "REDIRECT_HTTP_RESPONSE_CODE_302",
+ "REDIRECT_HTTP_RESPONSE_CODE_303",
+ "REDIRECT_HTTP_RESPONSE_CODE_307"
+ ],
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "type": "string"
+ },
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ]
+ },
+ "authFailAction": {
+ "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": {
+ "$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"
+ }
+ },
+ "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"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object",
+ "properties": {
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ }
+ },
+ "id": "Operation"
+ },
+ "ApiConfigHandler": {
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "type": "object",
+ "properties": {
+ "script": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ },
+ "login": {
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ],
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL to serve the endpoint at.",
+ "type": "string"
+ },
+ "securityLevel": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string"
+ },
+ "authFailAction": {
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string"
+ }
+ },
+ "id": "ApiConfigHandler"
+ },
+ "StaticFilesHandler": {
+ "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
+ "type": "object",
+ "properties": {
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
+ },
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
+ "type": "string"
+ },
+ "path": {
+ "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ }
+ },
+ "id": "StaticFilesHandler"
+ },
+ "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"
+ },
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.",
+ "type": "object",
+ "properties": {
+ "targetWriteOpsPerSecond": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSecond": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "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": {
+ "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": {
+ "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": {
+ "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"
+ },
+ "description": {
+ "description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
+ "type": "string"
+ }
+ },
+ "id": "FirewallRule"
+ },
+ "OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "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"
+ },
+ "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"
+ },
+ "CreateVersionMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
+ "type": "object",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "CreateVersionMetadataV1Beta"
+ },
+ "FeatureSettings": {
+ "properties": {
+ "useContainerOptimizedOs": {
+ "description": "If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.",
+ "type": "boolean"
+ },
+ "splitHealthChecks": {
+ "description": "Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.",
+ "type": "boolean"
+ }
+ },
+ "id": "FeatureSettings",
+ "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": {
+ "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"
+ },
+ "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": "OperationMetadataV1"
+ },
+ "SslSettings": {
+ "description": "SSL configuration for a DomainMapping resource.",
+ "type": "object",
+ "properties": {
+ "pendingManagedCertificateId": {
+ "description": "ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly",
+ "type": "string"
+ },
+ "certificateId": {
+ "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.",
+ "type": "string"
+ },
+ "sslManagementType": {
+ "enumDescriptions": [
+ "SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.",
+ "SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain."
+ ],
+ "enum": [
+ "AUTOMATIC",
+ "MANUAL"
+ ],
+ "description": "SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.",
+ "type": "string"
+ }
+ },
+ "id": "SslSettings"
+ },
+ "ErrorHandler": {
+ "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",
+ "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": {
+ "properties": {
+ "defaultBucket": {
+ "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
+ "type": "string"
+ },
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ }
+ },
+ "gcrDomain": {
+ "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "servingStatus": {
+ "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"
+ ],
+ "description": "Serving status of this application.",
+ "type": "string"
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ },
+ "featureSettings": {
+ "$ref": "FeatureSettings",
+ "description": "The feature specific settings to be used in the application."
+ },
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
+ "type": "string"
+ },
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "codeBucket": {
+ "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Application",
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "type": "object"
+ },
+ "Instance": {
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "averageLatency": {
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "memoryUsage": {
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "format": "int64",
+ "type": "string"
+ },
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "availability": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "description": "Availability of the instance.@OutputOnly",
+ "type": "string"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Time that this instance was started.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "vmDebugEnabled": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "requests": {
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
+ "type": "string"
+ },
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Instance"
+ },
+ "LivenessCheck": {
+ "properties": {
+ "path": {
+ "description": "The request path.",
+ "type": "string"
+ },
+ "host": {
+ "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "successThreshold": {
+ "description": "Number of consecutive successful checks required before considering the VM healthy.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "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"
+ },
+ "initialDelay": {
+ "description": "The initial delay before starting to execute the checks.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "LivenessCheck",
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
+ "type": "object"
+ },
+ "BatchUpdateIngressRulesRequest": {
+ "description": "Request message for Firewall.BatchUpdateIngressRules.",
+ "type": "object",
+ "properties": {
+ "ingressRules": {
+ "description": "A list of FirewallRules to replace the existing set.",
+ "type": "array",
+ "items": {
+ "$ref": "FirewallRule"
+ }
+ }
+ },
+ "id": "BatchUpdateIngressRulesRequest"
+ },
+ "CloudBuildOptions": {
+ "description": "Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly.",
+ "type": "object",
+ "properties": {
+ "cloudBuildTimeout": {
+ "description": "The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "appYamlPath": {
+ "description": "Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.",
+ "type": "string"
+ }
+ },
+ "id": "CloudBuildOptions"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: \"us-east1\".",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "id": "Location"
+ },
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.",
+ "type": "object",
+ "properties": {
+ "targetSentBytesPerSecond": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSecond": {
+ "description": "Target packets sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedBytesPerSecond": {
+ "description": "Target bytes received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSecond": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "NetworkUtilization"
+ },
+ "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"
+ },
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "healthyThreshold": {
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "restartThreshold": {
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "timeout": {
+ "description": "Time before the health check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "HealthCheck"
+ },
+ "ReadinessCheck": {
+ "properties": {
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "failureThreshold": {
+ "description": "Number of consecutive failed checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "appStartTimeout": {
+ "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "path": {
+ "description": "The request path.",
+ "type": "string"
+ },
+ "successThreshold": {
+ "description": "Number of consecutive successful checks required before receiving traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "host": {
+ "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "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",
+ "format": "double",
+ "type": "number"
+ },
+ "maxInstances": {
+ "description": "Maximum number of instances for an app version. Set to zero to disable max_instances configuration.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minInstances": {
+ "description": "Minimum number of instances for an app version. Set to zero to disable min_instances configuration.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetCpuUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "StandardSchedulerSettings"
+ },
+ "DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "type": "object",
+ "properties": {
+ "sshKey": {
+ "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).",
+ "type": "string"
+ }
+ },
+ "id": "DebugInstanceRequest"
+ },
+ "CreateVersionMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
+ "type": "object",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "CreateVersionMetadataV1Alpha"
+ },
+ "OperationMetadataV1Beta5": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta5"
}
},
"icons": {
@@ -3634,5 +3623,16 @@
}
}
}
- }
+ },
+ "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",
+ "name": "appengine",
+ "batchPath": "batch",
+ "revision": "20180118",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "id": "appengine:v1beta"
}
diff --git a/appengine/v1beta4/appengine-api.json b/appengine/v1beta4/appengine-api.json
index ce3ab28..c5c186b 100644
--- a/appengine/v1beta4/appengine-api.json
+++ b/appengine/v1beta4/appengine-api.json
@@ -7,93 +7,90 @@
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
"id": "appengine:v1beta4",
"title": "Google App Engine Admin API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"apps": {
- "methods": {
- "get": {
- "description": "Gets information about an application.",
- "response": {
- "$ref": "Application"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "ensureResourcesExist": {
- "location": "query",
- "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.",
- "type": "boolean"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}",
- "path": "v1beta4/apps/{appsId}",
- "id": "appengine.apps.get"
- },
- "patch": {
- "request": {
- "$ref": "Application"
- },
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.default_cookie_expiration)",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "mask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}",
- "path": "v1beta4/apps/{appsId}",
- "id": "appengine.apps.patch"
- },
- "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/)."
- }
- },
"resources": {
+ "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": "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."
+ },
+ "get": {
+ "path": "v1beta4/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "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": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/operations/{operationsId}"
+ }
+ }
+ },
"locations": {
"methods": {
"list": {
@@ -105,18 +102,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": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
"appsId": {
"description": "Part of `name`. The resource that owns the locations collection, if applicable.",
"required": true,
@@ -127,19 +118,24 @@
"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": "v1beta4/apps/{appsId}/locations",
"path": "v1beta4/apps/{appsId}/locations",
"id": "appengine.apps.locations.list"
},
"get": {
- "description": "Get information about a location.",
"response": {
"$ref": "Location"
},
@@ -148,384 +144,37 @@
"locationsId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
"appsId": {
"location": "path",
"description": "Part of `name`. Resource name for the location.",
"required": true,
"type": "string"
- },
- "locationsId": {
- "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}/locations/{locationsId}",
"path": "v1beta4/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get"
+ "id": "appengine.apps.locations.get",
+ "description": "Get information about a location."
}
}
},
"modules": {
- "methods": {
- "get": {
- "description": "Gets the current configuration of the specified module.",
- "response": {
- "$ref": "Module"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
- "required": true,
- "type": "string"
- },
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.get"
- },
- "list": {
- "description": "Lists all the modules in the application.",
- "response": {
- "$ref": "ListModulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules",
- "path": "v1beta4/apps/{appsId}/modules",
- "id": "appengine.apps.modules.list"
- },
- "patch": {
- "request": {
- "$ref": "Module"
- },
- "description": "Updates the configuration of the specified module.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "migrateTraffic": {
- "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
- "type": "boolean",
- "location": "query"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "mask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.patch"
- },
- "delete": {
- "description": "Deletes the specified module and all enclosed versions.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.delete"
- }
- },
"resources": {
"versions": {
- "resources": {
- "instances": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "instancesId": {
- "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}",
- "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.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "parameters": {
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.modules.versions.instances.get",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}"
- },
- "list": {
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.modules.versions.instances.list",
- "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)."
- },
- "debug": {
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "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"
- }
- }
- }
- },
"methods": {
"get": {
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "id": "appengine.apps.modules.versions.get",
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
"response": {
"$ref": "Version"
},
@@ -535,41 +184,44 @@
"versionsId"
],
"httpMethod": "GET",
- "parameters": {
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "view": {
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
- "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}"
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "id": "appengine.apps.modules.versions.get",
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource."
},
"list": {
"response": {
@@ -580,11 +232,6 @@
"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.",
@@ -593,15 +240,15 @@
"location": "path"
},
"pageToken": {
+ "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
- "location": "query",
"description": "Maximum results to return per page.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"modulesId": {
"location": "path",
@@ -619,16 +266,21 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
"path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
"id": "appengine.apps.modules.versions.list",
"description": "Lists the versions of a module."
},
"patch": {
+ "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"
},
- "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.",
"response": {
"$ref": "Operation"
},
@@ -638,6 +290,9 @@
"versionsId"
],
"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/modules/default/versions/1.",
@@ -646,17 +301,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",
@@ -664,14 +319,14 @@
"location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
"path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
"id": "appengine.apps.modules.versions.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"
},
@@ -692,20 +347,18 @@
"type": "string"
},
"modulesId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "id": "appengine.apps.modules.versions.create"
+ ]
},
"delete": {
+ "description": "Deletes an existing version.",
"response": {
"$ref": "Operation"
},
@@ -715,15 +368,12 @@
"versionsId"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"modulesId": {
"description": "Part of `name`. See documentation of `appsId`.",
@@ -732,86 +382,311 @@
"location": "path"
},
"versionsId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "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."
+ "id": "appengine.apps.modules.versions.delete"
+ }
+ },
+ "resources": {
+ "instances": {
+ "methods": {
+ "get": {
+ "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": {
+ "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": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.modules.versions.instances.get",
+ "description": "Gets instance information."
+ },
+ "list": {
+ "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": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "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",
+ "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)."
+ },
+ "debug": {
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.modules.versions.instances.delete",
+ "description": "Stops a running instance.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "DELETE",
+ "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": {
+ "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"
+ }
+ }
+ }
+ }
}
}
}
- }
- },
- "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": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/operations",
- "path": "v1beta4/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list"
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "delete": {
+ "description": "Deletes the specified module and all enclosed versions.",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"appsId",
- "operationsId"
+ "modulesId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "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}",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "id": "appengine.apps.modules.delete"
+ },
+ "get": {
+ "description": "Gets the current configuration of the specified module.",
+ "response": {
+ "$ref": "Module"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
],
"httpMethod": "GET",
"parameters": {
"appsId": {
"location": "path",
- "description": "Part of `name`. The name of the operation resource.",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
"required": true,
"type": "string"
},
- "operationsId": {
- "location": "path",
+ "modulesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "id": "appengine.apps.modules.get"
+ },
+ "list": {
+ "id": "appengine.apps.modules.list",
+ "path": "v1beta4/apps/{appsId}/modules",
+ "description": "Lists all the modules in the application.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListModulesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
"type": "string"
}
},
@@ -820,36 +695,145 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1beta4/apps/{appsId}/operations/{operationsId}",
- "path": "v1beta4/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get"
+ "flatPath": "v1beta4/apps/{appsId}/modules"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
+ "required": true,
+ "type": "string"
+ },
+ "migrateTraffic": {
+ "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
+ "type": "boolean",
+ "location": "query"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "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"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "id": "appengine.apps.modules.patch",
+ "request": {
+ "$ref": "Module"
+ },
+ "description": "Updates the configuration of the specified module."
}
}
}
+ },
+ "methods": {
+ "create": {
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
+ "request": {
+ "$ref": "Application"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta4/apps",
+ "path": "v1beta4/apps",
+ "id": "appengine.apps.create"
+ },
+ "get": {
+ "flatPath": "v1beta4/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "path": "v1beta4/apps/{appsId}",
+ "description": "Gets information about an application.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Application"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "ensureResourcesExist": {
+ "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "request": {
+ "$ref": "Application"
+ },
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.default_cookie_expiration)",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "appsId": {
+ "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"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}",
+ "id": "appengine.apps.patch",
+ "path": "v1beta4/apps/{appsId}"
+ }
}
}
},
"parameters": {
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
"location": "query",
@@ -858,40 +842,34 @@
"default": "true"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
+ "$.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"
},
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
"alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
@@ -899,473 +877,48 @@
"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"
- },
- "access_token": {
- "description": "OAuth access token.",
"type": "string",
"location": "query"
},
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"schemas": {
- "UrlMap": {
- "properties": {
- "redirectHttpResponseCode": {
- "enum": [
- "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
- "REDIRECT_HTTP_RESPONSE_CODE_301",
- "REDIRECT_HTTP_RESPONSE_CODE_302",
- "REDIRECT_HTTP_RESPONSE_CODE_303",
- "REDIRECT_HTTP_RESPONSE_CODE_307"
- ],
- "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. 302 is assumed.",
- "301 Moved Permanently code.",
- "302 Moved Temporarily code.",
- "303 See Other code.",
- "307 Temporary Redirect code."
- ]
- },
- "securityLevel": {
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ]
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "script": {
- "$ref": "ScriptHandler",
- "description": "Executes a script to handle the request that matches this URL pattern."
- },
- "urlRegex": {
- "description": "A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
- "type": "string"
- },
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource.",
- "type": "string"
- },
- "apiEndpoint": {
- "$ref": "ApiEndpointHandler",
- "description": "Uses API Endpoints to handle requests."
- },
- "staticDirectory": {
- "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": {
- "$ref": "StaticFilesHandler",
- "description": "Returns the contents of a file, such as an image, as the response."
- }
- },
- "id": "UrlMap",
- "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
- "type": "object"
- },
- "EndpointsApiService": {
- "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
- "type": "object",
- "properties": {
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- },
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.",
- "type": "string"
- }
- },
- "id": "EndpointsApiService"
- },
- "Operation": {
- "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",
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object"
- },
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
- "properties": {
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- },
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource. Defaults to optional.",
- "type": "string"
- },
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
- },
- "securityLevel": {
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ]
- },
- "authFailAction": {
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ]
- }
- },
- "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": {
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- },
- "httpHeaders": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
- },
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
- "type": "string"
- },
- "path": {
- "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
- "expiration": {
- "description": "Time a static file served by this handler should be cached.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "StaticFilesHandler"
- },
- "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.",
- "type": "object",
- "properties": {
- "idleTimeout": {
- "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
- "format": "google-duration",
- "type": "string"
- },
- "maxInstances": {
- "description": "Maximum number of instances to create for this version.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "BasicScaling"
- },
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetReadBytesPerSec": {
- "description": "Target bytes read per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteOpsPerSec": {
- "description": "Target ops written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteBytesPerSec": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadOpsPerSec": {
- "description": "Target ops read per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DiskUtilization"
- },
- "CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "type": "object",
- "properties": {
- "aggregationWindowLength": {
- "description": "Period of time over which CPU utilization is calculated.",
- "format": "google-duration",
- "type": "string"
- },
- "targetUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "CpuUtilization"
- },
- "IdentityAwareProxy": {
- "description": "Identity-Aware Proxy",
- "type": "object",
- "properties": {
- "oauth2ClientSecretSha256": {
- "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
- "type": "string"
- },
- "enabled": {
- "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.",
- "type": "boolean"
- },
- "oauth2ClientSecret": {
- "description": "For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
- "type": "string"
- }
- },
- "id": "IdentityAwareProxy"
- },
- "Status": {
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status",
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
- },
- "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.",
- "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"
- },
- "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"
- },
- "CreateVersionMetadataV1Beta": {
- "properties": {
- "cloudBuildId": {
- "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
- "type": "string"
- }
- },
- "id": "CreateVersionMetadataV1Beta",
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
- "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",
@@ -1379,14 +932,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"
@@ -1401,11 +954,11 @@
"type": "string"
}
},
- "id": "OperationMetadataV1"
+ "id": "OperationMetadataV1",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
},
"ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object",
"properties": {
"errorCode": {
"enumDescriptions": [
@@ -1434,12 +987,28 @@
"type": "string"
}
},
- "id": "ErrorHandler"
+ "id": "ErrorHandler",
+ "description": "Custom static error page to be served when an error occurs.",
+ "type": "object"
},
"Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
"properties": {
+ "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": "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"
@@ -1466,25 +1035,11 @@
"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"
}
},
- "id": "Application"
+ "id": "Application",
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "type": "object"
},
"Network": {
"description": "Extra network settings. Only applicable for VM runtimes.",
@@ -1512,29 +1067,6 @@
"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": "uint32",
- "type": "integer"
- },
- "availability": {
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string"
- },
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
"requests": {
"description": "Number of requests since this instance was started.@OutputOnly",
"format": "int32",
@@ -1553,34 +1085,34 @@
"description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
"qps": {
"description": "Average queries per second (QPS) over the last minute.@OutputOnly",
"format": "float",
"type": "number"
},
- "vmUnlocked": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.@OutputOnly",
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
"vmZoneName": {
"description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmUnlocked": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
"averageLatency": {
"description": "Average latency (ms) over the last minute.@OutputOnly",
"format": "int32",
"type": "integer"
},
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
"memoryUsage": {
@@ -1588,15 +1120,45 @@
"format": "int64",
"type": "string"
},
- "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"
+ },
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "availability": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "description": "Availability of the instance.@OutputOnly",
"type": "string"
}
},
"id": "Instance"
},
"NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "type": "object",
"properties": {
+ "targetReceivedBytesPerSec": {
+ "description": "Target bytes received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
"targetSentPacketsPerSec": {
"description": "Target packets sent per second.",
"format": "int32",
@@ -1611,16 +1173,9 @@
"description": "Target packets received per second.",
"format": "int32",
"type": "integer"
- },
- "targetReceivedBytesPerSec": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
}
},
- "id": "NetworkUtilization",
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object"
+ "id": "NetworkUtilization"
},
"Location": {
"properties": {
@@ -1656,16 +1211,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": {
- "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",
@@ -1688,38 +1233,58 @@
"description": "Number of consecutive failed health checks required before an instance is restarted.",
"format": "uint32",
"type": "integer"
+ },
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "timeout": {
+ "description": "Time before the health check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
}
},
"id": "HealthCheck"
},
"SourceReference": {
+ "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
+ "type": "object",
"properties": {
- "repository": {
- "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
- "type": "string"
- },
"revisionId": {
"description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
"type": "string"
+ },
+ "repository": {
+ "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
+ "type": "string"
}
},
- "id": "SourceReference",
- "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
- "type": "object"
+ "id": "SourceReference"
},
"DebugInstanceRequest": {
- "description": "Request message for Instances.DebugInstance.",
- "type": "object",
"properties": {
"sshKey": {
"description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).",
"type": "string"
}
},
- "id": "DebugInstanceRequest"
+ "id": "DebugInstanceRequest",
+ "description": "Request message for Instances.DebugInstance.",
+ "type": "object"
},
"OperationMetadataV1Beta5": {
"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"
@@ -1731,16 +1296,6 @@
"method": {
"description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
"type": "string"
- },
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
}
},
"id": "OperationMetadataV1Beta5",
@@ -1762,90 +1317,9 @@
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a module.",
"type": "object",
"properties": {
- "libraries": {
- "description": "Configuration for third-party Python runtime libraries required by the application.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "Library"
- }
- },
- "nobuildFilesRegex": {
- "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
- "type": "string"
- },
- "creationTime": {
- "description": "Time that this version was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "basicScaling": {
- "description": "A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "$ref": "BasicScaling"
- },
- "runtime": {
- "description": "Desired runtime. Example: python27.",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
- "type": "string"
- },
- "envVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object"
- },
- "network": {
- "$ref": "Network",
- "description": "Extra network settings. Only applicable for VM runtimes."
- },
- "betaSettings": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
- "type": "object"
- },
- "env": {
- "description": "App Engine execution environment to use for this version.Defaults to 1.",
- "type": "string"
- },
- "handlers": {
- "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "UrlMap"
- }
- },
- "deployer": {
- "description": "Email address of the user who created this version.@OutputOnly",
- "type": "string"
- },
- "automaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "$ref": "AutomaticScaling"
- },
- "healthCheck": {
- "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.",
- "$ref": "HealthCheck"
- },
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
- },
- "manualScaling": {
- "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "$ref": "ManualScaling"
- },
- "name": {
- "description": "Full path to the Version resource in the API. Example: apps/myapp/modules/default/versions/v1.@OutputOnly",
- "type": "string"
- },
"apiConfig": {
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
- "$ref": "ApiConfigHandler"
+ "$ref": "ApiConfigHandler",
+ "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
},
"endpointsApiService": {
"$ref": "EndpointsApiService",
@@ -1925,20 +1399,101 @@
"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 module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
+ },
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
+ "type": "string"
+ },
+ "envVariables": {
+ "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "$ref": "Network"
+ },
+ "betaSettings": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object"
+ },
+ "env": {
+ "description": "App Engine execution environment to use for this version.Defaults to 1.",
+ "type": "string"
+ },
+ "handlers": {
+ "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
+ "type": "array",
+ "items": {
+ "$ref": "UrlMap"
+ }
+ },
+ "deployer": {
+ "description": "Email address of the user who created this version.@OutputOnly",
+ "type": "string"
+ },
+ "automaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "$ref": "AutomaticScaling"
+ },
+ "healthCheck": {
+ "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.",
+ "$ref": "HealthCheck"
+ },
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
+ },
+ "manualScaling": {
+ "$ref": "ManualScaling",
+ "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
+ },
+ "name": {
+ "description": "Full path to the Version resource in the API. Example: apps/myapp/modules/default/versions/v1.@OutputOnly",
+ "type": "string"
}
},
"id": "Version"
},
"ScriptHandler": {
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "type": "object",
"properties": {
"scriptPath": {
"description": "Path to the script from the application root directory.",
"type": "string"
}
},
- "id": "ScriptHandler",
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "type": "object"
+ "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.",
@@ -1960,6 +1515,8 @@
"id": "FileInfo"
},
"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": {
"enumDescriptions": [
@@ -1984,14 +1541,24 @@
"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"
+ "id": "TrafficSplit"
},
"OperationMetadataV1Beta": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
"method": {
"description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
"type": "string"
@@ -2015,18 +1582,6 @@
"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"
}
},
"id": "OperationMetadataV1Beta"
@@ -2053,6 +1608,16 @@
"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",
@@ -2064,16 +1629,6 @@
"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"
@@ -2082,9 +1637,16 @@
"description": "Code and application artifacts used to deploy a version to App Engine.",
"type": "object",
"properties": {
+ "files": {
+ "additionalProperties": {
+ "$ref": "FileInfo"
+ },
+ "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
+ "type": "object"
+ },
"container": {
- "$ref": "ContainerInfo",
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
+ "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.",
@@ -2092,13 +1654,6 @@
"items": {
"$ref": "SourceReference"
}
- },
- "files": {
- "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
- "type": "object",
- "additionalProperties": {
- "$ref": "FileInfo"
- }
}
},
"id": "Deployment"
@@ -2107,6 +1662,10 @@
"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",
@@ -2115,10 +1674,6 @@
"name": {
"description": "Unique name for the volume.",
"type": "string"
- },
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
}
},
"id": "Volume"
@@ -2145,6 +1700,30 @@
"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"
+ },
+ "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.v1alpha.Versions.CreateVersion.@OutputOnly",
"type": "string"
@@ -2156,37 +1735,11 @@
},
"createVersionMetadata": {
"$ref": "CreateVersionMetadataV1Alpha"
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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"
},
"UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a module.",
- "type": "object",
"properties": {
"domain": {
"description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
@@ -2201,7 +1754,9 @@
"type": "string"
}
},
- "id": "UrlDispatchRule"
+ "id": "UrlDispatchRule",
+ "description": "Rules to match an HTTP request and dispatch that request to a module.",
+ "type": "object"
},
"ListVersionsResponse": {
"description": "Response message for Versions.ListVersions.",
@@ -2226,8 +1781,8 @@
"type": "object",
"properties": {
"split": {
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the module.",
- "$ref": "TrafficSplit"
+ "$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",
@@ -2252,45 +1807,10 @@
"id": "ApiEndpointHandler"
},
"AutomaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object",
"properties": {
- "maxTotalInstances": {
- "description": "Maximum number of instances that should be started to handle requests.",
- "format": "int32",
- "type": "integer"
- },
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "networkUtilization": {
- "$ref": "NetworkUtilization",
- "description": "Target scaling by network usage."
- },
- "maxConcurrentRequests": {
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "format": "int32",
- "type": "integer"
- },
- "coolDownPeriod": {
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
- "format": "google-duration",
- "type": "string"
- },
- "maxPendingLatency": {
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
- },
"diskUtilization": {
- "description": "Target scaling by disk usage.",
- "$ref": "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.",
@@ -2310,18 +1830,49 @@
"description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
"format": "int32",
"type": "integer"
+ },
+ "maxTotalInstances": {
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "description": "Target scaling by network usage.",
+ "$ref": "NetworkUtilization"
+ },
+ "maxConcurrentRequests": {
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "coolDownPeriod": {
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxPendingLatency": {
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
}
},
- "id": "AutomaticScaling"
+ "id": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "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": {
- "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"
@@ -2335,23 +1886,25 @@
"format": "google-duration",
"type": "string"
},
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- },
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "HTTP headers to use for all responses from these URLs.",
"type": "object"
+ },
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
+ },
+ "directory": {
+ "description": "Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to static_dir to form the full path to the requested file.",
+ "type": "string"
}
},
"id": "StaticDirectoryHandler"
},
"Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object",
"properties": {
"name": {
"description": "Name of the library. Example: \"django\".",
@@ -2362,22 +1915,24 @@
"type": "string"
}
},
- "id": "Library"
+ "id": "Library",
+ "description": "Third-party Python runtime library that is required by the application.",
+ "type": "object"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Location"
}
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
}
},
"id": "ListLocationsResponse"
@@ -2409,32 +1964,477 @@
}
},
"id": "RequestUtilization"
+ },
+ "UrlMap": {
+ "properties": {
+ "securityLevel": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string"
+ },
+ "authFailAction": {
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ]
+ },
+ "script": {
+ "description": "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",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "description": "Level of login required to access this resource.",
+ "type": "string"
+ },
+ "apiEndpoint": {
+ "description": "Uses API Endpoints to handle requests.",
+ "$ref": "ApiEndpointHandler"
+ },
+ "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."
+ ]
+ }
+ },
+ "id": "UrlMap",
+ "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
+ "type": "object"
+ },
+ "EndpointsApiService": {
+ "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "type": "string"
+ },
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.",
+ "type": "string"
+ }
+ },
+ "id": "EndpointsApiService"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "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"
+ },
+ "ApiConfigHandler": {
+ "properties": {
+ "login": {
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ]
+ },
+ "url": {
+ "description": "URL to serve the endpoint at.",
+ "type": "string"
+ },
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ]
+ },
+ "authFailAction": {
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ]
+ },
+ "script": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ApiConfigHandler",
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "type": "object"
+ },
+ "StaticFilesHandler": {
+ "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
+ "type": "object",
+ "properties": {
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
+ },
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
+ },
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
+ "type": "string"
+ },
+ "path": {
+ "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ }
+ },
+ "id": "StaticFilesHandler"
+ },
+ "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.",
+ "type": "object",
+ "properties": {
+ "idleTimeout": {
+ "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxInstances": {
+ "description": "Maximum number of instances to create for this version.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "BasicScaling"
+ },
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetReadOpsPerSec": {
+ "description": "Target ops read per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReadBytesPerSec": {
+ "description": "Target bytes read per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteOpsPerSec": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSec": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DiskUtilization"
+ },
+ "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": {
+ "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": {
+ "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"
+ },
+ "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.",
+ "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"
+ },
+ "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"
+ },
+ "CreateVersionMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
+ "type": "object",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "CreateVersionMetadataV1Beta"
}
},
- "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": "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"
+ },
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
}
}
}
},
- "servicePath": "",
- "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"kind": "discovery#restDescription",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "servicePath": "",
"rootUrl": "https://appengine.googleapis.com/"
}
diff --git a/appengine/v1beta5/appengine-api.json b/appengine/v1beta5/appengine-api.json
index 1188a19..83f15da 100644
--- a/appengine/v1beta5/appengine-api.json
+++ b/appengine/v1beta5/appengine-api.json
@@ -1,26 +1,39 @@
{
+ "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": "20180118",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "id": "appengine:v1beta5",
+ "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": "v1beta5/apps",
- "path": "v1beta5/apps",
- "id": "appengine.apps.create",
- "request": {
- "$ref": "Application"
- },
- "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/)."
- },
"get": {
+ "path": "v1beta5/apps/{appsId}",
+ "id": "appengine.apps.get",
"description": "Gets information about an application.",
"response": {
"$ref": "Application"
@@ -45,15 +58,13 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta5/apps/{appsId}",
- "path": "v1beta5/apps/{appsId}",
- "id": "appengine.apps.get"
+ "flatPath": "v1beta5/apps/{appsId}"
},
"patch": {
- "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"
},
+ "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"
},
@@ -61,33 +72,50 @@
"appsId"
],
"httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
"mask": {
"location": "query",
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
"type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta5/apps/{appsId}",
"path": "v1beta5/apps/{appsId}",
"id": "appengine.apps.patch"
+ },
+ "create": {
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
+ "request": {
+ "$ref": "Application"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta5/apps",
+ "path": "v1beta5/apps",
+ "id": "appengine.apps.create"
}
},
"resources": {
"locations": {
"methods": {
"list": {
- "description": "Lists information about the supported locations for this service.",
"response": {
"$ref": "ListLocationsResponse"
},
@@ -97,26 +125,26 @@
"httpMethod": "GET",
"parameters": {
"filter": {
+ "location": "query",
"description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "required": true,
"type": "string"
},
- "pageToken": {
- "description": "The standard list page token.",
+ "appsId": {
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "required": true,
"type": "string",
- "location": "query"
+ "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"
+ "type": "integer",
+ "location": "query"
}
},
"scopes": [
@@ -126,10 +154,10 @@
],
"flatPath": "v1beta5/apps/{appsId}/locations",
"path": "v1beta5/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list"
+ "id": "appengine.apps.locations.list",
+ "description": "Lists information about the supported locations for this service."
},
"get": {
- "description": "Get information about a location.",
"response": {
"$ref": "Location"
},
@@ -139,17 +167,17 @@
],
"httpMethod": "GET",
"parameters": {
- "locationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"appsId": {
"location": "path",
"description": "Part of `name`. Resource name for the location.",
"required": true,
"type": "string"
+ },
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
}
},
"scopes": [
@@ -159,14 +187,14 @@
],
"flatPath": "v1beta5/apps/{appsId}/locations/{locationsId}",
"path": "v1beta5/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get"
+ "id": "appengine.apps.locations.get",
+ "description": "Get information about a location."
}
}
},
"services": {
"methods": {
"delete": {
- "description": "Deletes the specified service and all enclosed versions.",
"response": {
"$ref": "Operation"
},
@@ -175,28 +203,32 @@
"servicesId"
],
"httpMethod": "DELETE",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/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"
- }
- },
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
"path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.delete"
+ "id": "appengine.apps.services.delete",
+ "description": "Deletes the specified service and all enclosed versions."
},
"get": {
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.get",
"description": "Gets the current configuration of the specified service.",
"response": {
"$ref": "Service"
@@ -224,30 +256,33 @@
"required": true,
"type": "string"
}
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.get"
+ }
},
"list": {
- "httpMethod": "GET",
+ "description": "Lists all the services in the application.",
"response": {
"$ref": "ListServicesResponse"
},
"parameterOrder": [
"appsId"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"pageToken": {
- "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -256,32 +291,26 @@
"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",
- "id": "appengine.apps.services.list",
"path": "v1beta5/apps/{appsId}/services",
- "description": "Lists all the services in the application."
+ "id": "appengine.apps.services.list"
},
"patch": {
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "description": "Updates the configuration of the specified service.",
"request": {
"$ref": "Service"
},
- "description": "Updates the configuration of the specified service.",
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"servicesId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"servicesId": {
"location": "path",
@@ -290,15 +319,15 @@
"type": "string"
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
"required": true,
- "type": "string",
- "location": "path"
+ "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/v1beta5/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"mask": {
"description": "Standard field mask for the set of fields to be updated.",
@@ -307,17 +336,15 @@
"location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.patch"
}
},
"resources": {
"versions": {
"methods": {
"delete": {
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete",
"description": "Deletes an existing version.",
"response": {
"$ref": "Operation"
@@ -333,17 +360,17 @@
],
"parameters": {
"servicesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
"type": "string",
"location": "path"
},
+ "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,
@@ -351,10 +378,11 @@
"location": "path"
}
},
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.delete"
},
"get": {
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
"response": {
"$ref": "Version"
},
@@ -365,12 +393,6 @@
],
"httpMethod": "GET",
"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.",
@@ -378,19 +400,25 @@
"type": "string"
},
"versionsId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"view": {
+ "location": "query",
"enum": [
"BASIC",
"FULL"
],
"description": "Controls the set of fields returned in the Get response.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
}
},
"scopes": [
@@ -400,11 +428,10 @@
],
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
"path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get"
+ "id": "appengine.apps.services.versions.get",
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource."
},
"list": {
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list",
"description": "Lists the versions of a service.",
"response": {
"$ref": "ListVersionsResponse"
@@ -421,10 +448,10 @@
],
"parameters": {
"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"
},
"pageToken": {
"location": "query",
@@ -432,10 +459,10 @@
"type": "string"
},
"pageSize": {
- "location": "query",
"description": "Maximum results to return per page.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"view": {
"location": "query",
@@ -447,19 +474,24 @@
"type": "string"
},
"servicesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions"
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.list"
},
"patch": {
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.patch",
+ "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
"request": {
"$ref": "Version"
},
- "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"
},
@@ -469,55 +501,45 @@
"versionsId"
],
"httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
"required": true,
- "type": "string"
- },
- "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",
"type": "string",
"location": "query"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch"
+ }
},
"create": {
- "description": "Deploys new code and resource files to a new version.",
- "request": {
- "$ref": "Version"
- },
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"appsId",
"servicesId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
@@ -526,84 +548,45 @@
"location": "path"
},
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/services/default\".",
"required": true,
- "type": "string"
+ "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"
+ },
+ "description": "Deploys new code and resource files to a new version."
}
},
"resources": {
"instances": {
"methods": {
- "delete": {
- "description": "Stops a running instance.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/services/default/versions/v1/instances/instance-1\".",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "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"
- },
"get": {
"description": "Gets instance information.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
"response": {
"$ref": "Instance"
},
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
- "versionsId": {
- "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`.",
@@ -621,18 +604,21 @@
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.get",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.get"
},
"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",
"response": {
"$ref": "ListInstancesResponse"
},
@@ -641,14 +627,7 @@
"servicesId",
"versionsId"
],
- "httpMethod": "GET",
"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.",
@@ -656,17 +635,23 @@
"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",
+ "type": "string",
"location": "query"
},
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
"versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "servicesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
@@ -679,17 +664,10 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
"id": "appengine.apps.services.versions.instances.list",
- "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)."
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances"
},
"debug": {
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
- "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"
},
@@ -717,10 +695,10 @@
"location": "path"
},
"instancesId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"versionsId": {
"location": "path",
@@ -729,7 +707,58 @@
"type": "string"
}
},
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug"
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.services.versions.instances.debug",
+ "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"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. For 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"
+ }
+ },
+ "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."
}
}
}
@@ -740,49 +769,49 @@
"operations": {
"methods": {
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
"response": {
"$ref": "ListOperationsResponse"
},
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
"flatPath": "v1beta5/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
"path": "v1beta5/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": {
- "httpMethod": "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"
},
@@ -790,29 +819,29 @@
"appsId",
"operationsId"
],
- "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"
- }
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ },
+ "operationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
"flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
"path": "v1beta5/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."
+ "id": "appengine.apps.operations.get"
}
}
}
@@ -820,37 +849,16 @@
}
},
"parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
@@ -863,22 +871,22 @@
"type": "string"
},
"$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"alt": {
"enum": [
@@ -902,27 +910,426 @@
"location": "query"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
"location": "query"
}
},
"schemas": {
+ "OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Alpha"
+ }
+ },
+ "id": "OperationMetadataV1Alpha"
+ },
+ "Network": {
+ "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": {
+ "codeBucket": {
+ "description": "A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "type": "string"
+ },
+ "location": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
+ "type": "string"
+ },
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ }
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "Application"
+ },
+ "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"
+ },
+ "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",
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "type": "object"
+ },
+ "Instance": {
+ "properties": {
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "qps": {
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "format": "float",
+ "type": "number"
+ },
+ "vmUnlocked": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "averageLatency": {
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "memoryUsage": {
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "format": "int64",
+ "type": "string"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "availability": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "description": "Availability of the instance.@OutputOnly",
+ "type": "string"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "requests": {
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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",
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "type": "object"
+ },
+ "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"
+ },
+ "ApiEndpointHandler": {
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "type": "object",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ApiEndpointHandler"
+ },
+ "AutomaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "type": "object",
+ "properties": {
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
+ },
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "requestUtilization": {
+ "description": "Target scaling by request utilization.",
+ "$ref": "RequestUtilization"
+ },
+ "maxIdleInstances": {
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minIdleInstances": {
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxTotalInstances": {
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "maxConcurrentRequests": {
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "coolDownPeriod": {
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxPendingLatency": {
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
+ }
+ },
+ "id": "AutomaticScaling"
+ },
+ "NetworkUtilization": {
+ "properties": {
+ "targetReceivedBytesPerSec": {
+ "description": "Target bytes received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSec": {
+ "description": "Target packets sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentBytesPerSec": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSec": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "NetworkUtilization",
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "type": "object"
+ },
+ "Location": {
+ "properties": {
+ "locationId": {
+ "description": "The canonical id for this location. For example: \"us-east1\".",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object"
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
+ "type": "string"
+ }
+ },
+ "id": "Location",
+ "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.",
+ "type": "boolean"
+ },
"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.",
+ "restartThreshold": {
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
"format": "uint32",
"type": "integer"
},
- "restartThreshold": {
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "healthyThreshold": {
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
"format": "uint32",
"type": "integer"
},
@@ -940,25 +1347,10 @@
"description": "Number of consecutive failed health checks required before removing traffic.",
"format": "uint32",
"type": "integer"
- },
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
}
},
"id": "HealthCheck"
},
- "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"
- },
"SourceReference": {
"description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
"type": "object",
@@ -974,6 +1366,17 @@
},
"id": "SourceReference"
},
+ "DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "type": "object",
+ "properties": {
+ "sshKey": {
+ "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).",
+ "type": "string"
+ }
+ },
+ "id": "DebugInstanceRequest"
+ },
"Library": {
"description": "Third-party Python runtime library that is required by the application.",
"type": "object",
@@ -990,6 +1393,8 @@
"id": "Library"
},
"OperationMetadataV1Beta5": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
"properties": {
"insertTime": {
"description": "Timestamp that this operation was created.@OutputOnly",
@@ -1014,35 +1419,33 @@
"type": "string"
}
},
- "id": "OperationMetadataV1Beta5",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "id": "OperationMetadataV1Beta5"
},
"CreateVersionMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
+ "type": "object",
"properties": {
"cloudBuildId": {
"description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
"type": "string"
}
},
- "id": "CreateVersionMetadataV1Alpha",
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
- "type": "object"
+ "id": "CreateVersionMetadataV1Alpha"
},
"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"
@@ -1063,15 +1466,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": {
"$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."
@@ -1092,8 +1495,8 @@
"type": "object"
},
"network": {
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "$ref": "Network"
+ "$ref": "Network",
+ "description": "Extra network settings. Only applicable for VM runtimes."
},
"betaSettings": {
"additionalProperties": {
@@ -1118,8 +1521,8 @@
"type": "string"
},
"automaticScaling": {
- "$ref": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "$ref": "AutomaticScaling"
},
"diskUsageBytes": {
"description": "Total size of version files hosted on App Engine disk in bytes.@OutputOnly",
@@ -1127,24 +1530,24 @@
"type": "string"
},
"healthCheck": {
- "description": "Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.",
- "$ref": "HealthCheck"
+ "$ref": "HealthCheck",
+ "description": "Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
},
"threadsafe": {
"description": "Whether multiple requests can be dispatched to this version at once.",
"type": "boolean"
},
"manualScaling": {
- "$ref": "ManualScaling",
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
+ "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."
+ "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",
@@ -1159,8 +1562,6 @@
"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.",
@@ -1170,25 +1571,22 @@
"SERVING_STATUS_UNSPECIFIED",
"SERVING",
"STOPPED"
- ]
- },
- "deployment": {
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
- "$ref": "Deployment"
+ ],
+ "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"
},
- "resources": {
- "description": "Machine resources for this version. Only applicable for VM runtimes.",
- "$ref": "Resources"
+ "deployment": {
+ "$ref": "Deployment",
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
},
"inboundServices": {
"description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
"type": "array",
"items": {
- "type": "string",
"enum": [
"INBOUND_SERVICE_UNSPECIFIED",
"INBOUND_SERVICE_MAIL",
@@ -1199,7 +1597,8 @@
"INBOUND_SERVICE_XMPP_PRESENCE",
"INBOUND_SERVICE_CHANNEL_PRESENCE",
"INBOUND_SERVICE_WARMUP"
- ]
+ ],
+ "type": "string"
},
"enumDescriptions": [
"Not specified.",
@@ -1213,6 +1612,10 @@
"Enables warmup requests."
]
},
+ "resources": {
+ "description": "Machine resources for this version. Only applicable for VM runtimes.",
+ "$ref": "Resources"
+ },
"errorHandlers": {
"description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
"type": "array",
@@ -1224,19 +1627,17 @@
"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\"",
"type": "string"
}
},
- "id": "ContainerInfo"
+ "id": "ContainerInfo",
+ "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
+ "type": "object"
},
"RequestUtilization": {
- "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
- "type": "object",
"properties": {
"targetRequestCountPerSec": {
"description": "Target requests per second.",
@@ -1249,12 +1650,22 @@
"type": "integer"
}
},
- "id": "RequestUtilization"
+ "id": "RequestUtilization",
+ "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
+ "type": "object"
},
"UrlMap": {
"description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
"type": "object",
"properties": {
+ "apiEndpoint": {
+ "description": "Uses API Endpoints to handle requests.",
+ "$ref": "ApiEndpointHandler"
+ },
+ "staticFiles": {
+ "description": "Returns the contents of a file, such as an image, as the response.",
+ "$ref": "StaticFilesHandler"
+ },
"redirectHttpResponseCode": {
"enum": [
"REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
@@ -1274,6 +1685,13 @@
]
},
"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",
@@ -1282,14 +1700,7 @@
"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."
- ]
+ "type": "string"
},
"authFailAction": {
"enumDescriptions": [
@@ -1328,21 +1739,11 @@
],
"description": "Level of login required to access this resource.",
"type": "string"
- },
- "apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
- },
- "staticFiles": {
- "description": "Returns the contents of a file, such as an image, as the response.",
- "$ref": "StaticFilesHandler"
}
},
"id": "UrlMap"
},
"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\"",
@@ -1353,24 +1754,14 @@
"type": "string"
}
},
- "id": "EndpointsApiService"
+ "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": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
- },
"done": {
"description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
"type": "boolean"
@@ -1386,18 +1777,24 @@
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
"type": "string"
+ },
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
}
},
"id": "Operation"
},
"ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
"properties": {
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- },
"login": {
"enumDescriptions": [
"Not specified. LOGIN_OPTIONAL is assumed.",
@@ -1419,13 +1816,6 @@
"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",
@@ -1434,11 +1824,16 @@
"SECURE_ALWAYS"
],
"description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ]
},
"authFailAction": {
- "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.",
@@ -1448,60 +1843,18 @@
"AUTH_FAIL_ACTION_UNSPECIFIED",
"AUTH_FAIL_ACTION_REDIRECT",
"AUTH_FAIL_ACTION_UNAUTHORIZED"
- ]
- }
- },
- "id": "ApiConfigHandler"
- },
- "ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "type": "object",
- "properties": {
- "scriptPath": {
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string"
+ },
+ "script": {
"description": "Path to the script from the application root directory.",
"type": "string"
}
},
- "id": "ScriptHandler"
- },
- "StaticFilesHandler": {
- "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
- "type": "object",
- "properties": {
- "expiration": {
- "description": "Time a static file served by this handler should be cached.",
- "format": "google-duration",
- "type": "string"
- },
- "httpHeaders": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
- },
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- },
- "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"
+ "id": "ApiConfigHandler",
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "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.",
@@ -1522,26 +1875,57 @@
},
"id": "FileInfo"
},
- "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.",
+ "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": {
- "maxInstances": {
- "description": "Maximum number of instances to create for this version.",
- "format": "int32",
- "type": "integer"
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
},
- "idleTimeout": {
- "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
+ },
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
+ "type": "string"
+ },
+ "path": {
+ "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached.",
"format": "google-duration",
"type": "string"
}
},
- "id": "BasicScaling"
+ "id": "StaticFilesHandler"
+ },
+ "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"
},
"DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "type": "object",
"properties": {
"targetReadBytesPerSec": {
"description": "Target bytes read per second.",
@@ -1564,7 +1948,26 @@
"type": "integer"
}
},
- "id": "DiskUtilization"
+ "id": "DiskUtilization",
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "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"
},
"CpuUtilization": {
"description": "Target scaling by CPU usage.",
@@ -1584,9 +1987,11 @@
"id": "CpuUtilization"
},
"Status": {
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
"properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"type": "array",
@@ -1602,26 +2007,14 @@
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
}
},
- "id": "Status"
+ "id": "Status",
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
},
"IdentityAwareProxy": {
- "description": "Identity-Aware Proxy",
- "type": "object",
"properties": {
- "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"
@@ -1629,9 +2022,19 @@
"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"
+ "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.",
@@ -1664,12 +2067,12 @@
"type": "string"
},
"allocations": {
- "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
- "type": "object",
"additionalProperties": {
"format": "double",
"type": "number"
- }
+ },
+ "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object"
}
},
"id": "TrafficSplit"
@@ -1678,13 +2081,13 @@
"description": "Metadata for the given google.cloud.location.Location.",
"type": "object",
"properties": {
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
"standardEnvironmentAvailable": {
"description": "App Engine Standard Environment is available in the given location.@OutputOnly",
"type": "boolean"
+ },
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
}
},
"id": "LocationMetadata"
@@ -1693,9 +2096,6 @@
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Beta"
- },
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"type": "array",
@@ -1708,14 +2108,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"
@@ -1728,6 +2128,9 @@
"description": "Time that this operation completed.@OutputOnly",
"format": "google-datetime",
"type": "string"
+ },
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Beta"
}
},
"id": "OperationMetadataV1Beta"
@@ -1808,22 +2211,24 @@
"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."
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
+ "$ref": "TrafficSplit"
+ },
+ "id": {
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly",
+ "type": "string"
}
},
"id": "Service"
},
"Volume": {
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "type": "object",
"properties": {
"sizeGb": {
"description": "Volume size in gigabytes.",
@@ -1839,11 +2244,11 @@
"type": "string"
}
},
- "id": "Volume",
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "type": "object"
+ "id": "Volume"
},
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -1857,23 +2262,10 @@
}
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
+ "id": "ListOperationsResponse"
},
"OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
"properties": {
- "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"
@@ -1890,9 +2282,20 @@
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "OperationMetadata"
+ "id": "OperationMetadata",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
},
"CreateVersionMetadataV1Beta": {
"description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
@@ -1906,8 +2309,6 @@
"id": "CreateVersionMetadataV1Beta"
},
"ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "Continuation token for fetching the next page of results.",
@@ -1921,45 +2322,32 @@
}
}
},
- "id": "ListInstancesResponse"
- },
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object",
- "properties": {
- "errorCode": {
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
- ],
- "description": "Error condition this handler applies to.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
- ]
- },
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- },
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "id": "ErrorHandler"
+ "id": "ListInstancesResponse",
+ "description": "Response message for Instances.ListInstances.",
+ "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"
+ },
+ "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"
@@ -1972,439 +2360,51 @@
"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"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
}
},
- "id": "OperationMetadataV1"
- },
- "OperationMetadataV1Alpha": {
+ "id": "OperationMetadataV1",
"description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Alpha"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Alpha"
- },
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
- "properties": {
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
- "format": "google-duration",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
- },
- "codeBucket": {
- "description": "A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
- "type": "string"
- },
- "location": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
- "defaultBucket": {
- "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "UrlDispatchRule"
- }
- },
- "defaultHostname": {
- "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Application"
- },
- "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"
},
- "Instance": {
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "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"
- },
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "qps": {
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "format": "float",
- "type": "number"
- },
- "vmUnlocked": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "averageLatency": {
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
- "type": "string"
- },
- "memoryUsage": {
- "description": "Total memory in use (bytes).@OutputOnly",
- "format": "int64",
- "type": "string"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "uint32",
- "type": "integer"
- },
- "availability": {
+ "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": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
],
- "description": "Availability of the instance.@OutputOnly",
+ "description": "Error condition this handler applies to.",
"type": "string"
},
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "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": "Instance",
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object"
- },
- "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"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler"
- },
- "AutomaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object",
- "properties": {
- "diskUtilization": {
- "description": "Target scaling by disk usage.",
- "$ref": "DiskUtilization"
- },
- "minPendingLatency": {
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "requestUtilization": {
- "$ref": "RequestUtilization",
- "description": "Target scaling by request utilization."
- },
- "maxIdleInstances": {
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "minIdleInstances": {
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
- "format": "int32",
- "type": "integer"
- },
- "maxTotalInstances": {
- "description": "Maximum number of instances that should be started to handle requests.",
- "format": "int32",
- "type": "integer"
- },
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "networkUtilization": {
- "description": "Target scaling by network usage.",
- "$ref": "NetworkUtilization"
- },
- "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"
- }
- },
- "id": "AutomaticScaling"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object"
- }
- },
- "id": "Location"
- },
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetReceivedBytesPerSec": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentPacketsPerSec": {
- "description": "Target packets sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentBytesPerSec": {
- "description": "Target bytes sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedPacketsPerSec": {
- "description": "Target packets received per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "NetworkUtilization"
+ "id": "ErrorHandler"
}
},
- "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.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"
- }
- }
- }
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "kind": "discovery#restDescription",
- "description": "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": "20180118",
- "id": "appengine:v1beta5",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "title": "Google App Engine Admin API",
- "discoveryVersion": "v1",
- "ownerName": "Google"
+ "version": "v1beta5",
+ "baseUrl": "https://appengine.googleapis.com/"
}
diff --git a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
index 3cb7464..5444a2f 100644
--- a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
+++ b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
@@ -1,1242 +1,12 @@
{
- "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",
- "fullyEncodeReservedExpansion": true,
- "title": "BigQuery Data Transfer API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "methods": {
- "list": {
- "path": "v1/{+name}/locations",
- "id": "bigquerydatatransfer.projects.locations.list",
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "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/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations"
- },
- "get": {
- "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}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.get",
- "description": "Get information about a location."
- }
- },
- "resources": {
- "dataSources": {
- "methods": {
- "get": {
- "response": {
- "$ref": "DataSource"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.dataSources.get",
- "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering."
- },
- "list": {
- "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
- "response": {
- "$ref": "ListDataSourcesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "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"
- },
- "pageSize": {
- "location": "query",
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources",
- "path": "v1/{+parent}/dataSources",
- "id": "bigquerydatatransfer.projects.locations.dataSources.list"
- },
- "checkValidCreds": {
- "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds",
- "path": "v1/{+name}: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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CheckValidCredsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds"
- }
- }
- },
- "transferConfigs": {
- "methods": {
- "delete": {
- "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete"
- },
- "list": {
- "response": {
- "$ref": "ListTransferConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "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",
- "path": "v1/{+parent}/transferConfigs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
- "description": "Returns information about all data transfers in the project."
- },
- "create": {
- "response": {
- "$ref": "TransferConfig"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "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"
- },
- "authorizationCode": {
- "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/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"
- },
- "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",
- "request": {
- "$ref": "ScheduleTransferRunsRequest"
- },
- "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range."
- },
- "get": {
- "description": "Returns information about a data transfer config.",
- "response": {
- "$ref": "TransferConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.get"
- },
- "patch": {
- "request": {
- "$ref": "TransferConfig"
- },
- "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "TransferConfig"
- },
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
- },
- "authorizationCode": {
- "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\nauthorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
- "type": "string",
- "location": "query"
- }
- },
- "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}"
- }
- },
- "resources": {
- "runs": {
- "resources": {
- "transferLogs": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListTransferLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "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": {
- "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."
- }
- }
- }
- },
- "methods": {
- "delete": {
- "description": "Deletes the specified transfer run.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete"
- },
- "get": {
- "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/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get",
- "description": "Returns information about the particular transfer run."
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListTransferRunsResponse"
- },
- "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": {
- "location": "query",
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer"
- },
- "runAttempt": {
- "location": "query",
- "enum": [
- "RUN_ATTEMPT_UNSPECIFIED",
- "LATEST"
- ],
- "description": "Indicates how run attempts are to be pulled.",
- "type": "string"
- },
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path",
- "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list",
- "path": "v1/{+parent}/runs",
- "description": "Returns information about running and completed jobs."
- }
- }
- }
- }
- }
- }
- },
- "dataSources": {
- "methods": {
- "get": {
- "response": {
- "$ref": "DataSource"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.dataSources.get",
- "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering."
- },
- "list": {
- "response": {
- "$ref": "ListDataSourcesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "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.",
- "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"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/dataSources",
- "path": "v1/{+parent}/dataSources",
- "id": "bigquerydatatransfer.projects.dataSources.list",
- "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering."
- },
- "checkValidCreds": {
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds"
- }
- }
- },
- "transferConfigs": {
- "resources": {
- "runs": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete",
- "description": "Deletes the specified transfer run."
- },
- "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}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.get"
- },
- "list": {
- "response": {
- "$ref": "ListTransferRunsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "runAttempt": {
- "enum": [
- "RUN_ATTEMPT_UNSPECIFIED",
- "LATEST"
- ],
- "description": "Indicates how run attempts are to be pulled.",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
- "location": "path",
- "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs",
- "path": "v1/{+parent}/runs",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
- "description": "Returns information about running and completed jobs."
- }
- },
- "resources": {
- "transferLogs": {
- "methods": {
- "list": {
- "description": "Returns user facing log messages for the data transfer run.",
- "response": {
- "$ref": "ListTransferLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
- "path": "v1/{+parent}/transferLogs",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list"
- }
- }
- }
- }
- }
- },
- "methods": {
- "create": {
- "response": {
- "$ref": "TransferConfig"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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",
- "description": "Creates a new data transfer configuration.",
- "request": {
- "$ref": "TransferConfig"
- }
- },
- "scheduleRuns": {
- "path": "v1/{+parent}:scheduleRuns",
- "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns",
- "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
- "request": {
- "$ref": "ScheduleTransferRunsRequest"
- },
- "response": {
- "$ref": "ScheduleTransferRunsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "TransferConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "id": "bigquerydatatransfer.projects.transferConfigs.get",
- "path": "v1/{+name}",
- "description": "Returns information about a data transfer config."
- },
- "patch": {
- "response": {
- "$ref": "TransferConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
- "location": "path",
- "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
- "required": true,
- "type": "string"
- },
- "authorizationCode": {
- "location": "query",
- "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\nauthorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.patch",
- "request": {
- "$ref": "TransferConfig"
- },
- "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated."
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.delete",
- "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs."
- },
- "list": {
- "path": "v1/{+parent}/transferConfigs",
- "id": "bigquerydatatransfer.projects.transferConfigs.list",
- "description": "Returns information about all data transfers in the project.",
- "response": {
- "$ref": "ListTransferConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "dataSourceIds": {
- "repeated": true,
- "location": "query",
- "description": "When specified, only configurations of requested data sources are returned.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string"
- },
- "pageSize": {
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "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"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://bigquerydatatransfer.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.",
- "servicePath": "",
- "basePath": "",
- "revision": "20180122",
- "documentationLink": "https://cloud.google.com/bigquery/",
- "id": "bigquerydatatransfer:v1",
- "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
+ "TransferRun": {
+ "description": "Represents a data transfer run.\nNext id: 27",
"type": "object",
"properties": {
- "name": {
- "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: `\"us-east1\"`.",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
- }
- },
- "id": "Location"
- },
- "TransferConfig": {
- "description": "Represents a data transfer configuration. A transfer configuration\ncontains all metadata needed to perform a data transfer. For example,\n`destination_dataset_id` specifies where data should be stored.\nWhen a new transfer configuration is created, the specified\n`destination_dataset_id` is created when needed and shared with the\nappropriate data source service account.",
- "type": "object",
- "properties": {
- "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"
- },
- "disabled": {
- "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
- "type": "boolean"
- },
- "nextRunTime": {
- "description": "Output only. Next time when data transfer will run.",
- "format": "google-datetime",
- "type": "string"
- },
- "updateTime": {
- "description": "Output only. Data transfer modification time. Ignored by server on input.",
- "format": "google-datetime",
- "type": "string"
- },
- "schedule": {
- "description": "Data transfer schedule.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid format:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.\nSee more explanation about the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.",
- "type": "string"
- },
- "dataRefreshWindowDays": {
- "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
- "format": "int32",
- "type": "integer"
- },
"dataSourceId": {
- "description": "Data source id. Cannot be changed once data transfer is created.",
+ "description": "Output only. Data source id.",
"type": "string"
},
"state": {
@@ -1256,96 +26,29 @@
"FAILED",
"CANCELLED"
],
- "description": "Output only. State of the most recently updated transfer run.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
- "type": "string"
- },
- "destinationDatasetId": {
- "description": "The BigQuery target dataset id.",
- "type": "string"
- },
- "userId": {
- "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.\nMay be negative. Note, that this identifier is not stable.\nIt may change over time even for the same user.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "TransferConfig"
- },
- "TransferRun": {
- "description": "Represents a data transfer run.\nNext id: 27",
- "type": "object",
- "properties": {
- "scheduleTime": {
- "description": "Minimum time after which a transfer run can be started.",
- "format": "google-datetime",
- "type": "string"
- },
- "errorStatus": {
- "$ref": "Status",
- "description": "Status of the transfer run."
- },
- "updateTime": {
- "description": "Output only. Last time the data transfer run state was updated.",
- "format": "google-datetime",
- "type": "string"
- },
- "schedule": {
- "description": "Output only. Describes the schedule of this transfer run if it was\ncreated as part of a regular schedule. For batch transfer runs that are\nscheduled manually, this is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matches this.",
- "type": "string"
- },
- "runTime": {
- "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
- "format": "google-datetime",
- "type": "string"
- },
- "dataSourceId": {
- "description": "Output only. Data source id.",
- "type": "string"
- },
- "state": {
- "enum": [
- "TRANSFER_STATE_UNSPECIFIED",
- "PENDING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLED"
- ],
"description": "Data transfer run state. Ignored for input requests.",
- "type": "string",
- "enumDescriptions": [
- "State placeholder.",
- "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
- "Data transfer is in progress.",
- "Data transfer completed successsfully.",
- "Data transfer failed.",
- "Data transfer is cancelled."
- ]
- },
- "userId": {
- "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.\nMay be negative. Note, that this identifier is not stable.\nIt may change over time even for the same user.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
"type": "string"
},
"destinationDatasetId": {
"description": "Output only. The BigQuery target dataset id.",
"type": "string"
},
+ "name": {
+ "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
+ "type": "string"
+ },
+ "userId": {
+ "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.\nMay be negative. Note, that this identifier is not stable.\nIt may change over time even for the same user.",
+ "format": "int64",
+ "type": "string"
+ },
"params": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
"description": "Output only. Data transfer specific parameters.",
- "type": "object"
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ }
},
"endTime": {
"description": "Output only. Time when transfer run ended.\nParameter ignored by server for input requests.",
@@ -1356,60 +59,85 @@
"description": "Output only. Time when transfer run was started.\nParameter ignored by server for input requests.",
"format": "google-datetime",
"type": "string"
+ },
+ "scheduleTime": {
+ "description": "Minimum time after which a transfer run can be started.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "errorStatus": {
+ "description": "Status of the transfer run.",
+ "$ref": "Status"
+ },
+ "schedule": {
+ "description": "Output only. Describes the schedule of this transfer run if it was\ncreated as part of a regular schedule. For batch transfer runs that are\nscheduled manually, this is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matches this.",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Output only. Last time the data transfer run state was updated.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "runTime": {
+ "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
+ "format": "google-datetime",
+ "type": "string"
}
},
"id": "TransferRun"
},
"CheckValidCredsRequest": {
- "properties": {},
- "id": "CheckValidCredsRequest",
"description": "A request to determine whether the user has valid credentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data source has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the user id.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "CheckValidCredsRequest"
},
"CheckValidCredsResponse": {
+ "description": "A response indicating whether the credentials exist and are valid.",
+ "type": "object",
"properties": {
"hasValidCreds": {
"description": "If set to `true`, the credentials exist and are valid.",
"type": "boolean"
}
},
- "id": "CheckValidCredsResponse",
- "description": "A response indicating whether the credentials exist and are valid.",
- "type": "object"
+ "id": "CheckValidCredsResponse"
},
"ScheduleTransferRunsResponse": {
"description": "A response to schedule transfer runs for a time range.",
"type": "object",
"properties": {
"runs": {
- "description": "The transfer runs that were scheduled.",
"type": "array",
"items": {
"$ref": "TransferRun"
- }
+ },
+ "description": "The transfer runs that were scheduled."
}
},
"id": "ScheduleTransferRunsResponse"
},
"ListTransferLogsResponse": {
- "description": "The returned list transfer run messages.",
"type": "object",
"properties": {
"transferMessages": {
- "description": "Output only. The stored pipeline transfer messages.",
"type": "array",
"items": {
"$ref": "TransferMessage"
- }
+ },
+ "description": "Output only. The stored pipeline transfer messages."
},
"nextPageToken": {
"description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_token`\nto request the next page of list results.",
"type": "string"
}
},
- "id": "ListTransferLogsResponse"
+ "id": "ListTransferLogsResponse",
+ "description": "The returned list transfer run messages."
},
"TransferMessage": {
+ "description": "Represents a user facing message for a particular data transfer run.",
+ "type": "object",
"properties": {
"messageTime": {
"description": "Time when message was logged.",
@@ -1417,31 +145,31 @@
"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."
- ]
+ ],
+ "enum": [
+ "MESSAGE_SEVERITY_UNSPECIFIED",
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "Message severity."
},
"messageText": {
"description": "Message text.",
"type": "string"
}
},
- "id": "TransferMessage",
- "description": "Represents a user facing message for a particular data transfer run.",
- "type": "object"
+ "id": "TransferMessage"
},
"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.",
@@ -1455,12 +183,40 @@
"type": "string"
}
},
- "id": "ListDataSourcesResponse",
- "description": "Returns list of supported data sources and their metadata.",
- "type": "object"
+ "id": "ListDataSourcesResponse"
},
"DataSourceParameter": {
+ "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms.",
+ "type": "object",
"properties": {
+ "allowedValues": {
+ "description": "All possible values for the parameter.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "validationHelpUrl": {
+ "description": "URL to a help document to further explain the naming requirements.",
+ "type": "string"
+ },
+ "minValue": {
+ "type": "number",
+ "description": "For integer and double values specifies minimum allowed value.",
+ "format": "double"
+ },
+ "validationRegex": {
+ "description": "Regular expression which can be used for parameter validation.",
+ "type": "string"
+ },
+ "paramId": {
+ "description": "Parameter identifier.",
+ "type": "string"
+ },
+ "required": {
+ "description": "Is parameter required.",
+ "type": "boolean"
+ },
"repeated": {
"description": "Can parameter have multiple values.",
"type": "boolean"
@@ -1518,54 +274,24 @@
"description": {
"description": "Parameter description.",
"type": "string"
- },
- "allowedValues": {
- "description": "All possible values for the parameter.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "validationHelpUrl": {
- "description": "URL to a help document to further explain the naming requirements.",
- "type": "string"
- },
- "minValue": {
- "description": "For integer and double values specifies minimum allowed value.",
- "format": "double",
- "type": "number"
- },
- "validationRegex": {
- "description": "Regular expression which can be used for parameter validation.",
- "type": "string"
- },
- "paramId": {
- "description": "Parameter identifier.",
- "type": "string"
- },
- "required": {
- "description": "Is parameter required.",
- "type": "boolean"
}
},
- "id": "DataSourceParameter",
- "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms.",
- "type": "object"
+ "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"
@@ -1574,48 +300,49 @@
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"locations": {
- "description": "A list of locations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Location"
- }
+ },
+ "description": "A list of locations that matches the specified filter in the request."
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
"id": "ListLocationsResponse"
},
"ListTransferConfigsResponse": {
+ "description": "The returned list of pipelines in the project.",
+ "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_token`\nto request the next page of list results.",
+ "type": "string"
+ },
"transferConfigs": {
"description": "Output only. The stored pipeline transfer configurations.",
"type": "array",
"items": {
"$ref": "TransferConfig"
}
- },
- "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"
+ "id": "ListTransferConfigsResponse"
},
"DataSource": {
+ "type": "object",
"properties": {
- "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",
@@ -1623,10 +350,6 @@
"type": "string"
}
},
- "name": {
- "description": "Data source resource name.",
- "type": "string"
- },
"minimumScheduleInterval": {
"description": "The minimum interval for scheduler to schedule runs.",
"format": "google-duration",
@@ -1637,17 +360,17 @@
"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."
+ ],
+ "enum": [
+ "AUTHORIZATION_TYPE_UNSPECIFIED",
+ "AUTHORIZATION_CODE",
+ "GOOGLE_PLUS_AUTHORIZATION_CODE"
]
},
"supportsCustomSchedule": {
@@ -1659,23 +382,23 @@
"type": "string"
},
"updateDeadlineSeconds": {
+ "type": "integer",
"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"
+ "format": "int32"
},
"dataRefreshType": {
+ "enumDescriptions": [
+ "The data source won't support data auto refresh, which is default value.",
+ "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Does not allow custom values to be set for each\ntransfer config.",
+ "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig."
+ ],
"enum": [
"DATA_REFRESH_TYPE_UNSPECIFIED",
"SLIDING_WINDOW",
"CUSTOM_SLIDING_WINDOW"
],
"description": "Specifies whether the data source supports automatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.",
- "type": "string",
- "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."
- ]
+ "type": "string"
},
"parameters": {
"description": "Data source parameters.",
@@ -1706,6 +429,8 @@
"type": "integer"
},
"transferType": {
+ "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.",
@@ -1715,41 +440,15 @@
"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.",
+ ]
+ },
+ "description": {
+ "description": "User friendly data source description string.",
"type": "string"
}
},
"id": "DataSource",
- "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",
- "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"
+ "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens."
},
"ScheduleTransferRunsRequest": {
"description": "A request to schedule transfer runs for a time range.",
@@ -1768,16 +467,1317 @@
},
"id": "ScheduleTransferRunsRequest"
},
+ "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": {
+ "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"
+ }
+ },
+ "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",
+ "properties": {},
+ "id": "Empty"
+ },
+ "Location": {
+ "properties": {
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: `\"us-east1\"`.",
+ "type": "string"
+ },
+ "metadata": {
+ "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"
+ }
+ },
+ "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": {
+ "dataSourceId": {
+ "description": "Data source id. Cannot be changed once data transfer is created.",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "State placeholder.",
+ "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
+ "Data transfer is in progress.",
+ "Data transfer completed successsfully.",
+ "Data transfer failed.",
+ "Data transfer is cancelled."
+ ],
+ "enum": [
+ "TRANSFER_STATE_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "Output only. State of the most recently updated transfer run.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
+ "type": "string"
+ },
+ "destinationDatasetId": {
+ "type": "string",
+ "description": "The BigQuery target dataset id."
+ },
+ "userId": {
+ "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.\nMay be negative. Note, that this identifier is not stable.\nIt may change over time even for the same user.",
+ "format": "int64",
+ "type": "string"
+ },
+ "params": {
+ "description": "Data transfer specific parameters.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
+ "datasetRegion": {
+ "description": "Output only. Region in which BigQuery dataset is located.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "User specified display name for the data transfer.",
+ "type": "string"
+ },
+ "nextRunTime": {
+ "description": "Output only. Next time when data transfer will run.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "disabled": {
+ "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
+ "type": "boolean"
+ },
+ "schedule": {
+ "description": "Data transfer schedule.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid format:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.\nSee more explanation about the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Output only. Data transfer modification time. Ignored by server on input.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "dataRefreshWindowDays": {
+ "type": "integer",
+ "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
+ "format": "int32"
+ }
+ },
+ "id": "TransferConfig"
}
},
"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": "BigQuery Data Transfer",
+ "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/bigquery": {
+ "description": "View and manage your data in Google BigQuery"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://bigquerydatatransfer.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "bigquerydatatransfer",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "BigQuery Data Transfer 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": {
+ "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/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "path": "v1/{+name}/locations",
+ "id": "bigquerydatatransfer.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/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.get"
+ }
+ },
+ "resources": {
+ "dataSources": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "DataSource"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
+ "location": "path",
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.get",
+ "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListDataSourcesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources",
+ "path": "v1/{+parent}/dataSources",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.list",
+ "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering."
+ },
+ "checkValidCreds": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds",
+ "path": "v1/{+name}:checkValidCreds",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds",
+ "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.",
+ "request": {
+ "$ref": "CheckValidCredsRequest"
+ },
+ "response": {
+ "$ref": "CheckValidCredsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
+ "location": "path",
+ "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
+ "required": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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"
+ }
+ }
+ },
+ "list": {
+ "response": {
+ "$ref": "ListTransferConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "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": {
+ "location": "query",
+ "description": "When specified, only configurations of requested data sources are returned.",
+ "type": "string",
+ "repeated": true
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
+ "path": "v1/{+parent}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
+ "description": "Returns information about all data transfers in the project."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameters": {
+ "authorizationCode": {
+ "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": {
+ "required": true,
+ "type": "string",
+ "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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.create",
+ "path": "v1/{+parent}/transferConfigs",
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "description": "Creates a new data transfer configuration."
+ },
+ "scheduleRuns": {
+ "response": {
+ "$ref": "ScheduleTransferRunsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
+ "location": "path",
+ "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
+ "path": "v1/{+parent}:scheduleRuns",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns",
+ "request": {
+ "$ref": "ScheduleTransferRunsRequest"
+ },
+ "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range."
+ },
+ "patch": {
+ "parameters": {
+ "updateMask": {
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "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": {
+ "type": "string",
+ "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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.patch",
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH"
+ },
+ "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": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ },
+ "resources": {
+ "runs": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified transfer run.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "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",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete"
+ },
+ "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",
+ "parameters": {
+ "name": {
+ "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",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$"
+ }
+ },
+ "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}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListTransferRunsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "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."
+ },
+ "states": {
+ "location": "query",
+ "enum": [
+ "TRANSFER_STATE_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "When specified, only transfer runs with requested states are returned.",
+ "type": "string",
+ "repeated": true
+ },
+ "pageSize": {
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "runAttempt": {
+ "location": "query",
+ "enum": [
+ "RUN_ATTEMPT_UNSPECIFIED",
+ "LATEST"
+ ],
+ "description": "Indicates how run attempts are to be pulled.",
+ "type": "string"
+ },
+ "parent": {
+ "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/[^/]+/locations/[^/]+/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}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs",
+ "path": "v1/{+parent}/runs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list",
+ "description": "Returns information about running and completed jobs."
+ }
+ },
+ "resources": {
+ "transferLogs": {
+ "methods": {
+ "list": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list",
+ "path": "v1/{+parent}/transferLogs",
+ "description": "Returns user facing log messages for the data transfer run.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListTransferLogsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "location": "path",
+ "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`."
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "dataSources": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "DataSource"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/dataSources/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}",
+ "id": "bigquerydatatransfer.projects.dataSources.get",
+ "path": "v1/{+name}"
+ },
+ "list": {
+ "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
+ "response": {
+ "$ref": "ListDataSourcesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "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.",
+ "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"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/dataSources",
+ "path": "v1/{+parent}/dataSources",
+ "id": "bigquerydatatransfer.projects.dataSources.list"
+ },
+ "checkValidCreds": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "CheckValidCredsResponse"
+ },
+ "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",
+ "id": "bigquerydatatransfer.projects.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": {
+ "list": {
+ "flatPath": "v1/projects/{projectsId}/transferConfigs",
+ "path": "v1/{+parent}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.list",
+ "description": "Returns information about all data transfers in the project.",
+ "response": {
+ "$ref": "ListTransferConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "dataSourceIds": {
+ "description": "When specified, only configurations of requested data sources are returned.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ }
+ }
+ },
+ "create": {
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "description": "Creates a new data transfer configuration.",
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "authorizationCode": {
+ "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/transferConfigs",
+ "path": "v1/{+parent}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.create"
+ },
+ "scheduleRuns": {
+ "path": "v1/{+parent}:scheduleRuns",
+ "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns",
+ "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
+ "request": {
+ "$ref": "ScheduleTransferRunsRequest"
+ },
+ "response": {
+ "$ref": "ScheduleTransferRunsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "location": "path",
+ "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`."
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns"
+ },
+ "get": {
+ "id": "bigquerydatatransfer.projects.transferConfigs.get",
+ "path": "v1/{+name}",
+ "description": "Returns information about a data transfer config.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "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"
+ }
+ },
+ "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}"
+ },
+ "patch": {
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.patch",
+ "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "required": true,
+ "type": "string",
+ "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."
+ },
+ "authorizationCode": {
+ "type": "string",
+ "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."
+ }
+ }
+ },
+ "delete": {
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.delete",
+ "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "runs": {
+ "resources": {
+ "transferLogs": {
+ "methods": {
+ "list": {
+ "description": "Returns user facing log messages for the data transfer run.",
+ "response": {
+ "$ref": "ListTransferLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "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": {
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "location": "path",
+ "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
+ "path": "v1/{+parent}/transferLogs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list"
+ }
+ }
+ }
+ },
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "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",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete",
+ "description": "Deletes the specified transfer run."
+ },
+ "get": {
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.get",
+ "path": "v1/{+name}",
+ "description": "Returns information about the particular transfer run.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "TransferRun"
+ },
+ "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": {
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
+ "path": "v1/{+parent}/runs",
+ "description": "Returns information about running and completed jobs.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTransferRunsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "states": {
+ "description": "When specified, only transfer runs with requested states are returned.",
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "TRANSFER_STATE_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ]
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "runAttempt": {
+ "location": "query",
+ "enum": [
+ "RUN_ATTEMPT_UNSPECIFIED",
+ "LATEST"
+ ],
+ "description": "Indicates how run attempts are to be pulled.",
+ "type": "string"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
+ },
+ "pageToken": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "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": {
+ "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": {
+ "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": {
+ "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"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Pretty-print response."
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://bigquerydatatransfer.googleapis.com/",
+ "servicePath": "",
+ "description": "Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "revision": "20180122",
+ "documentationLink": "https://cloud.google.com/bigquery/",
+ "id": "bigquerydatatransfer:v1",
+ "discoveryVersion": "v1"
}
diff --git a/classroom/v1/classroom-api.json b/classroom/v1/classroom-api.json
index c0d86d7..a01c98d 100644
--- a/classroom/v1/classroom-api.json
+++ b/classroom/v1/classroom-api.json
@@ -1,17 +1,131 @@
{
- "discoveryVersion": "v1",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/classroom.courses.readonly": {
+ "description": "View your Google Classroom classes"
+ },
+ "https://www.googleapis.com/auth/classroom.announcements": {
+ "description": "View and manage announcements in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.rosters.readonly": {
+ "description": "View your Google Classroom class rosters"
+ },
+ "https://www.googleapis.com/auth/classroom.profile.photos": {
+ "description": "View the profile photos of people in your classes"
+ },
+ "https://www.googleapis.com/auth/classroom.announcements.readonly": {
+ "description": "View announcements in Google Classroom"
+ },
+ "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.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": {
+ "description": "Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer"
+ },
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly": {
+ "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
+ },
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly": {
+ "description": "View your course work and grades in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.profile.emails": {
+ "description": "View the email addresses of people in your classes"
+ },
+ "https://www.googleapis.com/auth/classroom.coursework.me": {
+ "description": "Manage your course work and view your grades in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.push-notifications": {
+ "description": "Receive notifications about your Google Classroom data"
+ },
+ "https://www.googleapis.com/auth/classroom.rosters": {
+ "description": "Manage your Google Classroom class rosters"
+ },
+ "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": {
+ "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
+ },
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly": {
+ "description": "View guardians for students in your Google Classroom classes"
+ },
+ "https://www.googleapis.com/auth/classroom.courses": {
+ "description": "Manage your Google Classroom classes"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "Manages classes, rosters, and invitations in Google Classroom.",
+ "servicePath": "",
+ "rootUrl": "https://classroom.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "classroom",
+ "batchPath": "batch",
+ "id": "classroom:v1",
+ "documentationLink": "https://developers.google.com/classroom/",
+ "revision": "20180127",
+ "title": "Google Classroom API",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"invitations": {
"methods": {
- "delete": {
+ "create": {
+ "request": {
+ "$ref": "Invitation"
+ },
+ "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Invitation"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "flatPath": "v1/invitations",
+ "id": "classroom.invitations.create",
+ "path": "v1/invitations"
+ },
+ "accept": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"id"
],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Identifier of the invitation to accept.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/invitations/{id}:accept",
+ "path": "v1/invitations/{id}:accept",
+ "id": "classroom.invitations.accept",
+ "description": "Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID."
+ },
+ "delete": {
"httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "id"
+ ],
"parameters": {
"id": {
"location": "path",
@@ -24,14 +138,11 @@
"https://www.googleapis.com/auth/classroom.rosters"
],
"flatPath": "v1/invitations/{id}",
- "path": "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."
},
"get": {
- "path": "v1/invitations/{id}",
- "id": "classroom.invitations.get",
- "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
"response": {
"$ref": "Invitation"
},
@@ -39,265 +150,65 @@
"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"
],
- "parameters": {
- "id": {
- "description": "Identifier of the invitation to return.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/invitations/{id}"
+ "flatPath": "v1/invitations/{id}",
+ "path": "v1/invitations/{id}",
+ "id": "classroom.invitations.get",
+ "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID."
},
"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",
+ "parameters": {
+ "userId": {
+ "location": "query",
+ "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
+ },
+ "pageToken": {
+ "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"
+ },
+ "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": "query",
+ "description": "Restricts returned invitations to those for a course with the specified\nidentifier.",
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters",
"https://www.googleapis.com/auth/classroom.rosters.readonly"
],
- "parameters": {
- "userId": {
- "type": "string",
- "location": "query",
- "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
- },
- "pageToken": {
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating\nthat the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32",
- "type": "integer"
- },
- "courseId": {
- "type": "string",
- "location": "query",
- "description": "Restricts returned invitations to those for a course with the specified\nidentifier."
- }
- },
"flatPath": "v1/invitations",
"path": "v1/invitations",
- "id": "classroom.invitations.list"
- },
- "create": {
- "response": {
- "$ref": "Invitation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {},
- "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"
- }
- },
- "accept": {
- "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",
- "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"
+ "id": "classroom.invitations.list",
+ "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors."
}
}
},
"courses": {
"methods": {
- "get": {
- "flatPath": "v1/courses/{id}",
- "path": "v1/courses/{id}",
- "id": "classroom.courses.get",
- "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
- "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"
- }
- }
- },
- "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": {
- "id": {
- "location": "path",
- "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n* `ownerId`\n\nNote: patches to ownerId are treated as being effective immediately, but in\npractice it may take some time for the ownership transfer of all affected\nresources to complete.\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- }
- },
- "update": {
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {
- "id": {
- "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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"
- },
- "response": {
- "$ref": "Course"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "PUT"
- },
- "delete": {
- "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",
- "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID."
- },
- "list": {
- "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.",
- "response": {
- "$ref": "ListCoursesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ],
- "parameters": {
- "pageSize": {
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "teacherId": {
- "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
- },
- "studentId": {
- "type": "string",
- "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"
- },
- "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"
- }
- },
- "flatPath": "v1/courses",
- "path": "v1/courses",
- "id": "classroom.courses.list"
- },
"create": {
"response": {
"$ref": "Course"
@@ -315,116 +226,176 @@
"$ref": "Course"
},
"description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists."
+ },
+ "get": {
+ "response": {
+ "$ref": "Course"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "id": {
+ "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
+ "flatPath": "v1/courses/{id}",
+ "path": "v1/courses/{id}",
+ "id": "classroom.courses.get",
+ "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID."
+ },
+ "patch": {
+ "request": {
+ "$ref": "Course"
+ },
+ "description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
+ "response": {
+ "$ref": "Course"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "id": {
+ "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n* `ownerId`\n\nNote: patches to ownerId are treated as being effective immediately, but in\npractice it may take some time for the ownership transfer of all affected\nresources to complete.\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "flatPath": "v1/courses/{id}",
+ "path": "v1/courses/{id}",
+ "id": "classroom.courses.patch"
+ },
+ "update": {
+ "flatPath": "v1/courses/{id}",
+ "path": "v1/courses/{id}",
+ "id": "classroom.courses.update",
+ "request": {
+ "$ref": "Course"
+ },
+ "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
+ "response": {
+ "$ref": "Course"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "PUT",
+ "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": {
+ "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",
+ "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID."
+ },
+ "list": {
+ "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request. Returned courses are ordered by\ncreation time, with the most recently created coming first.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListCoursesResponse"
+ },
+ "parameterOrder": [],
+ "parameters": {
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "teacherId": {
+ "location": "query",
+ "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
+ },
+ "courseStates": {
+ "location": "query",
+ "enum": [
+ "COURSE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "ARCHIVED",
+ "PROVISIONED",
+ "DECLINED",
+ "SUSPENDED"
+ ],
+ "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
+ "type": "string",
+ "repeated": true
+ },
+ "studentId": {
+ "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": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
+ "flatPath": "v1/courses",
+ "id": "classroom.courses.list",
+ "path": "v1/courses"
}
},
"resources": {
- "aliases": {
+ "announcements": {
"methods": {
- "delete": {
- "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"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {
- "courseId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- },
- "alias": {
- "location": "path",
- "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{courseId}/aliases/{alias}"
- },
- "list": {
- "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.",
- "response": {
- "$ref": "ListCourseAliasesResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
+ "get": {
"httpMethod": "GET",
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "The identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ]
- },
- "create": {
- "description": "Creates an alias for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create the\nalias or for access errors.\n* `NOT_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already exists.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to access a domain-scoped alias).",
- "request": {
- "$ref": "CourseAlias"
- },
"response": {
- "$ref": "CourseAlias"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{courseId}/aliases",
- "path": "v1/courses/{courseId}/aliases",
- "id": "classroom.courses.aliases.create"
- }
- }
- },
- "courseWork": {
- "methods": {
- "delete": {
- "id": "classroom.courses.courseWork.delete",
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "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"
+ "$ref": "Announcement"
},
"parameterOrder": [
"courseId",
@@ -438,21 +409,95 @@
"location": "path"
},
"id": {
- "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
+ "description": "Identifier of the announcement.",
"required": true,
"type": "string",
"location": "path"
}
},
"scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
+ "https://www.googleapis.com/auth/classroom.announcements",
+ "https://www.googleapis.com/auth/classroom.announcements.readonly"
],
- "flatPath": "v1/courses/{courseId}/courseWork/{id}"
+ "flatPath": "v1/courses/{courseId}/announcements/{id}",
+ "id": "classroom.courses.announcements.get",
+ "path": "v1/courses/{courseId}/announcements/{id}",
+ "description": "Returns an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or announcement, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or announcement does not exist."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "response": {
+ "$ref": "Announcement"
+ },
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "location": "path",
+ "description": "Identifier of the announcement.",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Mask that identifies which fields on the announcement to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the Announcement object. If\na field that does not support empty values is included in the update mask\nand not set in the Announcement object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `text`\n* `state`\n* `scheduled_time`",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements"
+ ],
+ "flatPath": "v1/courses/{courseId}/announcements/{id}",
+ "id": "classroom.courses.announcements.patch",
+ "path": "v1/courses/{courseId}/announcements/{id}",
+ "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"
+ },
+ "delete": {
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements"
+ ],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the announcement to delete.\nThis identifier is a Classroom-assigned identifier.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/announcements/{id}"
},
"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"
+ "$ref": "ListAnnouncementsResponse"
},
"parameterOrder": [
"courseId"
@@ -460,7 +505,7 @@
"httpMethod": "GET",
"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`",
+ "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"
},
@@ -475,17 +520,190 @@
"format": "int32",
"type": "integer"
},
- "courseWorkStates": {
- "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"
+ },
+ "announcementStates": {
"location": "query",
"enum": [
- "COURSE_WORK_STATE_UNSPECIFIED",
+ "ANNOUNCEMENT_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."
+ "description": "Restriction on the `state` of announcements returned.\nIf this argument is left unspecified, the default value is `PUBLISHED`.",
+ "type": "string",
+ "repeated": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements",
+ "https://www.googleapis.com/auth/classroom.announcements.readonly"
+ ],
+ "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."
+ },
+ "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": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/announcements",
+ "path": "v1/courses/{courseId}/announcements",
+ "id": "classroom.courses.announcements.create"
+ },
+ "modifyAssignees": {
+ "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees",
+ "path": "v1/courses/{courseId}/announcements/{id}:modifyAssignees",
+ "id": "classroom.courses.announcements.modifyAssignees",
+ "request": {
+ "$ref": "ModifyAnnouncementAssigneesRequest"
+ },
+ "description": "Modifies assignee mode and options of an announcement.\n\nOnly a teacher of the course that contains the announcement may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
+ "response": {
+ "$ref": "Announcement"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "location": "path",
+ "description": "Identifier of the announcement.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements"
+ ]
+ }
+ }
+ },
+ "students": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "userId": {
+ "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "flatPath": "v1/courses/{courseId}/students/{userId}",
+ "id": "classroom.courses.students.delete",
+ "path": "v1/courses/{courseId}/students/{userId}",
+ "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."
+ },
+ "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": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "location": "path",
+ "description": "Identifier of the student to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/students/{userId}",
+ "path": "v1/courses/{courseId}/students/{userId}",
+ "id": "classroom.courses.students.get"
+ },
+ "list": {
+ "description": "Returns a list of students of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
+ "response": {
+ "$ref": "ListStudentsResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer"
},
"courseId": {
"location": "path",
@@ -494,19 +712,13 @@
"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"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork",
- "path": "v1/courses/{courseId}/courseWork",
- "id": "classroom.courses.courseWork.list"
+ "flatPath": "v1/courses/{courseId}/students",
+ "path": "v1/courses/{courseId}/students",
+ "id": "classroom.courses.students.list"
},
"create": {
"response": {
- "$ref": "CourseWork"
+ "$ref": "Student"
},
"parameterOrder": [
"courseId"
@@ -514,137 +726,418 @@
"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",
- "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"
- },
- "modifyAssignees": {
- "response": {
- "$ref": "CourseWork"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "id": {
- "location": "path",
- "description": "Identifier of the coursework.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees",
- "path": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees",
- "id": "classroom.courses.courseWork.modifyAssignees",
- "request": {
- "$ref": "ModifyCourseWorkAssigneesRequest"
- },
- "description": "Modifies assignee mode and options of a coursework.\n\nOnly a teacher of the course that contains the coursework may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist."
- },
- "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": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"required": true,
"type": "string",
"location": "path"
},
- "id": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course work."
- },
- "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",
+ "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}/courseWork/{id}",
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "id": "classroom.courses.courseWork.patch"
- },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "flatPath": "v1/courses/{courseId}/students",
+ "path": "v1/courses/{courseId}/students",
+ "id": "classroom.courses.students.create",
+ "request": {
+ "$ref": "Student"
+ },
+ "description": "Adds a user as a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse."
+ }
+ }
+ },
+ "topics": {
+ "methods": {
"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.",
+ "flatPath": "v1/courses/{courseId}/topics/{id}",
+ "id": "classroom.courses.topics.get",
+ "path": "v1/courses/{courseId}/topics/{id}",
+ "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": "CourseWork"
+ "$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"
+ ]
+ },
+ "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": {
+ "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"
+ }
+ },
"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",
+ "path": "v1/courses/{courseId}/topics",
+ "id": "classroom.courses.topics.list"
+ }
+ }
+ },
+ "aliases": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "alias"
+ ],
+ "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": {
+ "alias": {
+ "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
"required": true,
"type": "string",
+ "location": "path"
+ },
+ "courseId": {
"location": "path",
- "description": "Identifier of the course work."
+ "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"
}
},
- "flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "id": "classroom.courses.courseWork.get"
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "flatPath": "v1/courses/{courseId}/aliases/{alias}",
+ "path": "v1/courses/{courseId}/aliases/{alias}",
+ "id": "classroom.courses.aliases.delete",
+ "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias)."
+ },
+ "list": {
+ "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist.",
+ "response": {
+ "$ref": "ListCourseAliasesResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "The 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.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/aliases",
+ "path": "v1/courses/{courseId}/aliases",
+ "id": "classroom.courses.aliases.list"
+ },
+ "create": {
+ "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": {
+ "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",
+ "id": "classroom.courses.aliases.create",
+ "path": "v1/courses/{courseId}/aliases"
}
- },
+ }
+ },
+ "courseWork": {
"resources": {
"studentSubmissions": {
"methods": {
+ "turnIn": {
+ "description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "request": {
+ "$ref": "TurnInStudentSubmissionRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me"
+ ],
+ "parameters": {
+ "courseWorkId": {
+ "location": "path",
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string"
+ },
+ "courseId": {
+ "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}:turnIn",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
+ "id": "classroom.courses.courseWork.studentSubmissions.turnIn"
+ },
+ "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.",
+ "response": {
+ "$ref": "StudentSubmission"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "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.students"
+ ],
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListStudentSubmissionsResponse"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "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": {
+ "repeated": true,
+ "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"
+ }
+ },
+ "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",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
+ "id": "classroom.courses.courseWork.studentSubmissions.list",
+ "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist."
+ },
+ "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": {
+ "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"
+ },
+ "updateMask": {
+ "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n\n* `draft_grade`\n* `assigned_grade`",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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"
+ }
+ },
"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.",
"httpMethod": "GET",
"parameterOrder": [
"courseId",
@@ -684,57 +1177,12 @@
],
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
"id": "classroom.courses.courseWork.studentSubmissions.get",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "response": {
- "$ref": "StudentSubmission"
- },
- "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"
- },
- "updateMask": {
- "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n\n* `draft_grade`\n* `assigned_grade`",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "id": "classroom.courses.courseWork.studentSubmissions.patch",
"path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "request": {
- "$ref": "StudentSubmission"
- },
- "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
+ "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
},
"return": {
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
+ "id": "classroom.courses.courseWork.studentSubmissions.return",
"request": {
"$ref": "ReturnStudentSubmissionRequest"
},
@@ -749,21 +1197,21 @@
],
"httpMethod": "POST",
"parameters": {
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"courseId": {
+ "location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"id": {
+ "location": "path",
"description": "Identifier of the student submission.",
"required": true,
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "required": true,
"type": "string",
"location": "path"
}
@@ -771,179 +1219,19 @@
"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"
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return"
},
"reclaim": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me"
- ],
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "id": {
- "location": "path",
- "description": "Identifier of the student submission.",
- "required": true,
- "type": "string"
- },
- "courseWorkId": {
- "location": "path",
- "description": "Identifier of the course work.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
"path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
"id": "classroom.courses.courseWork.studentSubmissions.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"
- }
- },
- "turnIn": {
- "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}:turnIn",
- "id": "classroom.courses.courseWork.studentSubmissions.turnIn",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
- "request": {
- "$ref": "TurnInStudentSubmissionRequest"
- },
- "description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
- },
- "list": {
- "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": {
- "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": {
- "location": "query",
- "enum": [
- "LATE_VALUES_UNSPECIFIED",
- "LATE_ONLY",
- "NOT_LATE_ONLY"
- ],
- "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string"
- },
- "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
- },
- "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}/courseWork/{courseWorkId}/studentSubmissions",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
- "id": "classroom.courses.courseWork.studentSubmissions.list",
- "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
- "response": {
- "$ref": "ListStudentSubmissionsResponse"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId"
- ],
- "httpMethod": "GET"
- },
- "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",
@@ -951,24 +1239,23 @@
],
"httpMethod": "POST",
"scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.students"
+ "https://www.googleapis.com/auth/classroom.coursework.me"
],
"parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
"required": true,
"type": "string",
"location": "path"
},
- "id": {
+ "courseId": {
"location": "path",
- "description": "Identifier of the student submission.",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"required": true,
"type": "string"
},
- "courseWorkId": {
- "description": "Identifier of the course work.",
+ "id": {
+ "description": "Identifier of the student submission.",
"required": true,
"type": "string",
"location": "path"
@@ -977,126 +1264,71 @@
}
}
}
- }
- },
- "teachers": {
+ },
"methods": {
- "delete": {
- "flatPath": "v1/courses/{courseId}/teachers/{userId}",
- "path": "v1/courses/{courseId}/teachers/{userId}",
- "id": "classroom.courses.teachers.delete",
- "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "httpMethod": "DELETE",
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- },
- "get": {
- "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.",
- "response": {
- "$ref": "Teacher"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "userId": {
- "required": true,
- "type": "string",
- "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"
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/teachers/{userId}",
- "path": "v1/courses/{courseId}/teachers/{userId}",
- "id": "classroom.courses.teachers.get"
- },
"list": {
- "response": {
- "$ref": "ListTeachersResponse"
- },
+ "id": "classroom.courses.courseWork.list",
+ "path": "v1/courses/{courseId}/courseWork",
+ "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"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListCourseWorkResponse"
+ },
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string"
- },
"pageSize": {
"location": "query",
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "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": {
"location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"required": true,
"type": "string"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "type": "string"
}
},
"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"
+ "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}/teachers",
- "path": "v1/courses/{courseId}/teachers",
- "id": "classroom.courses.teachers.list",
- "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors."
+ "flatPath": "v1/courses/{courseId}/courseWork"
},
"create": {
"response": {
- "$ref": "Teacher"
+ "$ref": "CourseWork"
},
"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": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
@@ -1105,48 +1337,20 @@
"location": "path"
}
},
- "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": {
- "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": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- }
- },
"scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
+ "https://www.googleapis.com/auth/classroom.coursework.students"
],
- "flatPath": "v1/courses/{courseId}/announcements",
- "path": "v1/courses/{courseId}/announcements",
- "id": "classroom.courses.announcements.create"
+ "flatPath": "v1/courses/{courseId}/courseWork",
+ "path": "v1/courses/{courseId}/courseWork",
+ "id": "classroom.courses.courseWork.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"
},
"modifyAssignees": {
"response": {
- "$ref": "Announcement"
+ "$ref": "CourseWork"
},
"parameterOrder": [
"courseId",
@@ -1154,7 +1358,7 @@
],
"httpMethod": "POST",
"scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
+ "https://www.googleapis.com/auth/classroom.coursework.students"
],
"parameters": {
"courseId": {
@@ -1164,62 +1368,23 @@
"location": "path"
},
"id": {
- "location": "path",
- "description": "Identifier of the announcement.",
+ "description": "Identifier of the coursework.",
"required": true,
- "type": "string"
+ "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.",
+ "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": "ModifyAnnouncementAssigneesRequest"
+ "$ref": "ModifyCourseWorkAssigneesRequest"
}
},
- "get": {
- "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",
- "description": "Returns an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or announcement, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or announcement does not exist."
- },
"patch": {
- "flatPath": "v1/courses/{courseId}/announcements/{id}",
- "path": "v1/courses/{courseId}/announcements/{id}",
- "id": "classroom.courses.announcements.patch",
- "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"
+ "$ref": "CourseWork"
},
"parameterOrder": [
"courseId",
@@ -1234,24 +1399,68 @@
"location": "path"
},
"id": {
- "description": "Identifier of the announcement.",
+ "location": "path",
+ "description": "Identifier of the course work.",
"required": true,
- "type": "string",
- "location": "path"
+ "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`",
+ "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"
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
- ]
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "id": "classroom.courses.courseWork.patch",
+ "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."
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "id": "classroom.courses.courseWork.get"
},
"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.",
+ "id": "classroom.courses.courseWork.delete",
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "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"
},
@@ -1259,297 +1468,160 @@
"courseId",
"id"
],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
- ],
"parameters": {
"courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the 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}"
+ }
+ }
+ },
+ "teachers": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "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"
- },
- "id": {
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "flatPath": "v1/courses/{courseId}/teachers/{userId}",
+ "id": "classroom.courses.teachers.delete",
+ "path": "v1/courses/{courseId}/teachers/{userId}",
+ "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course."
+ },
+ "get": {
+ "response": {
+ "$ref": "Teacher"
+ },
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "userId": {
"location": "path",
- "description": "Identifier of the announcement to delete.\nThis identifier is a Classroom-assigned identifier.",
+ "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": {
+ "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/{id}",
- "path": "v1/courses/{courseId}/announcements/{id}",
- "id": "classroom.courses.announcements.delete"
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/teachers/{userId}",
+ "path": "v1/courses/{courseId}/teachers/{userId}",
+ "id": "classroom.courses.teachers.get",
+ "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist."
},
"list": {
"httpMethod": "GET",
"response": {
- "$ref": "ListAnnouncementsResponse"
+ "$ref": "ListTeachersResponse"
},
"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",
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "type": "string",
"location": "query"
},
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer"
+ },
"courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"required": true,
"type": "string",
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- },
- "announcementStates": {
- "repeated": true,
- "location": "query",
- "enum": [
- "ANNOUNCEMENT_STATE_UNSPECIFIED",
- "PUBLISHED",
- "DRAFT",
- "DELETED"
- ],
- "description": "Restriction on the `state` of announcements returned.\nIf this argument is left unspecified, the default value is `PUBLISHED`.",
- "type": "string"
- },
- "orderBy": {
- "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported field is `updateTime`.\nSupported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `updateTime asc`, `updateTime`",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "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"
+ "location": "path"
}
},
"scopes": [
- "https://www.googleapis.com/auth/classroom.announcements",
- "https://www.googleapis.com/auth/classroom.announcements.readonly"
+ "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}/announcements",
- "id": "classroom.courses.announcements.list",
- "path": "v1/courses/{courseId}/announcements",
- "description": "Returns a list of announcements that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` announcements. Course teachers\nand domain administrators may view all announcements.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist."
- }
- }
- },
- "students": {
- "methods": {
+ "flatPath": "v1/courses/{courseId}/teachers",
+ "id": "classroom.courses.teachers.list",
+ "path": "v1/courses/{courseId}/teachers",
+ "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors."
+ },
"create": {
- "flatPath": "v1/courses/{courseId}/students",
- "path": "v1/courses/{courseId}/students",
- "id": "classroom.courses.students.create",
"request": {
- "$ref": "Student"
+ "$ref": "Teacher"
},
- "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.",
+ "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.",
"response": {
- "$ref": "Student"
+ "$ref": "Teacher"
},
"parameterOrder": [
"courseId"
],
"httpMethod": "POST",
"parameters": {
- "enrollmentCode": {
- "type": "string",
- "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."
- },
"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."
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.profile.emails",
"https://www.googleapis.com/auth/classroom.profile.photos",
"https://www.googleapis.com/auth/classroom.rosters"
- ]
- },
- "delete": {
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {
- "userId": {
- "location": "path",
- "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "type": "string"
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{courseId}/students/{userId}",
- "path": "v1/courses/{courseId}/students/{userId}",
- "id": "classroom.courses.students.delete"
- },
- "get": {
- "path": "v1/courses/{courseId}/students/{userId}",
- "id": "classroom.courses.students.get",
- "description": "Returns a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.",
- "response": {
- "$ref": "Student"
- },
- "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": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/courses/{courseId}/students/{userId}"
- },
- "list": {
- "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.",
- "response": {
- "$ref": "ListStudentsResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "courseId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- }
- },
- "flatPath": "v1/courses/{courseId}/students"
- }
- }
- },
- "topics": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "httpMethod": "GET",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "id": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the 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"
- ],
- "flatPath": "v1/courses/{courseId}/topics/{id}",
- "path": "v1/courses/{courseId}/topics/{id}",
- "id": "classroom.courses.topics.get",
- "description": "Returns a topic.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or topic, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or topic does not exist."
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListTopicResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "parameters": {
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "courseId": {
- "location": "path",
- "description": "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.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."
+ "flatPath": "v1/courses/{courseId}/teachers",
+ "path": "v1/courses/{courseId}/teachers",
+ "id": "classroom.courses.teachers.create"
}
}
}
@@ -1569,33 +1641,34 @@
"userId"
],
"httpMethod": "GET",
+ "parameters": {
+ "userId": {
+ "location": "path",
+ "description": "Identifier of the profile to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "required": true,
+ "type": "string"
+ }
+ },
"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": {
- "required": true,
- "type": "string",
- "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"
- }
- }
+ ]
}
},
"resources": {
"guardianInvitations": {
"methods": {
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "studentId"
- ],
+ "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"
@@ -1608,15 +1681,15 @@
"type": "string"
},
"pageToken": {
- "location": "query",
"description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string"
- },
- "invitedEmailAddress": {
- "description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
"type": "string",
"location": "query"
},
+ "invitedEmailAddress": {
+ "location": "query",
+ "description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
+ "type": "string"
+ },
"states": {
"repeated": true,
"location": "query",
@@ -1636,14 +1709,10 @@
}
},
"flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
- "id": "classroom.userProfiles.guardianInvitations.list",
"path": "v1/userProfiles/{studentId}/guardianInvitations",
- "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student."
+ "id": "classroom.userProfiles.guardianInvitations.list"
},
"get": {
- "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
- "id": "classroom.userProfiles.guardianInvitations.get",
- "description": "Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student.",
"response": {
"$ref": "GuardianInvitation"
},
@@ -1664,27 +1733,26 @@
"type": "string"
},
"studentId": {
+ "location": "path",
"description": "The ID of the student whose guardian invitation is being requested.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}"
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "id": "classroom.userProfiles.guardianInvitations.get",
+ "description": "Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student."
},
"patch": {
- "request": {
+ "response": {
"$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.",
- "httpMethod": "PATCH",
"parameterOrder": [
"studentId",
"invitationId"
],
- "response": {
- "$ref": "GuardianInvitation"
- },
+ "httpMethod": "PATCH",
"parameters": {
"invitationId": {
"description": "The `id` field of the `GuardianInvitation` to be modified.",
@@ -1693,30 +1761,30 @@
"location": "path"
},
"updateMask": {
- "location": "query",
"description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `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"
+ "type": "string",
+ "location": "query"
},
"studentId": {
+ "location": "path",
"description": "The ID of the student whose guardian invitation is to be modified.",
"required": true,
- "type": "string",
- "location": "path"
+ "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",
- "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}"
- },
- "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"
},
+ "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom."
+ },
+ "create": {
"response": {
"$ref": "GuardianInvitation"
},
@@ -1724,9 +1792,6 @@
"studentId"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ],
"parameters": {
"studentId": {
"location": "path",
@@ -1735,15 +1800,54 @@
"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"
+ "id": "classroom.userProfiles.guardianInvitations.create",
+ "request": {
+ "$ref": "GuardianInvitation"
+ },
+ "description": "Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user."
}
}
},
"guardians": {
"methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "studentId",
+ "guardianId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "guardianId": {
+ "description": "The `id` field from a `Guardian`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "studentId": {
+ "location": "path",
+ "description": "The student whose guardian is to be deleted. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ],
+ "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "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": {
+ "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"
},
@@ -1751,41 +1855,42 @@
"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": {
+ "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": {
"location": "query",
"description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
"type": "string"
},
"invitedEmailAddress": {
- "location": "query",
"description": "Filter results by the email address that the original invitation was sent\nto, resulting in this guardian link.\nThis filter can only be used by domain administrators.",
- "type": "string"
+ "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": {
- "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"
}
},
+ "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",
"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."
+ "id": "classroom.userProfiles.guardians.list"
},
"get": {
+ "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "id": "classroom.userProfiles.guardians.get",
"description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`.",
"response": {
"$ref": "Guardian"
@@ -1801,53 +1906,20 @@
"https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
],
"parameters": {
+ "guardianId": {
+ "description": "The `id` field from a `Guardian`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
"studentId": {
"description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
"required": true,
"type": "string",
"location": "path"
- },
- "guardianId": {
- "location": "path",
- "description": "The `id` field from a `Guardian`.",
- "required": true,
- "type": "string"
}
},
- "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
- "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
- "id": "classroom.userProfiles.guardians.get"
- },
- "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`.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "studentId",
- "guardianId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "studentId": {
- "location": "path",
- "description": "The student whose guardian is to be deleted. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "type": "string"
- },
- "guardianId": {
- "description": "The `id` field from a `Guardian`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ],
- "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
- "id": "classroom.userProfiles.guardians.delete",
- "path": "v1/userProfiles/{studentId}/guardians/{guardianId}"
+ "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}"
}
}
}
@@ -1856,8 +1928,6 @@
"registrations": {
"methods": {
"delete": {
- "path": "v1/registrations/{registrationId}",
- "id": "classroom.registrations.delete",
"description": "Deletes a `Registration`, causing Classroom to stop sending notifications\nfor that `Registration`.",
"response": {
"$ref": "Empty"
@@ -1868,10 +1938,10 @@
"httpMethod": "DELETE",
"parameters": {
"registrationId": {
- "location": "path",
"description": "The `registration_id` of the `Registration` to be deleted.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -1879,9 +1949,18 @@
"https://www.googleapis.com/auth/classroom.rosters",
"https://www.googleapis.com/auth/classroom.rosters.readonly"
],
- "flatPath": "v1/registrations/{registrationId}"
+ "flatPath": "v1/registrations/{registrationId}",
+ "path": "v1/registrations/{registrationId}",
+ "id": "classroom.registrations.delete"
},
"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"
},
@@ -1892,139 +1971,114 @@
"https://www.googleapis.com/auth/classroom.rosters",
"https://www.googleapis.com/auth/classroom.rosters.readonly"
],
- "parameters": {},
- "flatPath": "v1/registrations",
- "path": "v1/registrations",
- "id": "classroom.registrations.create",
- "description": "Creates a `Registration`, causing Classroom to start sending notifications\nfrom the provided `feed` to the provided `destination`.\n\nReturns the created `Registration`. Currently, this will be the same as\nthe argument, but with server-assigned fields such as `expiry_time` and\n`id` filled in.\n\nNote that any value specified for the `expiry_time` or `id` fields will be\nignored.\n\nWhile Classroom may validate the `destination` and return errors on a best\neffort basis, it is the caller's responsibility to ensure that it exists\nand that Classroom has permission to publish to it.\n\nThis method may return the following error codes:\n\n* `PERMISSION_DENIED` if:\n * the authenticated user does not have permission to receive\n notifications from the requested field; or\n * the credential provided does not include the appropriate scope for the\n requested feed.\n * another access error is encountered.\n* `INVALID_ARGUMENT` if:\n * no `destination` is specified, or the specified `destination` is not\n valid; or\n * no `feed` is specified, or the specified `feed` is not valid.\n* `NOT_FOUND` if:\n * the specified `feed` cannot be located, or the requesting user does not\n have permission to determine whether or not it exists; or\n * the specified `destination` cannot be located, or Classroom has not\n been granted permission to publish to it.",
- "request": {
- "$ref": "Registration"
- }
+ "parameters": {}
}
}
}
},
"parameters": {
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "access_token": {
+ "description": "OAuth access token.",
"type": "string",
"location": "query"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "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"
+ "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"
- },
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"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"
}
},
"schemas": {
- "CourseMaterialSet": {
- "description": "A set of materials that appears on the \"About\" page of the course.\nThese materials might include a syllabus, schedule, or other background\ninformation relating to the course as a whole.",
- "type": "object",
- "properties": {
- "title": {
- "description": "Title for this set.",
- "type": "string"
- },
- "materials": {
- "description": "Materials attached to this set.",
- "type": "array",
- "items": {
- "$ref": "CourseMaterial"
- }
- }
- },
- "id": "CourseMaterialSet"
- },
"ListTeachersResponse": {
"description": "Response when listing teachers.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "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"
@@ -2033,10 +2087,6 @@
"description": "URL item.",
"type": "object",
"properties": {
- "thumbnailUrl": {
- "description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
- "type": "string"
- },
"url": {
"description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
"type": "string"
@@ -2044,6 +2094,10 @@
"title": {
"description": "Title of the target of the URL.\n\nRead-only.",
"type": "string"
+ },
+ "thumbnailUrl": {
+ "description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
+ "type": "string"
}
},
"id": "Link"
@@ -2071,6 +2125,7 @@
"id": "Date"
},
"Name": {
+ "description": "Details of the user's name.",
"type": "object",
"properties": {
"givenName": {
@@ -2086,8 +2141,7 @@
"type": "string"
}
},
- "id": "Name",
- "description": "Details of the user's name."
+ "id": "Name"
},
"Assignment": {
"description": "Additional details for assignments.",
@@ -2107,8 +2161,6 @@
"$ref": "DriveFile"
},
"shareMode": {
- "description": "Mechanism by which students access the Drive item.",
- "type": "string",
"enumDescriptions": [
"No sharing mode specified. This should never be returned.",
"Students can view the shared file.",
@@ -2120,7 +2172,9 @@
"VIEW",
"EDIT",
"STUDENT_COPY"
- ]
+ ],
+ "description": "Mechanism by which students access the Drive item.",
+ "type": "string"
}
},
"id": "SharedDriveFile",
@@ -2128,35 +2182,10 @@
"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"
- },
- "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.",
- "A subset of the students can see the item."
- ],
- "enum": [
- "ASSIGNEE_MODE_UNSPECIFIED",
- "ALL_STUDENTS",
- "INDIVIDUAL_STUDENTS"
- ]
- },
- "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"
+ "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"
},
"GlobalPermission": {
"description": "Global user permission description.",
@@ -2177,14 +2206,35 @@
},
"id": "GlobalPermission"
},
+ "ModifyAnnouncementAssigneesRequest": {
+ "description": "Request to modify assignee mode and options of an announcement.",
+ "type": "object",
+ "properties": {
+ "assigneeMode": {
+ "enumDescriptions": [
+ "No mode specified. This is never returned.",
+ "All students can see the item.\nThis is the default state.",
+ "A subset of the students can see the item."
+ ],
+ "enum": [
+ "ASSIGNEE_MODE_UNSPECIFIED",
+ "ALL_STUDENTS",
+ "INDIVIDUAL_STUDENTS"
+ ],
+ "description": "Mode of the 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"
+ }
+ },
+ "id": "ModifyAnnouncementAssigneesRequest"
+ },
"Teacher": {
"description": "Teacher of a course.",
"type": "object",
"properties": {
- "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"
@@ -2192,6 +2242,10 @@
"profile": {
"description": "Global user information for the teacher.\n\nRead-only.",
"$ref": "UserProfile"
+ },
+ "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"
}
},
"id": "Teacher"
@@ -2200,10 +2254,6 @@
"description": "The history of each grade on this submission.",
"type": "object",
"properties": {
- "actorUserId": {
- "description": "The teacher who made the grade change.",
- "type": "string"
- },
"gradeTimestamp": {
"description": "When the grade of the submission was changed.",
"format": "google-datetime",
@@ -2231,14 +2281,19 @@
"type": "number"
},
"pointsEarned": {
- "type": "number",
"description": "The numerator of the grade at this time in the submission grade history.",
- "format": "double"
+ "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": {
@@ -2249,17 +2304,12 @@
}
}
},
- "id": "AssignmentSubmission",
- "description": "Student work for an assignment."
+ "id": "AssignmentSubmission"
},
"Material": {
"description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
"type": "object",
"properties": {
- "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"
- },
"youtubeVideo": {
"$ref": "YouTubeVideo",
"description": "YouTube video material."
@@ -2271,6 +2321,10 @@
"form": {
"$ref": "Form",
"description": "Google Forms material."
+ },
+ "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"
@@ -2279,23 +2333,23 @@
"description": "A class of notifications that an application can register to receive.\nFor example: \"all roster changes for a domain\".",
"type": "object",
"properties": {
- "courseRosterChangesInfo": {
- "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.\nThis field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`.",
- "$ref": "CourseRosterChangesInfo"
- },
"feedType": {
- "enumDescriptions": [
- "Should never be returned or provided.",
- "All roster changes for a particular domain.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation.",
- "All roster changes for a particular course.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation."
- ],
"enum": [
"FEED_TYPE_UNSPECIFIED",
"DOMAIN_ROSTER_CHANGES",
"COURSE_ROSTER_CHANGES"
],
"description": "The type of feed.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Should never be returned or provided.",
+ "All roster changes for a particular domain.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation.",
+ "All roster changes for a particular course.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation."
+ ]
+ },
+ "courseRosterChangesInfo": {
+ "$ref": "CourseRosterChangesInfo",
+ "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.\nThis field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`."
}
},
"id": "Feed"
@@ -2309,12 +2363,12 @@
"type": "string"
},
"profile": {
- "$ref": "UserProfile",
- "description": "Global user information for the student.\n\nRead-only."
+ "description": "Global user information for the student.\n\nRead-only.",
+ "$ref": "UserProfile"
},
"studentWorkFolder": {
- "$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."
+ "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"
},
"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",
@@ -2324,9 +2378,11 @@
"id": "Student"
},
"Invitation": {
- "description": "An invitation to join a course.",
- "type": "object",
"properties": {
+ "userId": {
+ "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
+ },
"courseId": {
"description": "Identifier of the course to invite the user to.",
"type": "string"
@@ -2350,41 +2406,37 @@
"Teacher of the course.",
"Owner of the course."
]
- },
- "userId": {
- "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string"
}
},
- "id": "Invitation"
+ "id": "Invitation",
+ "description": "An invitation to join a course.",
+ "type": "object"
},
"TurnInStudentSubmissionRequest": {
- "id": "TurnInStudentSubmissionRequest",
"description": "Request to turn in a student submission.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "TurnInStudentSubmissionRequest"
},
"ListCourseWorkResponse": {
"description": "Response when listing course work.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
"courseWork": {
"description": "Course work items that match the request.",
"type": "array",
"items": {
"$ref": "CourseWork"
}
- },
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
}
},
"id": "ListCourseWorkResponse"
},
"Attachment": {
- "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
- "type": "object",
"properties": {
"driveFile": {
"description": "Google Drive file attachment.",
@@ -2403,20 +2455,22 @@
"description": "Link attachment."
}
},
- "id": "Attachment"
+ "id": "Attachment",
+ "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
+ "type": "object"
},
"ListTopicResponse": {
"properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
"topic": {
"description": "Topic items that match the request.",
"type": "array",
"items": {
"$ref": "Topic"
}
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
}
},
"id": "ListTopicResponse",
@@ -2445,11 +2499,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": {
- "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",
@@ -2461,9 +2510,14 @@
"type": "integer"
},
"minutes": {
- "type": "integer",
"description": "Minutes of hour of day. Must be from 0 to 59.",
- "format": "int32"
+ "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"
@@ -2472,22 +2526,21 @@
"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"
},
"Form": {
- "id": "Form",
"description": "Google Forms item.",
"type": "object",
"properties": {
@@ -2507,15 +2560,12 @@
"description": "URL of the form.",
"type": "string"
}
- }
+ },
+ "id": "Form"
},
"ModifyCourseWorkAssigneesRequest": {
- "description": "Request to modify assignee mode and options of a coursework.",
- "type": "object",
"properties": {
"assigneeMode": {
- "description": "Mode of the coursework describing whether it will be assigned to all\nstudents or specified individual students.",
- "type": "string",
"enumDescriptions": [
"No mode specified. This is never returned.",
"All students can see the item.\nThis is the default state.",
@@ -2525,29 +2575,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`."
+ "description": "Set which students are assigned or not assigned to the coursework.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.",
+ "$ref": "ModifyIndividualStudentsOptions"
}
},
- "id": "ModifyCourseWorkAssigneesRequest"
+ "id": "ModifyCourseWorkAssigneesRequest",
+ "description": "Request to modify assignee mode and options of a coursework.",
+ "type": "object"
},
"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"
}
- },
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
}
},
"id": "ListGuardiansResponse"
@@ -2585,16 +2639,16 @@
"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"
- },
- "description": "Guardian invitations that matched the list request."
+ }
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
}
},
"id": "ListGuardianInvitationsResponse"
@@ -2604,74 +2658,75 @@
"type": "object",
"properties": {
"studentIds": {
+ "description": "Identifiers for the students that have access to the\ncoursework/announcement.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "Identifiers for the students that have access to the\ncoursework/announcement."
+ }
}
},
"id": "IndividualStudentsOptions"
},
"MultipleChoiceSubmission": {
+ "description": "Student work for a multiple-choice question.",
+ "type": "object",
"properties": {
"answer": {
"description": "Student's select choice.",
"type": "string"
}
},
- "id": "MultipleChoiceSubmission",
- "description": "Student work for a multiple-choice question.",
- "type": "object"
+ "id": "MultipleChoiceSubmission"
},
"Registration": {
+ "description": "An instruction to Classroom to send notifications from the `feed` to the\nprovided `destination`.",
+ "type": "object",
"properties": {
+ "registrationId": {
+ "description": "A server-generated unique identifier for this `Registration`.\n\nRead-only.",
+ "type": "string"
+ },
"cloudPubsubTopic": {
"$ref": "CloudPubsubTopic",
"description": "The Cloud Pub/Sub topic that notifications are to be sent to."
},
"expiryTime": {
- "type": "string",
"description": "The time until which the `Registration` is effective.\n\nThis is a read-only field assigned by the server.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"feed": {
- "$ref": "Feed",
- "description": "Specification for the class of notifications that Classroom should deliver\nto the `destination`."
- },
- "registrationId": {
- "description": "A server-generated unique identifier for this `Registration`.\n\nRead-only.",
- "type": "string"
+ "description": "Specification for the class of notifications that Classroom should deliver\nto the `destination`.",
+ "$ref": "Feed"
}
},
- "id": "Registration",
- "description": "An instruction to Classroom to send notifications from the `feed` to the\nprovided `destination`.",
- "type": "object"
+ "id": "Registration"
},
"CourseMaterial": {
"description": "A material attached to a course as part of a material set.",
"type": "object",
"properties": {
+ "form": {
+ "$ref": "Form",
+ "description": "Google Forms attachment."
+ },
"link": {
- "$ref": "Link",
- "description": "Link atatchment."
+ "description": "Link atatchment.",
+ "$ref": "Link"
},
"driveFile": {
"$ref": "DriveFile",
"description": "Google Drive file attachment."
},
"youTubeVideo": {
- "description": "Youtube video attachment.",
- "$ref": "YouTubeVideo"
- },
- "form": {
- "$ref": "Form",
- "description": "Google Forms attachment."
+ "$ref": "YouTubeVideo",
+ "description": "Youtube video attachment."
}
},
"id": "CourseMaterial"
},
"MultipleChoiceQuestion": {
+ "description": "Additional details for multiple-choice questions.",
"type": "object",
"properties": {
"choices": {
@@ -2682,53 +2737,10 @@
}
}
},
- "id": "MultipleChoiceQuestion",
- "description": "Additional details for multiple-choice questions."
+ "id": "MultipleChoiceQuestion"
},
"Course": {
- "type": "object",
"properties": {
- "updateTime": {
- "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "calendarId": {
- "description": "The Calendar ID for a calendar that all course members can see, to which\nClassroom adds events for course work and announcements in the course.\n\nRead-only.",
- "type": "string"
- },
- "alternateLink": {
- "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
- "type": "string"
- },
- "guardiansEnabled": {
- "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
- "type": "boolean"
- },
- "courseState": {
- "enum": [
- "COURSE_STATE_UNSPECIFIED",
- "ACTIVE",
- "ARCHIVED",
- "PROVISIONED",
- "DECLINED",
- "SUSPENDED"
- ],
- "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.",
- "type": "string",
- "enumDescriptions": [
- "No course state. No returned Course message will use this value.",
- "The course is active.",
- "The course has been archived. You cannot modify it except to change it\nto a different state.",
- "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be changed to `PROVISIONED` if it is in the `DECLINED`\nstate.",
- "The course has been created, but declined. It is accessible by the\ncourse owner and domain administrators, though it will not be\ndisplayed in the web UI. You cannot modify the course except to change it\nto the `PROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `PROVISIONED`\nstate.",
- "The course has been suspended. You cannot modify the course, and only the\nuser identified by the `owner_id` can view the course.\nA course may be placed in this state if it potentially violates the\nTerms of Service."
- ]
- },
- "ownerId": {
- "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Admins can also specify this field\nin a patch course request to\ntransfer ownership. In other contexts, it is read-only.",
- "type": "string"
- },
"description": {
"description": "Optional description.\nFor example, \"We'll be learning about the structure of living\ncreatures from a combination of textbooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field must be a valid UTF-8 string and no longer than 30,000\ncharacters.",
"type": "string"
@@ -2743,8 +2755,8 @@
"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."
+ "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.",
@@ -2763,8 +2775,12 @@
"type": "string"
},
"courseGroupEmail": {
- "type": "string",
- "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."
+ "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.",
@@ -2773,25 +2789,65 @@
"$ref": "CourseMaterialSet"
}
},
- "enrollmentCode": {
- "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
- "type": "string"
- },
"descriptionHeading": {
"description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.",
"type": "string"
+ },
+ "calendarId": {
+ "description": "The Calendar ID for a calendar that all course members can see, to which\nClassroom adds events for course work and announcements in the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "alternateLink": {
+ "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
+ "type": "string"
+ },
+ "guardiansEnabled": {
+ "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
+ "type": "boolean"
+ },
+ "courseState": {
+ "enumDescriptions": [
+ "No course state. No returned Course message will use this value.",
+ "The course is active.",
+ "The course has been archived. You cannot modify it except to change it\nto a different state.",
+ "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be changed to `PROVISIONED` if it is in the `DECLINED`\nstate.",
+ "The course has been created, but declined. It is accessible by the\ncourse owner and domain administrators, though it will not be\ndisplayed in the web UI. You cannot modify the course except to change it\nto the `PROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `PROVISIONED`\nstate.",
+ "The course has been suspended. You cannot modify the course, and only the\nuser identified by the `owner_id` can view the course.\nA course may be placed in this state if it potentially violates the\nTerms of Service."
+ ],
+ "enum": [
+ "COURSE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "ARCHIVED",
+ "PROVISIONED",
+ "DECLINED",
+ "SUSPENDED"
+ ],
+ "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.",
+ "type": "string"
+ },
+ "ownerId": {
+ "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Admins can also specify this field\nin a patch course request to\ntransfer ownership. In other contexts, it is read-only.",
+ "type": "string"
}
},
"id": "Course",
- "description": "A Course in Classroom."
+ "description": "A Course in Classroom.",
+ "type": "object"
},
"DriveFile": {
- "description": "Representation of a Google Drive file.",
- "type": "object",
"properties": {
+ "title": {
+ "description": "Title of the Drive item.\n\nRead-only.",
+ "type": "string"
+ },
"alternateLink": {
- "type": "string",
- "description": "URL that can be used to access the Drive item.\n\nRead-only."
+ "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.",
@@ -2800,19 +2856,17 @@
"id": {
"description": "Drive API resource ID.",
"type": "string"
- },
- "title": {
- "description": "Title of the Drive item.\n\nRead-only.",
- "type": "string"
}
},
- "id": "DriveFile"
+ "id": "DriveFile",
+ "description": "Representation of a Google Drive file.",
+ "type": "object"
},
"ReturnStudentSubmissionRequest": {
- "description": "Request to return a student submission.",
- "type": "object",
"properties": {},
- "id": "ReturnStudentSubmissionRequest"
+ "id": "ReturnStudentSubmissionRequest",
+ "description": "Request to return a student submission.",
+ "type": "object"
},
"ReclaimStudentSubmissionRequest": {
"description": "Request to reclaim a student submission.",
@@ -2821,28 +2875,20 @@
"id": "ReclaimStudentSubmissionRequest"
},
"CourseRosterChangesInfo": {
- "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.",
- "type": "object",
"properties": {
"courseId": {
"description": "The `course_id` of the course to subscribe to roster changes for.",
"type": "string"
}
},
- "id": "CourseRosterChangesInfo"
+ "id": "CourseRosterChangesInfo",
+ "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.",
+ "type": "object"
},
"Topic": {
"description": "Topic created by a teacher for the course",
"type": "object",
"properties": {
- "topicId": {
- "description": "Unique identifier for the topic.\n\nRead-only.",
- "type": "string"
- },
- "courseId": {
- "type": "string",
- "description": "Identifier of the course.\n\nRead-only."
- },
"updateTime": {
"description": "The time the topic was last updated by the system.\n\nRead-only.",
"format": "google-datetime",
@@ -2851,28 +2897,20 @@
"name": {
"description": "The name of the topic, generated by the user.\nLeading and trailing whitespaces, if any, will be trimmed. Also, multiple\nconsecutive whitespaces will be collapsed into one inside the name.\nTopic names are case sensitive, and must be no longer than 100 characters.",
"type": "string"
+ },
+ "topicId": {
+ "description": "Unique identifier for the topic.\n\nRead-only.",
+ "type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
}
},
"id": "Topic"
},
"CourseWork": {
"properties": {
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only."
- },
- "dueTime": {
- "$ref": "TimeOfDay",
- "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified."
- },
- "title": {
- "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.",
- "type": "string"
- },
"associatedWithDeveloper": {
"description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
"type": "boolean"
@@ -2889,6 +2927,10 @@
"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.",
@@ -2903,18 +2945,12 @@
"description": "Assignee mode of the coursework.\nIf unspecified, the default value is `ALL_STUDENTS`.",
"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"
- },
"maxPoints": {
"description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.",
"format": "double",
"type": "number"
},
"workType": {
- "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",
- "type": "string",
"enumDescriptions": [
"No work type specified. This is never returned.",
"An assignment.",
@@ -2926,15 +2962,17 @@
"ASSIGNMENT",
"SHORT_ANSWER_QUESTION",
"MULTIPLE_CHOICE_QUESTION"
- ]
+ ],
+ "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",
+ "type": "string"
},
"assignment": {
- "$ref": "Assignment",
- "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only."
+ "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only.",
+ "$ref": "Assignment"
},
"multipleChoiceQuestion": {
- "$ref": "MultipleChoiceQuestion",
- "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise."
+ "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.",
@@ -2951,8 +2989,8 @@
"type": "string"
},
"dueDate": {
- "$ref": "Date",
- "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified."
+ "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified.",
+ "$ref": "Date"
},
"individualStudentsOptions": {
"description": "Identifiers of students with access to the coursework.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students\nspecified in this field will be assigned the coursework.",
@@ -2963,6 +3001,8 @@
"type": "string"
},
"state": {
+ "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
+ "type": "string",
"enumDescriptions": [
"No state specified. This is never returned.",
"Status for work that has been published.\nThis is the default state.",
@@ -2974,9 +3014,7 @@
"PUBLISHED",
"DRAFT",
"DELETED"
- ],
- "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
- "type": "string"
+ ]
},
"submissionModificationMode": {
"enumDescriptions": [
@@ -2991,6 +3029,22 @@
],
"description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.",
"type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.",
+ "type": "string"
+ },
+ "dueTime": {
+ "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified.",
+ "$ref": "TimeOfDay"
+ },
+ "title": {
+ "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.",
+ "type": "string"
}
},
"id": "CourseWork",
@@ -3014,13 +3068,14 @@
"type": "string"
},
"guardianProfile": {
- "description": "User profile for the guardian.",
- "$ref": "UserProfile"
+ "$ref": "UserProfile",
+ "description": "User profile for the guardian."
}
},
"id": "Guardian"
},
"ListStudentsResponse": {
+ "description": "Response when listing students.",
"type": "object",
"properties": {
"students": {
@@ -3035,8 +3090,7 @@
"type": "string"
}
},
- "id": "ListStudentsResponse",
- "description": "Response when listing students."
+ "id": "ListStudentsResponse"
},
"UserProfile": {
"description": "Global information for a user.",
@@ -3051,11 +3105,11 @@
"type": "string"
},
"permissions": {
+ "description": "Global permissions of the user.\n\nRead-only.",
"type": "array",
"items": {
"$ref": "GlobalPermission"
- },
- "description": "Global permissions of the user.\n\nRead-only."
+ }
},
"name": {
"$ref": "Name",
@@ -3066,8 +3120,8 @@
"type": "string"
},
"verifiedTeacher": {
- "type": "boolean",
- "description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field will always be false.\n\nRead-only"
+ "description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field will always be false.\n\nRead-only",
+ "type": "boolean"
}
},
"id": "UserProfile"
@@ -3076,25 +3130,21 @@
"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"
},
+ "individualStudentsOptions": {
+ "description": "Identifiers of students with access to the announcement.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this\nfield will be able to see the announcement.",
+ "$ref": "IndividualStudentsOptions"
+ },
"creatorUserId": {
"description": "Identifier for the user that created the announcement.\n\nRead-only.",
"type": "string"
},
- "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": {
+ "description": "Status of this announcement.\nIf unspecified, the default state is `DRAFT`.",
"type": "string",
"enumDescriptions": [
"No state specified. This is never returned.",
@@ -3107,8 +3157,7 @@
"PUBLISHED",
"DRAFT",
"DELETED"
- ],
- "description": "Status of this announcement.\nIf unspecified, the default state is `DRAFT`."
+ ]
},
"text": {
"description": "Description of this announcement.\nThe text must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
@@ -3135,27 +3184,34 @@
"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"
}
},
"id": "Announcement"
},
"ModifyIndividualStudentsOptions": {
+ "description": "Contains fields to add or remove students from a course work or announcement\nwhere the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.",
+ "type": "object",
"properties": {
"addStudentIds": {
"description": "Ids of students to be added as having access to this\ncoursework/announcement.",
@@ -3172,18 +3228,12 @@
}
}
},
- "id": "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"
+ "id": "ModifyIndividualStudentsOptions"
},
"DriveFolder": {
"description": "Representation of a Google Drive folder.",
"type": "object",
"properties": {
- "alternateLink": {
- "type": "string",
- "description": "URL that can be used to access the Drive folder.\n\nRead-only."
- },
"id": {
"description": "Drive API resource ID.",
"type": "string"
@@ -3191,16 +3241,19 @@
"title": {
"description": "Title of the Drive folder.\n\nRead-only.",
"type": "string"
+ },
+ "alternateLink": {
+ "description": "URL that can be used to access the Drive folder.\n\nRead-only.",
+ "type": "string"
}
},
"id": "DriveFolder"
},
"SubmissionHistory": {
- "type": "object",
"properties": {
"gradeHistory": {
- "$ref": "GradeHistory",
- "description": "The grade history information of the submission, if present."
+ "description": "The grade history information of the submission, if present.",
+ "$ref": "GradeHistory"
},
"stateHistory": {
"$ref": "StateHistory",
@@ -3208,9 +3261,11 @@
}
},
"id": "SubmissionHistory",
- "description": "The history of the submission. This currently includes state and grade\nhistories."
+ "description": "The history of the submission. This currently includes state and grade\nhistories.",
+ "type": "object"
},
"ShortAnswerSubmission": {
+ "description": "Student work for a short answer question.",
"type": "object",
"properties": {
"answer": {
@@ -3218,40 +3273,33 @@
"type": "string"
}
},
- "id": "ShortAnswerSubmission",
- "description": "Student work for a short answer question."
- },
- "ListStudentSubmissionsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
- "studentSubmissions": {
- "description": "Student work that matches the request.",
- "type": "array",
- "items": {
- "$ref": "StudentSubmission"
- }
- }
- },
- "id": "ListStudentSubmissionsResponse",
- "description": "Response when listing student submissions."
+ "id": "ShortAnswerSubmission"
},
"StudentSubmission": {
+ "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.",
"type": "object",
"properties": {
- "late": {
- "description": "Whether this submission is late.\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"
},
"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": {
+ "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.",
@@ -3263,9 +3311,7 @@
"ASSIGNMENT",
"SHORT_ANSWER_QUESTION",
"MULTIPLE_CHOICE_QUESTION"
- ],
- "description": "Type of course work this submission is for.\n\nRead-only.",
- "type": "string"
+ ]
},
"creationTime": {
"description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
@@ -3273,6 +3319,14 @@
"type": "string"
},
"state": {
+ "enumDescriptions": [
+ "No state specified. This should never be returned.",
+ "The student has never accessed this submission. Attachments are not\nreturned and timestamps is not set.",
+ "Has been created.",
+ "Has been turned in to the teacher.",
+ "Has been returned to the student.",
+ "Student chose to \"unsubmit\" the assignment."
+ ],
"enum": [
"SUBMISSION_STATE_UNSPECIFIED",
"NEW",
@@ -3282,23 +3336,15 @@
"RECLAIMED_BY_STUDENT"
],
"description": "State of this submission.\n\nRead-only.",
- "type": "string",
- "enumDescriptions": [
- "No state specified. This should never be returned.",
- "The student has never accessed this submission. Attachments are not\nreturned and timestamps is not set.",
- "Has been created.",
- "Has been turned in to the teacher.",
- "Has been returned to the student.",
- "Student chose to \"unsubmit\" the assignment."
- ]
+ "type": "string"
},
"userId": {
- "type": "string",
- "description": "Identifier for the student that owns this submission.\n\nRead-only."
+ "description": "Identifier for the student that owns this submission.\n\nRead-only.",
+ "type": "string"
},
"courseWorkId": {
- "type": "string",
- "description": "Identifier for the course work this corresponds to.\n\nRead-only."
+ "description": "Identifier for the course work this corresponds to.\n\nRead-only.",
+ "type": "string"
},
"courseId": {
"description": "Identifier of the course.\n\nRead-only.",
@@ -3321,33 +3367,41 @@
"type": "number"
},
"multipleChoiceSubmission": {
- "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.",
- "$ref": "MultipleChoiceSubmission"
+ "$ref": "MultipleChoiceSubmission",
+ "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
},
"assignmentSubmission": {
- "$ref": "AssignmentSubmission",
- "description": "Submission content when course_work_type is ASSIGNMENT.\n\nStudents can modify this content using\ngoogle.classroom.Work.ModifyAttachments."
+ "description": "Submission content when course_work_type is ASSIGNMENT.\n\nStudents can modify this content using\ngoogle.classroom.Work.ModifyAttachments.",
+ "$ref": "AssignmentSubmission"
},
"associatedWithDeveloper": {
- "type": "boolean",
- "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."
+ "description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
+ "type": "boolean"
},
"shortAnswerSubmission": {
- "$ref": "ShortAnswerSubmission",
- "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
- },
- "updateTime": {
- "type": "string",
- "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"
- },
- "alternateLink": {
- "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.",
- "type": "string"
+ "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION.",
+ "$ref": "ShortAnswerSubmission"
}
},
- "id": "StudentSubmission",
- "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time."
+ "id": "StudentSubmission"
+ },
+ "ListStudentSubmissionsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
+ "studentSubmissions": {
+ "description": "Student work that matches the request.",
+ "type": "array",
+ "items": {
+ "$ref": "StudentSubmission"
+ }
+ }
+ },
+ "id": "ListStudentSubmissionsResponse",
+ "description": "Response when listing student submissions.",
+ "type": "object"
},
"ModifyAttachmentsRequest": {
"properties": {
@@ -3380,8 +3434,8 @@
"type": "string"
},
"title": {
- "type": "string",
- "description": "Title of the YouTube video.\n\nRead-only."
+ "description": "Title of the YouTube video.\n\nRead-only.",
+ "type": "string"
}
},
"id": "YouTubeVideo"
@@ -3395,11 +3449,11 @@
"type": "string"
},
"invitations": {
+ "description": "Invitations that match the list request.",
"type": "array",
"items": {
"$ref": "Invitation"
- },
- "description": "Invitations that match the list request."
+ }
}
},
"id": "ListInvitationsResponse"
@@ -3419,6 +3473,10 @@
"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",
@@ -3433,6 +3491,8 @@
"type": "string"
},
"state": {
+ "description": "The state that this invitation is in.",
+ "type": "string",
"enumDescriptions": [
"Should never be returned.",
"The invitation is active and awaiting a response.",
@@ -3442,13 +3502,7 @@
"GUARDIAN_INVITATION_STATE_UNSPECIFIED",
"PENDING",
"COMPLETE"
- ],
- "description": "The state that this invitation is in.",
- "type": "string"
- },
- "invitedEmailAddress": {
- "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
- "type": "string"
+ ]
}
},
"id": "GuardianInvitation"
@@ -3458,14 +3512,6 @@
"type": "object",
"properties": {
"state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "CREATED",
- "TURNED_IN",
- "RETURNED",
- "RECLAIMED_BY_STUDENT",
- "STUDENT_EDITED_AFTER_TURN_IN"
- ],
"description": "The workflow pipeline stage.",
"type": "string",
"enumDescriptions": [
@@ -3475,6 +3521,14 @@
"The teacher has returned the assigned document to the student.",
"The student turned in the assigned document, and then chose to\n\"unsubmit\" the assignment, giving the student control again as the\nowner.",
"The student edited their submission after turning it in. Currently,\nonly used by Questions, when the student edits their answer."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "CREATED",
+ "TURNED_IN",
+ "RETURNED",
+ "RECLAIMED_BY_STUDENT",
+ "STUDENT_EDITED_AFTER_TURN_IN"
]
},
"stateTimestamp": {
@@ -3488,85 +3542,31 @@
}
},
"id": "StateHistory"
+ },
+ "CourseMaterialSet": {
+ "description": "A set of materials that appears on the \"About\" page of the course.\nThese materials might include a syllabus, schedule, or other background\ninformation relating to the course as a whole.",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "Title for this set.",
+ "type": "string"
+ },
+ "materials": {
+ "description": "Materials attached to this set.",
+ "type": "array",
+ "items": {
+ "$ref": "CourseMaterial"
+ }
+ }
+ },
+ "id": "CourseMaterialSet"
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"version": "v1",
- "baseUrl": "https://classroom.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/classroom.rosters.readonly": {
- "description": "View your Google Classroom class rosters"
- },
- "https://www.googleapis.com/auth/classroom.profile.photos": {
- "description": "View the profile photos of people in your classes"
- },
- "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"
- },
- "https://www.googleapis.com/auth/classroom.push-notifications": {
- "description": "Receive notifications about your Google Classroom data"
- },
- "https://www.googleapis.com/auth/classroom.rosters": {
- "description": "Manage your Google Classroom class rosters"
- },
- "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": {
- "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
- },
- "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly": {
- "description": "View guardians for students in your Google Classroom classes"
- },
- "https://www.googleapis.com/auth/classroom.courses": {
- "description": "Manage your Google Classroom classes"
- },
- "https://www.googleapis.com/auth/classroom.courses.readonly": {
- "description": "View your Google Classroom classes"
- },
- "https://www.googleapis.com/auth/classroom.announcements": {
- "description": "View and manage announcements in Google Classroom"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "description": "Manages classes, rosters, and invitations in Google Classroom.",
- "servicePath": "",
- "rootUrl": "https://classroom.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "classroom",
- "batchPath": "batch",
- "revision": "20180123",
- "id": "classroom:v1",
- "documentationLink": "https://developers.google.com/classroom/",
- "title": "Google Classroom API"
+ "baseUrl": "https://classroom.googleapis.com/"
}
diff --git a/cloudbilling/v1/cloudbilling-api.json b/cloudbilling/v1/cloudbilling-api.json
index d6b0cb8..c905aa6 100644
--- a/cloudbilling/v1/cloudbilling-api.json
+++ b/cloudbilling/v1/cloudbilling-api.json
@@ -1,438 +1,6 @@
{
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "getBillingInfo": {
- "description": "Gets the billing information for a project. The current authenticated user\nmust have [permission to view the\nproject](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n).",
- "response": {
- "$ref": "ProjectBillingInfo"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The resource name of the project for which billing information is\nretrieved. For example, `projects/tokyo-rain-123`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/billingInfo",
- "path": "v1/{+name}/billingInfo",
- "id": "cloudbilling.projects.getBillingInfo"
- },
- "updateBillingInfo": {
- "response": {
- "$ref": "ProjectBillingInfo"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The resource name of the project associated with the billing information\nthat you want to update. For example, `projects/tokyo-rain-123`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/billingInfo",
- "path": "v1/{+name}/billingInfo",
- "id": "cloudbilling.projects.updateBillingInfo",
- "description": "Sets or updates the billing account associated with a project. You specify\nthe new billing account by setting the `billing_account_name` in the\n`ProjectBillingInfo` resource to the resource name of a billing account.\nAssociating a project with an open billing account enables billing on the\nproject and allows charges for resource usage. If the project already had a\nbilling account, this method changes the billing account used for resource\nusage charges.\n\n*Note:* Incurred charges that have not yet been reported in the transaction\nhistory of the Google Cloud Console may be billed to the new billing\naccount, even if the charge occurred before the new billing account was\nassigned to the project.\n\nThe current authenticated user must have ownership privileges for both the\n[project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n) and the [billing\naccount](https://support.google.com/cloud/answer/4430947).\n\nYou can disable billing on the project by setting the\n`billing_account_name` field to empty. This action disassociates the\ncurrent billing account from the project. Any billable activity of your\nin-use services will stop, and your application could stop functioning as\nexpected. Any unbilled charges to date will be billed to the previously\nassociated account. The current authenticated user must be either an owner\nof the project or an owner of the billing account for the project.\n\nNote that associating a project with a *closed* billing account will have\nmuch the same effect as disabling billing on the project: any paid\nresources used by the project will be shut down. Thus, unless you wish to\ndisable billing, you should always call this method with the name of an\n*open* billing account.",
- "request": {
- "$ref": "ProjectBillingInfo"
- }
- }
- }
- },
- "billingAccounts": {
- "methods": {
- "get": {
- "response": {
- "$ref": "BillingAccount"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path",
- "description": "The resource name of the billing account to retrieve. For example,\n`billingAccounts/012345-567890-ABCDEF`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/billingAccounts/{billingAccountsId}",
- "path": "v1/{+name}",
- "id": "cloudbilling.billingAccounts.get",
- "description": "Gets information about a billing account. The current authenticated user\nmust be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947)."
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListBillingAccountsResponse"
- },
- "parameterOrder": [],
- "parameters": {
- "pageToken": {
- "description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListBillingAccounts`\ncall. If unspecified, the first page of results is returned.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/billingAccounts",
- "id": "cloudbilling.billingAccounts.list",
- "path": "v1/billingAccounts",
- "description": "Lists the billing accounts that the current authenticated user\n[owns](https://support.google.com/cloud/answer/4430947)."
- }
- },
- "resources": {
- "projects": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListProjectBillingInfoResponse"
- },
- "parameters": {
- "name": {
- "description": "The resource name of the billing account associated with the projects that\nyou want to list. For example, `billingAccounts/012345-567890-ABCDEF`.",
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous `ListProjectBillingInfo`\ncall. If unspecified, the first page of results is returned.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/billingAccounts/{billingAccountsId}/projects",
- "id": "cloudbilling.billingAccounts.projects.list",
- "path": "v1/{+name}/projects",
- "description": "Lists the projects associated with a billing account. The current\nauthenticated user must have the \"billing.resourceAssociations.list\" IAM\npermission, which is often given to billing account\n[viewers](https://support.google.com/cloud/answer/4430947)."
- }
- }
- }
- }
- },
- "services": {
- "resources": {
- "skus": {
- "methods": {
- "list": {
- "description": "Lists all publicly available SKUs for a given cloud service.",
- "response": {
- "$ref": "ListSkusResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "endTime": {
- "description": "Optional exclusive end time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nThe time range has to be within a single calendar month in\nAmerica/Los_Angeles timezone. Time range as a whole is optional. If not\nspecified, the latest pricing will be returned (up to 12 hours old at\nmost).",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListSkus`\ncall. If unspecified, the first page of results is returned.",
- "type": "string"
- },
- "startTime": {
- "description": "Optional inclusive start time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nThe time range has to be within a single calendar month in\nAmerica/Los_Angeles timezone. Time range as a whole is optional. If not\nspecified, the latest pricing will be returned (up to 12 hours old at\nmost).",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. Defaults to 5000.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "pattern": "^services/[^/]+$",
- "location": "path",
- "description": "The name of the service.\nExample: \"services/DA34-426B-A397\"",
- "required": true,
- "type": "string"
- },
- "currencyCode": {
- "description": "The ISO 4217 currency code for the pricing info in the response proto.\nWill use the conversion rate as of start_time.\nOptional. If not specified USD will be used.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/services/{servicesId}/skus",
- "path": "v1/{+parent}/skus",
- "id": "cloudbilling.services.skus.list"
- }
- }
- }
- },
- "methods": {
- "list": {
- "path": "v1/services",
- "id": "cloudbilling.services.list",
- "description": "Lists all public cloud services.",
- "response": {
- "$ref": "ListServicesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListServices`\ncall. If unspecified, the first page of results is returned.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. Defaults to 5000.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1/services"
- }
- }
- }
- },
- "parameters": {
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- }
- },
- "version": "v1",
- "baseUrl": "https://cloudbilling.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Allows developers to manage billing for their Google Cloud Platform projects\n programmatically.",
- "servicePath": "",
- "basePath": "",
- "revision": "20180122",
- "documentationLink": "https://cloud.google.com/billing/",
- "id": "cloudbilling:v1",
- "discoveryVersion": "v1",
"schemas": {
- "TierRate": {
- "description": "The price rate indicating starting usage and its corresponding price.",
- "type": "object",
- "properties": {
- "unitPrice": {
- "description": "The price per unit of usage.\nExample: unit_price of amount $10 indicates that each unit will cost $10.",
- "$ref": "Money"
- },
- "startUsageAmount": {
- "description": "Usage is priced at this rate only after this amount.\nExample: start_usage_amount of 10 indicates that the usage will be priced\nat the unit_price after the first 10 usage_units.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "TierRate"
- },
- "ListServicesResponse": {
- "description": "Response message for `ListServices`.",
- "type": "object",
- "properties": {
- "services": {
- "description": "A list of services.",
- "type": "array",
- "items": {
- "$ref": "Service"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListServices` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve.",
- "type": "string"
- }
- },
- "id": "ListServicesResponse"
- },
- "ListBillingAccountsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListBillingAccounts` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve.",
- "type": "string"
- },
- "billingAccounts": {
- "description": "A list of billing accounts.",
- "type": "array",
- "items": {
- "$ref": "BillingAccount"
- }
- }
- },
- "id": "ListBillingAccountsResponse",
- "description": "Response message for `ListBillingAccounts`.",
- "type": "object"
- },
- "AggregationInfo": {
- "properties": {
- "aggregationLevel": {
- "enum": [
- "AGGREGATION_LEVEL_UNSPECIFIED",
- "ACCOUNT",
- "PROJECT"
- ],
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "aggregationInterval": {
- "enum": [
- "AGGREGATION_INTERVAL_UNSPECIFIED",
- "DAILY",
- "MONTHLY"
- ],
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "aggregationCount": {
- "description": "The number of intervals to aggregate over.\nExample: If aggregation_level is \"DAILY\" and aggregation_count is 14,\naggregation will be over 14 days.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AggregationInfo",
- "description": "Represents the aggregation level and interval for pricing of a single SKU.",
- "type": "object"
- },
"Service": {
- "description": "Encapsulates a single service in Google Cloud Platform.",
- "type": "object",
"properties": {
"name": {
"description": "The resource name for the service.\nExample: \"services/DA34-426B-A397\"",
@@ -447,11 +15,11 @@
"type": "string"
}
},
- "id": "Service"
+ "id": "Service",
+ "description": "Encapsulates a single service in Google Cloud Platform.",
+ "type": "object"
},
"Money": {
- "description": "Represents an amount of money with its currency type.",
- "type": "object",
"properties": {
"currencyCode": {
"description": "The 3-letter currency code defined in ISO 4217.",
@@ -468,11 +36,11 @@
"type": "string"
}
},
- "id": "Money"
+ "id": "Money",
+ "description": "Represents an amount of money with its currency type.",
+ "type": "object"
},
"ProjectBillingInfo": {
- "description": "Encapsulation of billing information for a Cloud Console project. A project\nhas at most one associated billing account at a time (but a billing account\ncan be assigned to multiple projects).",
- "type": "object",
"properties": {
"name": {
"description": "The resource name for the `ProjectBillingInfo`; has the form\n`projects/{project_id}/billingInfo`. For example, the resource name for the\nbilling information for project `tokyo-rain-123` would be\n`projects/tokyo-rain-123/billingInfo`. This field is read-only.",
@@ -491,7 +59,9 @@
"type": "string"
}
},
- "id": "ProjectBillingInfo"
+ "id": "ProjectBillingInfo",
+ "description": "Encapsulation of billing information for a Cloud Console project. A project\nhas at most one associated billing account at a time (but a billing account\ncan be assigned to multiple projects).",
+ "type": "object"
},
"BillingAccount": {
"description": "A billing account in [Google Cloud\nConsole](https://console.cloud.google.com/). You can assign a billing account\nto one or more projects.",
@@ -516,6 +86,18 @@
"description": "Encapsulates a single SKU in Google Cloud Platform",
"type": "object",
"properties": {
+ "skuId": {
+ "description": "The identifier for the SKU.\nExample: \"AA95-CD31-42FE\"",
+ "type": "string"
+ },
+ "description": {
+ "description": "A human readable description of the SKU, has a maximum length of 256\ncharacters.",
+ "type": "string"
+ },
+ "serviceProviderName": {
+ "description": "Identifies the service provider.\nThis is 'Google' for first party services in Google Cloud Platform.",
+ "type": "string"
+ },
"serviceRegions": {
"description": "List of service regions this SKU is offered at.\nExample: \"asia-east1\"\nService regions can be found at https://cloud.google.com/about/locations/",
"type": "array",
@@ -537,32 +119,14 @@
"category": {
"$ref": "Category",
"description": "The category hierarchy of this SKU, purely for organizational purpose."
- },
- "skuId": {
- "description": "The identifier for the SKU.\nExample: \"AA95-CD31-42FE\"",
- "type": "string"
- },
- "description": {
- "description": "A human readable description of the SKU, has a maximum length of 256\ncharacters.",
- "type": "string"
- },
- "serviceProviderName": {
- "description": "Identifies the service provider.\nThis is 'Google' for first party services in Google Cloud Platform.",
- "type": "string"
}
},
"id": "Sku"
},
"Category": {
+ "description": "Represents the category hierarchy of a SKU.",
+ "type": "object",
"properties": {
- "resourceFamily": {
- "description": "The type of product the SKU refers to.\nExample: \"Compute\", \"Storage\", \"Network\", \"ApplicationServices\" etc.",
- "type": "string"
- },
- "resourceGroup": {
- "description": "A group classification for related SKUs.\nExample: \"RAM\", \"GPU\", \"Prediction\", \"Ops\", \"GoogleEgress\" etc.",
- "type": "string"
- },
"serviceDisplayName": {
"description": "The display name of the service this SKU belongs to.",
"type": "string"
@@ -570,11 +134,17 @@
"usageType": {
"description": "Represents how the SKU is consumed.\nExample: \"OnDemand\", \"Preemptible\", \"Commit1Mo\", \"Commit1Yr\" etc.",
"type": "string"
+ },
+ "resourceFamily": {
+ "description": "The type of product the SKU refers to.\nExample: \"Compute\", \"Storage\", \"Network\", \"ApplicationServices\" etc.",
+ "type": "string"
+ },
+ "resourceGroup": {
+ "description": "A group classification for related SKUs.\nExample: \"RAM\", \"GPU\", \"Prediction\", \"Ops\", \"GoogleEgress\" etc.",
+ "type": "string"
}
},
- "id": "Category",
- "description": "Represents the category hierarchy of a SKU.",
- "type": "object"
+ "id": "Category"
},
"ListSkusResponse": {
"properties": {
@@ -595,6 +165,8 @@
"type": "object"
},
"PricingInfo": {
+ "description": "Represents the pricing information for a SKU at a single point of time.",
+ "type": "object",
"properties": {
"effectiveTime": {
"description": "The timestamp from which this pricing was effective within the requested\ntime range. This is guaranteed to be greater than or equal to the\nstart_time field in the request and less than the end_time field in the\nrequest. If a time range was not specified in the request this field will\nbe equivalent to a time within the last 12 hours, indicating the latest\npricing info.",
@@ -607,25 +179,21 @@
"type": "number"
},
"pricingExpression": {
- "$ref": "PricingExpression",
- "description": "Expresses the pricing formula. See `PricingExpression` for an example."
+ "description": "Expresses the pricing formula. See `PricingExpression` for an example.",
+ "$ref": "PricingExpression"
},
"aggregationInfo": {
- "description": "Aggregation Info. This can be left unspecified if the pricing expression\ndoesn't require aggregation.",
- "$ref": "AggregationInfo"
+ "$ref": "AggregationInfo",
+ "description": "Aggregation Info. This can be left unspecified if the pricing expression\ndoesn't require aggregation."
},
"summary": {
"description": "An optional human readable summary of the pricing information, has a\nmaximum length of 256 characters.",
"type": "string"
}
},
- "id": "PricingInfo",
- "description": "Represents the pricing information for a SKU at a single point of time.",
- "type": "object"
+ "id": "PricingInfo"
},
"ListProjectBillingInfoResponse": {
- "description": "Request message for `ListProjectBillingInfoResponse`.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListProjectBillingInfo` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve.",
@@ -639,9 +207,13 @@
}
}
},
- "id": "ListProjectBillingInfoResponse"
+ "id": "ListProjectBillingInfoResponse",
+ "description": "Request message for `ListProjectBillingInfoResponse`.",
+ "type": "object"
},
"PricingExpression": {
+ "description": "Expresses a mathematical pricing formula. For Example:-\n\n`usage_unit: GBy`\n`tiered_rates:`\n `[start_usage_amount: 20, unit_price: $10]`\n `[start_usage_amount: 100, unit_price: $5]`\n\nThe above expresses a pricing formula where the first 20GB is free, the\nnext 80GB is priced at $10 per GB followed by $5 per GB for additional\nusage.",
+ "type": "object",
"properties": {
"baseUnit": {
"description": "The base unit for the SKU which is the unit used in usage exports.\nExample: \"By\"",
@@ -677,16 +249,104 @@
"type": "number"
}
},
- "id": "PricingExpression",
- "description": "Expresses a mathematical pricing formula. For Example:-\n\n`usage_unit: GBy`\n`tiered_rates:`\n `[start_usage_amount: 20, unit_price: $10]`\n `[start_usage_amount: 100, unit_price: $5]`\n\nThe above expresses a pricing formula where the first 20GB is free, the\nnext 80GB is priced at $10 per GB followed by $5 per GB for additional\nusage.",
+ "id": "PricingExpression"
+ },
+ "TierRate": {
+ "description": "The price rate indicating starting usage and its corresponding price.",
+ "type": "object",
+ "properties": {
+ "startUsageAmount": {
+ "description": "Usage is priced at this rate only after this amount.\nExample: start_usage_amount of 10 indicates that the usage will be priced\nat the unit_price after the first 10 usage_units.",
+ "format": "double",
+ "type": "number"
+ },
+ "unitPrice": {
+ "description": "The price per unit of usage.\nExample: unit_price of amount $10 indicates that each unit will cost $10.",
+ "$ref": "Money"
+ }
+ },
+ "id": "TierRate"
+ },
+ "ListServicesResponse": {
+ "description": "Response message for `ListServices`.",
+ "type": "object",
+ "properties": {
+ "services": {
+ "description": "A list of services.",
+ "type": "array",
+ "items": {
+ "$ref": "Service"
+ }
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListServices` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve.",
+ "type": "string"
+ }
+ },
+ "id": "ListServicesResponse"
+ },
+ "ListBillingAccountsResponse": {
+ "description": "Response message for `ListBillingAccounts`.",
+ "type": "object",
+ "properties": {
+ "billingAccounts": {
+ "description": "A list of billing accounts.",
+ "type": "array",
+ "items": {
+ "$ref": "BillingAccount"
+ }
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListBillingAccounts` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve.",
+ "type": "string"
+ }
+ },
+ "id": "ListBillingAccountsResponse"
+ },
+ "AggregationInfo": {
+ "properties": {
+ "aggregationInterval": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "AGGREGATION_INTERVAL_UNSPECIFIED",
+ "DAILY",
+ "MONTHLY"
+ ],
+ "type": "string"
+ },
+ "aggregationCount": {
+ "description": "The number of intervals to aggregate over.\nExample: If aggregation_level is \"DAILY\" and aggregation_count is 14,\naggregation will be over 14 days.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "aggregationLevel": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "AGGREGATION_LEVEL_UNSPECIFIED",
+ "ACCOUNT",
+ "PROJECT"
+ ],
+ "type": "string"
+ }
+ },
+ "id": "AggregationInfo",
+ "description": "Represents the aggregation level and interval for pricing of a single SKU.",
"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": "Cloudbilling",
"auth": {
"oauth2": {
@@ -702,5 +362,345 @@
"name": "cloudbilling",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Billing API"
+ "title": "Google Cloud Billing API",
+ "ownerName": "Google",
+ "resources": {
+ "services": {
+ "resources": {
+ "skus": {
+ "methods": {
+ "list": {
+ "id": "cloudbilling.services.skus.list",
+ "path": "v1/{+parent}/skus",
+ "description": "Lists all publicly available SKUs for a given cloud service.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListSkusResponse"
+ },
+ "parameters": {
+ "currencyCode": {
+ "description": "The ISO 4217 currency code for the pricing info in the response proto.\nWill use the conversion rate as of start_time.\nOptional. If not specified USD will be used.",
+ "type": "string",
+ "location": "query"
+ },
+ "endTime": {
+ "description": "Optional exclusive end time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nThe time range has to be within a single calendar month in\nAmerica/Los_Angeles timezone. Time range as a whole is optional. If not\nspecified, the latest pricing will be returned (up to 12 hours old at\nmost).",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListSkus`\ncall. If unspecified, the first page of results is returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "startTime": {
+ "location": "query",
+ "description": "Optional inclusive start time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nThe time range has to be within a single calendar month in\nAmerica/Los_Angeles timezone. Time range as a whole is optional. If not\nspecified, the latest pricing will be returned (up to 12 hours old at\nmost).",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. Defaults to 5000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "The name of the service.\nExample: \"services/DA34-426B-A397\"",
+ "required": true,
+ "type": "string",
+ "pattern": "^services/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{servicesId}/skus"
+ }
+ }
+ }
+ },
+ "methods": {
+ "list": {
+ "description": "Lists all public cloud services.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListServices`\ncall. If unspecified, the first page of results is returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. Defaults to 5000.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1/services",
+ "id": "cloudbilling.services.list",
+ "path": "v1/services"
+ }
+ }
+ },
+ "projects": {
+ "methods": {
+ "getBillingInfo": {
+ "response": {
+ "$ref": "ProjectBillingInfo"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the project for which billing information is\nretrieved. For example, `projects/tokyo-rain-123`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/billingInfo",
+ "path": "v1/{+name}/billingInfo",
+ "id": "cloudbilling.projects.getBillingInfo",
+ "description": "Gets the billing information for a project. The current authenticated user\nmust have [permission to view the\nproject](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n)."
+ },
+ "updateBillingInfo": {
+ "path": "v1/{+name}/billingInfo",
+ "id": "cloudbilling.projects.updateBillingInfo",
+ "description": "Sets or updates the billing account associated with a project. You specify\nthe new billing account by setting the `billing_account_name` in the\n`ProjectBillingInfo` resource to the resource name of a billing account.\nAssociating a project with an open billing account enables billing on the\nproject and allows charges for resource usage. If the project already had a\nbilling account, this method changes the billing account used for resource\nusage charges.\n\n*Note:* Incurred charges that have not yet been reported in the transaction\nhistory of the Google Cloud Console may be billed to the new billing\naccount, even if the charge occurred before the new billing account was\nassigned to the project.\n\nThe current authenticated user must have ownership privileges for both the\n[project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n) and the [billing\naccount](https://support.google.com/cloud/answer/4430947).\n\nYou can disable billing on the project by setting the\n`billing_account_name` field to empty. This action disassociates the\ncurrent billing account from the project. Any billable activity of your\nin-use services will stop, and your application could stop functioning as\nexpected. Any unbilled charges to date will be billed to the previously\nassociated account. The current authenticated user must be either an owner\nof the project or an owner of the billing account for the project.\n\nNote that associating a project with a *closed* billing account will have\nmuch the same effect as disabling billing on the project: any paid\nresources used by the project will be shut down. Thus, unless you wish to\ndisable billing, you should always call this method with the name of an\n*open* billing account.",
+ "request": {
+ "$ref": "ProjectBillingInfo"
+ },
+ "response": {
+ "$ref": "ProjectBillingInfo"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the project associated with the billing information\nthat you want to update. For example, `projects/tokyo-rain-123`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/billingInfo"
+ }
+ }
+ },
+ "billingAccounts": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "BillingAccount"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the billing account to retrieve. For example,\n`billingAccounts/012345-567890-ABCDEF`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/billingAccounts/{billingAccountsId}",
+ "path": "v1/{+name}",
+ "id": "cloudbilling.billingAccounts.get",
+ "description": "Gets information about a billing account. The current authenticated user\nmust be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947)."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListBillingAccountsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListBillingAccounts`\ncall. If unspecified, the first page of results is returned.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/billingAccounts",
+ "path": "v1/billingAccounts",
+ "id": "cloudbilling.billingAccounts.list",
+ "description": "Lists the billing accounts that the current authenticated user\n[owns](https://support.google.com/cloud/answer/4430947)."
+ }
+ },
+ "resources": {
+ "projects": {
+ "methods": {
+ "list": {
+ "path": "v1/{+name}/projects",
+ "id": "cloudbilling.billingAccounts.projects.list",
+ "description": "Lists the projects associated with a billing account. The current\nauthenticated user must have the \"billing.resourceAssociations.list\" IAM\npermission, which is often given to billing account\n[viewers](https://support.google.com/cloud/answer/4430947).",
+ "response": {
+ "$ref": "ListProjectBillingInfoResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^billingAccounts/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the billing account associated with the projects that\nyou want to list. For example, `billingAccounts/012345-567890-ABCDEF`.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous `ListProjectBillingInfo`\ncall. If unspecified, the first page of results is returned.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1/billingAccounts/{billingAccountsId}/projects"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "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://cloudbilling.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Allows developers to manage billing for their Google Cloud Platform projects\n programmatically.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "cloudbilling:v1",
+ "documentationLink": "https://cloud.google.com/billing/",
+ "revision": "20180122",
+ "discoveryVersion": "v1"
}
diff --git a/cloudbuild/v1/cloudbuild-api.json b/cloudbuild/v1/cloudbuild-api.json
index fc8e912..bad5e76 100644
--- a/cloudbuild/v1/cloudbuild-api.json
+++ b/cloudbuild/v1/cloudbuild-api.json
@@ -1,18 +1,164 @@
{
+ "kind": "discovery#restDescription",
+ "description": "Builds container images in the cloud.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "cloudbuild:v1",
+ "documentationLink": "https://cloud.google.com/container-builder/docs/",
+ "revision": "20180124",
+ "discoveryVersion": "v1",
+ "version_module": true,
"schemas": {
+ "TimeSpan": {
+ "description": "Stores start and end times for a build execution phase.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "type": "string",
+ "description": "End of time span.",
+ "format": "google-datetime"
+ },
+ "startTime": {
+ "type": "string",
+ "description": "Start of time span.",
+ "format": "google-datetime"
+ }
+ },
+ "id": "TimeSpan"
+ },
+ "BuildOptions": {
+ "description": "Optional arguments to enable specific features of builds.",
+ "type": "object",
+ "properties": {
+ "machineType": {
+ "type": "string",
+ "enumDescriptions": [
+ "Standard machine type.",
+ "Highcpu machine with 8 CPUs.",
+ "Highcpu machine with 32 CPUs."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "N1_HIGHCPU_8",
+ "N1_HIGHCPU_32"
+ ],
+ "description": "Compute Engine machine type on which to run the build."
+ },
+ "logStreamingOption": {
+ "type": "string",
+ "enumDescriptions": [
+ "Service may automatically determine build log streaming behavior.",
+ "Build logs should be streamed to Google Cloud Storage.",
+ "Build logs should not be streamed to Google Cloud Storage; they will be\nwritten when the build is completed."
+ ],
+ "enum": [
+ "STREAM_DEFAULT",
+ "STREAM_ON",
+ "STREAM_OFF"
+ ],
+ "description": "LogStreamingOption to define build log streaming behavior to Google Cloud\nStorage."
+ },
+ "requestedVerifyOption": {
+ "enum": [
+ "NOT_VERIFIED",
+ "VERIFIED"
+ ],
+ "description": "Requested verifiability options.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not a verifiable build. (default)",
+ "Verified build."
+ ]
+ },
+ "substitutionOption": {
+ "type": "string",
+ "enumDescriptions": [
+ "Fails the build if error in substitutions checks, like missing\na substitution in the template or in the map.",
+ "Do not fail the build if error in substitutions checks."
+ ],
+ "enum": [
+ "MUST_MATCH",
+ "ALLOW_LOOSE"
+ ],
+ "description": "SubstitutionOption to allow unmatch substitutions."
+ },
+ "diskSizeGb": {
+ "type": "string",
+ "description": "Requested disk size for the VM that runs the build. Note that this is *NOT*\n\"disk free\"; some of the space will be used by the operating system and\nbuild utilities. Also note that this is the minimum disk size that will be\nallocated for the build -- the build may run with a larger disk than\nrequested. At present, the maximum disk size is 1000GB; builds that request\nmore than the maximum are rejected with an error.",
+ "format": "int64"
+ },
+ "sourceProvenanceHash": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "NONE",
+ "SHA256"
+ ]
+ },
+ "enumDescriptions": [
+ "No hash requested.",
+ "Use a sha256 hash."
+ ],
+ "description": "Requested hash for SourceProvenance."
+ }
+ },
+ "id": "BuildOptions"
+ },
+ "StorageSource": {
+ "type": "object",
+ "properties": {
+ "generation": {
+ "type": "string",
+ "description": "Google Cloud Storage generation for the object. If the generation is\nomitted, the latest generation will be used.",
+ "format": "int64"
+ },
+ "bucket": {
+ "description": "Google Cloud Storage bucket containing source (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).",
+ "type": "string"
+ },
+ "object": {
+ "type": "string",
+ "description": "Google Cloud Storage object containing source.\n\nThis object must be a gzipped archive file (.tar.gz) containing source to\nbuild."
+ }
+ },
+ "id": "StorageSource",
+ "description": "StorageSource describes the location of the source in an archive file in\nGoogle Cloud Storage."
+ },
+ "Results": {
+ "type": "object",
+ "properties": {
+ "buildStepImages": {
+ "description": "List of build step digests, in order corresponding to build step indices.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "images": {
+ "type": "array",
+ "items": {
+ "$ref": "BuiltImage"
+ },
+ "description": "Images that were built as a part of the build."
+ }
+ },
+ "id": "Results",
+ "description": "Results describes the artifacts created by the build pipeline."
+ },
"ListBuildTriggersResponse": {
- "description": "Response containing existing BuildTriggers.",
"type": "object",
"properties": {
"triggers": {
- "description": "BuildTriggers for the project, sorted by create_time descending.",
"type": "array",
"items": {
"$ref": "BuildTrigger"
- }
+ },
+ "description": "BuildTriggers for the project, sorted by create_time descending."
}
},
- "id": "ListBuildTriggersResponse"
+ "id": "ListBuildTriggersResponse",
+ "description": "Response containing existing BuildTriggers."
},
"BuiltImage": {
"description": "BuiltImage describes an image built by the pipeline.",
@@ -23,8 +169,8 @@
"type": "string"
},
"digest": {
- "description": "Docker Registry 2.0 digest.",
- "type": "string"
+ "type": "string",
+ "description": "Docker Registry 2.0 digest."
},
"pushTiming": {
"$ref": "TimeSpan",
@@ -34,15 +180,10 @@
"id": "BuiltImage"
},
"Hash": {
- "description": "Container message for hash values.",
"type": "object",
"properties": {
- "value": {
- "description": "The hash value.",
- "format": "byte",
- "type": "string"
- },
"type": {
+ "type": "string",
"enumDescriptions": [
"No hash requested.",
"Use a sha256 hash."
@@ -51,13 +192,19 @@
"NONE",
"SHA256"
],
- "description": "The type of hash that was performed.",
- "type": "string"
+ "description": "The type of hash that was performed."
+ },
+ "value": {
+ "type": "string",
+ "description": "The hash value.",
+ "format": "byte"
}
},
- "id": "Hash"
+ "id": "Hash",
+ "description": "Container message for hash values."
},
"Secret": {
+ "type": "object",
"properties": {
"kmsKeyName": {
"type": "string",
@@ -66,45 +213,43 @@
"secretEnv": {
"type": "object",
"additionalProperties": {
- "format": "byte",
- "type": "string"
+ "type": "string",
+ "format": "byte"
},
"description": "Map of environment variable name to its encrypted value.\n\nSecret environment variables must be unique across all of a build's\nsecrets, and must be used by at least one build step. Values can be at most\n1 KB in size. There can be at most ten secret values across all of a\nbuild's secrets."
}
},
"id": "Secret",
- "description": "Secret pairs a set of secret environment variables containing encrypted\nvalues with the Cloud KMS key to use to decrypt the value.",
- "type": "object"
+ "description": "Secret pairs a set of secret environment variables containing encrypted\nvalues with the Cloud KMS key to use to decrypt the value."
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {},
- "id": "Empty"
+ "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 `{}`."
},
"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": {
- "description": "If provided, get source from this location in a Cloud Repo.",
- "$ref": "RepoSource"
+ "$ref": "RepoSource",
+ "description": "If provided, get source from this location in a Cloud Repo."
+ },
+ "storageSource": {
+ "$ref": "StorageSource",
+ "description": "If provided, get the source from this location in Google Cloud Storage."
}
},
- "id": "Source"
+ "id": "Source",
+ "description": "Source describes the location of the source in a supported storage\nservice."
},
"RetryBuildRequest": {
- "description": "RetryBuildRequest specifies a build to retry.",
"type": "object",
"properties": {},
- "id": "RetryBuildRequest"
+ "id": "RetryBuildRequest",
+ "description": "RetryBuildRequest specifies a build to retry."
},
"BuildOperationMetadata": {
- "description": "Metadata for build operations.",
"type": "object",
"properties": {
"build": {
@@ -112,39 +257,48 @@
"description": "The build that the operation is tracking."
}
},
- "id": "BuildOperationMetadata"
+ "id": "BuildOperationMetadata",
+ "description": "Metadata for build operations."
},
"SourceProvenance": {
- "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.",
"type": "object",
"properties": {
- "fileHashes": {
- "additionalProperties": {
- "$ref": "FileHashes"
- },
- "description": "Hash(es) of the build source, which can be used to verify that the original\nsource integrity was maintained in the build. Note that FileHashes will\nonly be populated if BuildOptions has requested a SourceProvenanceHash.\n\nThe keys to this map are file paths used as build source and the values\ncontain the hash values for those files.\n\nIf the build source came in a single package such as a gzipped tarfile\n(.tar.gz), the FileHash will be for the single path to that file.\n@OutputOnly",
- "type": "object"
- },
"resolvedRepoSource": {
"$ref": "RepoSource",
"description": "A copy of the build's source.repo_source, if exists, with any\nrevisions resolved."
},
"resolvedStorageSource": {
- "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved.",
- "$ref": "StorageSource"
+ "$ref": "StorageSource",
+ "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved."
+ },
+ "fileHashes": {
+ "type": "object",
+ "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"
}
},
- "id": "SourceProvenance"
+ "id": "SourceProvenance",
+ "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build."
},
"CancelOperationRequest": {
- "id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "CancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation."
},
"Operation": {
"type": "object",
"properties": {
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
@@ -158,46 +312,37 @@
"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`."
+ "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": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- }
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
}
},
"id": "Operation",
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
},
"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"
- }
+ },
+ "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."
},
"dir": {
- "description": "Working directory (relative to project source root) to use when running\nthis operation's container.",
- "type": "string"
+ "type": "string",
+ "description": "Working directory (relative to project source root) to use when running\nthis operation's container."
},
"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"
- }
+ },
+ "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\"."
},
"waitFor": {
"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.",
@@ -211,11 +356,11 @@
"description": "Stores timing information for executing this build step."
},
"args": {
- "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, these args\nwill be used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args will be used as the entrypoint,\nand the remainder will be used as arguments.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, these args\nwill be used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args will be used as the entrypoint,\nand the remainder will be used as arguments."
},
"name": {
"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.",
@@ -226,20 +371,23 @@
"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"
- }
+ },
+ "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."
},
"id": {
- "type": "string",
- "description": "Optional unique identifier for this build step, used in wait_for to\nreference this build step as a dependency."
+ "description": "Optional unique identifier for this build step, used in wait_for to\nreference this build step as a dependency.",
+ "type": "string"
}
},
- "id": "BuildStep"
+ "id": "BuildStep",
+ "description": "BuildStep describes a step to perform in the build pipeline."
},
"RepoSource": {
+ "description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.",
+ "type": "object",
"properties": {
"dir": {
"description": "Directory, relative to the source root, in which to run the build.",
@@ -250,28 +398,25 @@
"type": "string"
},
"tagName": {
- "type": "string",
- "description": "Name of the tag to build."
- },
- "repoName": {
- "description": "Name of the repo. If omitted, the name \"default\" is assumed.",
+ "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": {
"type": "string",
- "description": "ID of the project that owns the repo. If omitted, the project ID requesting\nthe build is assumed."
+ "description": "Name of the repo. If omitted, the name \"default\" is assumed."
},
"commitSha": {
"description": "Explicit commit SHA to build.",
"type": "string"
}
},
- "id": "RepoSource",
- "description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.",
- "type": "object"
+ "id": "RepoSource"
},
"FileHashes": {
- "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.",
"type": "object",
"properties": {
"fileHash": {
@@ -282,7 +427,8 @@
}
}
},
- "id": "FileHashes"
+ "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."
},
"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.",
@@ -294,18 +440,18 @@
"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."
+ "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"
+ }
}
}
},
@@ -315,6 +461,22 @@
"description": "Configuration for an automated build in response to source repository\nchanges.",
"type": "object",
"properties": {
+ "triggerTemplate": {
+ "$ref": "RepoSource",
+ "description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build."
+ },
+ "filename": {
+ "type": "string",
+ "description": "Path, from the source root, to a file whose contents is used for the\ntemplate."
+ },
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the trigger.\n\n@OutputOnly"
+ },
+ "build": {
+ "$ref": "Build",
+ "description": "Contents of the build template."
+ },
"substitutions": {
"type": "object",
"additionalProperties": {
@@ -323,33 +485,17 @@
"description": "Substitutions data for Build resource."
},
"description": {
- "description": "Human-readable description of this trigger.",
- "type": "string"
+ "type": "string",
+ "description": "Human-readable description of this trigger."
},
"createTime": {
+ "type": "string",
"description": "Time when the trigger was created.\n\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"disabled": {
"description": "If true, the trigger will never result in a build.",
"type": "boolean"
- },
- "triggerTemplate": {
- "$ref": "RepoSource",
- "description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build."
- },
- "filename": {
- "description": "Path, from the source root, to a file whose contents is used for the\ntemplate.",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier of the trigger.\n\n@OutputOnly",
- "type": "string"
- },
- "build": {
- "description": "Contents of the build template.",
- "$ref": "Build"
}
},
"id": "BuildTrigger"
@@ -359,11 +505,11 @@
"type": "object",
"properties": {
"timing": {
+ "type": "object",
"additionalProperties": {
"$ref": "TimeSpan"
},
- "description": "Stores timing information for phases of the build. Valid keys are:\n\n* BUILD: time to execute all build steps\n* PUSH: time to push all specified images.\n* FETCHSOURCE: time to fetch source.\n\nIf the build does not specify source, or does not specify images,\nthese keys will not be included.",
- "type": "object"
+ "description": "Stores timing information for phases of the build. Valid keys are:\n\n* BUILD: time to execute all build steps\n* PUSH: time to push all specified images.\n* FETCHSOURCE: time to fetch source.\n\nIf the build does not specify source, or does not specify images,\nthese keys will not be included."
},
"createTime": {
"description": "Time at which the request to create the build was received.\n@OutputOnly",
@@ -375,11 +521,11 @@
"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"
- }
+ },
+ "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images will be pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the Build resource's\nresults field.\n\nIf any of the images fail to be pushed, the build is marked FAILURE."
},
"projectId": {
"description": "ID of the project.\n@OutputOnly.",
@@ -391,22 +537,33 @@
"format": "google-datetime"
},
"logUrl": {
- "description": "URL to logs for this build in Google Cloud Logging.\n@OutputOnly",
- "type": "string"
- },
- "options": {
- "$ref": "BuildOptions",
- "description": "Special options for this build."
+ "type": "string",
+ "description": "URL to logs for this build in Google Cloud Logging.\n@OutputOnly"
},
"source": {
"$ref": "Source",
"description": "Describes where to find the source files to build."
},
- "statusDetail": {
- "description": "Customer-readable message about the current status.\n@OutputOnly",
+ "options": {
+ "$ref": "BuildOptions",
+ "description": "Special options for this build."
+ },
+ "timeout": {
+ "description": "Amount of time that this build should be allowed to run, to second\ngranularity. If this amount of time elapses, work on the build will cease\nand the build status will be TIMEOUT.\n\nDefault time is ten minutes.",
+ "format": "google-duration",
"type": "string"
},
"status": {
+ "enum": [
+ "STATUS_UNKNOWN",
+ "QUEUED",
+ "WORKING",
+ "SUCCESS",
+ "FAILURE",
+ "INTERNAL_ERROR",
+ "TIMEOUT",
+ "CANCELLED"
+ ],
"description": "Status of the build.\n@OutputOnly",
"type": "string",
"enumDescriptions": [
@@ -418,98 +575,71 @@
"Build failed due to an internal cause.",
"Build took longer than was allowed.",
"Build was canceled by a user."
- ],
- "enum": [
- "STATUS_UNKNOWN",
- "QUEUED",
- "WORKING",
- "SUCCESS",
- "FAILURE",
- "INTERNAL_ERROR",
- "TIMEOUT",
- "CANCELLED"
]
},
- "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": {
+ "type": "string",
+ "description": "Customer-readable message about the current status.\n@OutputOnly"
},
"secrets": {
- "description": "Secrets to decrypt using Cloud KMS.",
"type": "array",
"items": {
"$ref": "Secret"
- }
- },
- "results": {
- "$ref": "Results",
- "description": "Results of the build.\n@OutputOnly"
+ },
+ "description": "Secrets to decrypt using Cloud KMS."
},
"logsBucket": {
"description": "Google Cloud Storage bucket where logs should be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nLogs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.",
"type": "string"
},
+ "results": {
+ "$ref": "Results",
+ "description": "Results of the build.\n@OutputOnly"
+ },
"steps": {
- "description": "Describes the operations to be performed on the workspace.",
"type": "array",
"items": {
"$ref": "BuildStep"
- }
+ },
+ "description": "Describes the operations to be performed on the workspace."
},
"buildTriggerId": {
- "description": "The ID of the BuildTrigger that triggered this build, if it was\ntriggered automatically.\n@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "The ID of the BuildTrigger that triggered this build, if it was\ntriggered automatically.\n@OutputOnly"
+ },
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Tags for annotation of a Build. These are not docker tags."
},
"id": {
"description": "Unique identifier of the build.\n@OutputOnly",
"type": "string"
},
- "tags": {
- "description": "Tags for annotation of a Build. These are not docker tags.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"startTime": {
"description": "Time at which execution of the build was started.\n@OutputOnly",
"format": "google-datetime",
"type": "string"
},
"substitutions": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Substitutions data for Build resource.",
- "type": "object"
+ "description": "Substitutions data for Build resource."
}
},
"id": "Build"
},
"CancelBuildRequest": {
- "description": "Request to cancel an ongoing build.",
"type": "object",
"properties": {},
- "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.",
- "type": "string"
- },
- "path": {
- "description": "Path at which to mount the volume.\n\nPaths must be absolute and cannot conflict with other volume paths on the\nsame build step or with certain reserved volume paths.",
- "type": "string"
- }
- },
- "id": "Volume"
+ "id": "CancelBuildRequest",
+ "description": "Request to cancel an ongoing build."
},
"ListBuildsResponse": {
- "description": "Response including listed builds.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -524,15 +654,30 @@
"description": "Builds will be sorted by create_time, descending."
}
},
- "id": "ListBuildsResponse"
+ "id": "ListBuildsResponse",
+ "description": "Response including listed builds."
+ },
+ "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.",
+ "type": "string"
+ },
+ "path": {
+ "type": "string",
+ "description": "Path at which to mount the volume.\n\nPaths must be absolute and cannot conflict with other volume paths on the\nsame build step or with certain reserved volume paths."
+ }
+ },
+ "id": "Volume"
},
"ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
"nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
+ "type": "string",
+ "description": "The standard List next-page token."
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
@@ -542,151 +687,15 @@
}
}
},
- "id": "ListOperationsResponse"
- },
- "TimeSpan": {
- "description": "Stores start and end times for a build execution phase.",
- "type": "object",
- "properties": {
- "startTime": {
- "description": "Start of time span.",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "description": "End of time span.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "TimeSpan"
- },
- "BuildOptions": {
- "properties": {
- "sourceProvenanceHash": {
- "enumDescriptions": [
- "No hash requested.",
- "Use a sha256 hash."
- ],
- "description": "Requested hash for SourceProvenance.",
- "type": "array",
- "items": {
- "enum": [
- "NONE",
- "SHA256"
- ],
- "type": "string"
- }
- },
- "machineType": {
- "enumDescriptions": [
- "Standard machine type.",
- "Highcpu machine with 8 CPUs.",
- "Highcpu machine with 32 CPUs."
- ],
- "enum": [
- "UNSPECIFIED",
- "N1_HIGHCPU_8",
- "N1_HIGHCPU_32"
- ],
- "description": "Compute Engine machine type on which to run the build.",
- "type": "string"
- },
- "logStreamingOption": {
- "enum": [
- "STREAM_DEFAULT",
- "STREAM_ON",
- "STREAM_OFF"
- ],
- "description": "LogStreamingOption to define build log streaming behavior to Google Cloud\nStorage.",
- "type": "string",
- "enumDescriptions": [
- "Service may automatically determine build log streaming behavior.",
- "Build logs should be streamed to Google Cloud Storage.",
- "Build logs should not be streamed to Google Cloud Storage; they will be\nwritten when the build is completed."
- ]
- },
- "requestedVerifyOption": {
- "enumDescriptions": [
- "Not a verifiable build. (default)",
- "Verified build."
- ],
- "enum": [
- "NOT_VERIFIED",
- "VERIFIED"
- ],
- "description": "Requested verifiability options.",
- "type": "string"
- },
- "substitutionOption": {
- "description": "SubstitutionOption to allow unmatch substitutions.",
- "type": "string",
- "enumDescriptions": [
- "Fails the build if error in substitutions checks, like missing\na substitution in the template or in the map.",
- "Do not fail the build if error in substitutions checks."
- ],
- "enum": [
- "MUST_MATCH",
- "ALLOW_LOOSE"
- ]
- },
- "diskSizeGb": {
- "description": "Requested disk size for the VM that runs the build. Note that this is *NOT*\n\"disk free\"; some of the space will be used by the operating system and\nbuild utilities. Also note that this is the minimum disk size that will be\nallocated for the build -- the build may run with a larger disk than\nrequested. At present, the maximum disk size is 1000GB; builds that request\nmore than the maximum are rejected with an error.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "BuildOptions",
- "description": "Optional arguments to enable specific features of builds.",
- "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)).",
- "type": "string"
- },
- "object": {
- "description": "Google Cloud Storage object containing source.\n\nThis object must be a gzipped archive file (.tar.gz) containing source to\nbuild.",
- "type": "string"
- },
- "generation": {
- "description": "Google Cloud Storage generation for the object. If the generation is\nomitted, the latest generation will be used.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "StorageSource"
- },
- "Results": {
- "description": "Results describes the artifacts created by the build pipeline.",
- "type": "object",
- "properties": {
- "buildStepImages": {
- "description": "List of build step digests, in order corresponding to build step indices.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "images": {
- "description": "Images that were built as a part of the build.",
- "type": "array",
- "items": {
- "$ref": "BuiltImage"
- }
- }
- },
- "id": "Results"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations."
}
},
- "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 Build",
"auth": {
"oauth2": {
@@ -707,37 +716,36 @@
"operations": {
"methods": {
"list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
"parameterOrder": [
"name"
],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
"parameters": {
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list filter."
+ },
"name": {
- "description": "The name of the operation's parent resource.",
"required": true,
"type": "string",
"pattern": "^operations$",
- "location": "path"
+ "location": "path",
+ "description": "The name of the operation's parent resource."
},
"pageToken": {
- "description": "The standard list page token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "The standard list page token."
},
"pageSize": {
+ "location": "query",
"description": "The standard list page size.",
"format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
+ "type": "integer"
}
},
"scopes": [
@@ -745,31 +753,32 @@
],
"flatPath": "v1/operations",
"id": "cloudbuild.operations.list",
- "path": "v1/{+name}"
+ "path": "v1/{+name}",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
},
"get": {
- "httpMethod": "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"
+ "location": "path",
+ "description": "The name of the operation resource."
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/operations/{operationsId}",
- "id": "cloudbuild.operations.get",
"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."
},
"cancel": {
@@ -780,9 +789,6 @@
"name"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"name": {
"required": true,
@@ -792,94 +798,150 @@
"description": "The name of the operation resource to be cancelled."
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/operations/{operationsId}:cancel",
"path": "v1/{+name}:cancel",
"id": "cloudbuild.operations.cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
"request": {
"$ref": "CancelOperationRequest"
- }
+ },
+ "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`."
}
}
},
"projects": {
"resources": {
- "builds": {
+ "triggers": {
"methods": {
"get": {
- "description": "Returns information about a previously requested build.\n\nThe Build that is returned includes its status (e.g., success or failure,\nor in-progress), and timing information.",
"response": {
- "$ref": "Build"
+ "$ref": "BuildTrigger"
},
"parameterOrder": [
"projectId",
- "id"
+ "triggerId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "projectId": {
+ "triggerId": {
"location": "path",
- "description": "ID of the project.",
+ "description": "ID of the BuildTrigger to get.",
"required": true,
"type": "string"
},
- "id": {
+ "projectId": {
"location": "path",
- "description": "ID of the build.",
+ "description": "ID of the project that owns the trigger.",
"required": true,
"type": "string"
}
},
- "flatPath": "v1/projects/{projectId}/builds/{id}",
- "path": "v1/projects/{projectId}/builds/{id}",
- "id": "cloudbuild.projects.builds.get"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "response": {
+ "$ref": "BuildTrigger"
+ },
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "triggerId": {
+ "location": "path",
+ "description": "ID of the BuildTrigger to update.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project that owns the trigger.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "id": "cloudbuild.projects.triggers.patch",
+ "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
+ "request": {
+ "$ref": "BuildTrigger"
+ }
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "triggerId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the BuildTrigger to delete."
+ },
+ "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.delete",
+ "description": "Deletes an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental."
},
"list": {
"response": {
- "$ref": "ListBuildsResponse"
+ "$ref": "ListBuildTriggersResponse"
},
"parameterOrder": [
"projectId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "Token to provide to skip to a particular spot in the list.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Number of results to return in the list.",
- "format": "int32",
- "type": "integer"
- },
"projectId": {
- "description": "ID of the project.",
+ "location": "path",
+ "description": "ID of the project for which to list BuildTriggers.",
"required": true,
- "type": "string",
- "location": "path"
- },
- "filter": {
- "location": "query",
- "description": "The raw filter text to constrain the results.",
"type": "string"
}
},
- "flatPath": "v1/projects/{projectId}/builds",
- "path": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.list",
- "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully."
+ "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": {
+ "description": "Creates a new BuildTrigger.\n\nThis API is experimental.",
+ "request": {
+ "$ref": "BuildTrigger"
+ },
"response": {
- "$ref": "Operation"
+ "$ref": "BuildTrigger"
},
"parameterOrder": [
"projectId"
@@ -890,61 +952,89 @@
],
"parameters": {
"projectId": {
- "description": "ID of the project.",
+ "location": "path",
+ "description": "ID of the project for which to configure automatic builds.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectId}/builds",
- "path": "v1/projects/{projectId}/builds",
- "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"
- }
+ "flatPath": "v1/projects/{projectId}/triggers",
+ "path": "v1/projects/{projectId}/triggers",
+ "id": "cloudbuild.projects.triggers.create"
},
+ "run": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the project."
+ },
+ "triggerId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the trigger."
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}:run",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}:run",
+ "id": "cloudbuild.projects.triggers.run",
+ "description": "Runs a BuildTrigger at a particular source revision.",
+ "request": {
+ "$ref": "RepoSource"
+ }
+ }
+ }
+ },
+ "builds": {
+ "methods": {
"cancel": {
+ "response": {
+ "$ref": "Build"
+ },
+ "parameterOrder": [
+ "projectId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the project."
+ },
+ "id": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the build."
+ }
+ },
"flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
"path": "v1/projects/{projectId}/builds/{id}:cancel",
"id": "cloudbuild.projects.builds.cancel",
"description": "Cancels a requested build in progress.",
"request": {
"$ref": "CancelBuildRequest"
- },
- "response": {
- "$ref": "Build"
- },
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "ID of the project.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "id": {
- "location": "path",
- "description": "ID of the build.",
- "required": true,
- "type": "string"
- }
}
},
"retry": {
- "path": "v1/projects/{projectId}/builds/{id}:retry",
- "id": "cloudbuild.projects.builds.retry",
- "description": "Creates a new build based on the given build.\n\nThis API creates a new build using the original build request, which may\nor may not result in an identical build.\n\nFor triggered builds:\n\n* Triggered builds resolve to a precise revision, so a retry of a triggered\nbuild will result in a build that uses the same revision.\n\nFor non-triggered builds that specify RepoSource:\n\n* If the original build built from the tip of a branch, the retried build\nwill build from the tip of that branch, which may not be the same revision\nas the original build.\n* If the original build specified a commit sha or revision ID, the retried\nbuild will use the identical source.\n\nFor builds that specify StorageSource:\n\n* If the original build pulled source from Cloud Storage without specifying\nthe generation of the object, the new build will use the current object,\nwhich may be different from the original build source.\n* If the original build pulled source from Cloud Storage and specified the\ngeneration of the object, the new build will attempt to use the same\nobject, which may or may not be available depending on the bucket's\nlifecycle management settings.",
- "request": {
- "$ref": "RetryBuildRequest"
- },
"response": {
"$ref": "Operation"
},
@@ -970,192 +1060,111 @@
"type": "string"
}
},
- "flatPath": "v1/projects/{projectId}/builds/{id}:retry"
- }
- }
- },
- "triggers": {
- "methods": {
- "get": {
- "response": {
- "$ref": "BuildTrigger"
- },
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "triggerId": {
- "location": "path",
- "description": "ID of the BuildTrigger to get.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "ID of the project that owns the trigger.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
- "path": "v1/projects/{projectId}/triggers/{triggerId}",
- "id": "cloudbuild.projects.triggers.get",
- "description": "Gets information about a BuildTrigger.\n\nThis API is experimental."
- },
- "patch": {
- "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}",
- "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.",
+ "flatPath": "v1/projects/{projectId}/builds/{id}:retry",
+ "path": "v1/projects/{projectId}/builds/{id}:retry",
+ "id": "cloudbuild.projects.builds.retry",
+ "description": "Creates a new build based on the given build.\n\nThis API creates a new build using the original build request, which may\nor may not result in an identical build.\n\nFor triggered builds:\n\n* Triggered builds resolve to a precise revision, so a retry of a triggered\nbuild will result in a build that uses the same revision.\n\nFor non-triggered builds that specify RepoSource:\n\n* If the original build built from the tip of a branch, the retried build\nwill build from the tip of that branch, which may not be the same revision\nas the original build.\n* If the original build specified a commit sha or revision ID, the retried\nbuild will use the identical source.\n\nFor builds that specify StorageSource:\n\n* If the original build pulled source from Cloud Storage without specifying\nthe generation of the object, the new build will use the current object,\nwhich may be different from the original build source.\n* If the original build pulled source from Cloud Storage and specified the\ngeneration of the object, the new build will attempt to use the same\nobject, which may or may not be available depending on the bucket's\nlifecycle management settings.",
"request": {
- "$ref": "BuildTrigger"
+ "$ref": "RetryBuildRequest"
}
},
- "delete": {
+ "get": {
+ "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.",
"response": {
- "$ref": "Empty"
+ "$ref": "Build"
},
"parameterOrder": [
"projectId",
- "triggerId"
+ "id"
],
- "httpMethod": "DELETE",
- "parameters": {
- "triggerId": {
- "location": "path",
- "description": "ID of the BuildTrigger to delete.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "ID of the project that owns the trigger.",
- "required": true,
- "type": "string"
- }
- },
+ "httpMethod": "GET",
"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",
- "description": "Deletes an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental."
- },
- "list": {
"parameters": {
"projectId": {
- "description": "ID of the project for which to list BuildTriggers.",
"required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "ID of the project."
+ },
+ "id": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the build."
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers",
- "id": "cloudbuild.projects.triggers.list",
- "path": "v1/projects/{projectId}/triggers",
- "description": "Lists existing BuildTrigger.\n\nThis API is experimental.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListBuildTriggersResponse"
- },
- "parameterOrder": [
- "projectId"
- ]
+ }
},
- "create": {
- "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.",
- "response": {
- "$ref": "BuildTrigger"
- },
+ "list": {
+ "httpMethod": "GET",
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "ListBuildsResponse"
+ },
"parameters": {
"projectId": {
- "location": "path",
- "description": "ID of the project for which to configure automatic builds.",
"required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the project."
+ },
+ "filter": {
+ "location": "query",
+ "description": "The raw filter text to constrain the results.",
"type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Token to provide to skip to a particular spot in the list."
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Number of results to return in the list.",
+ "format": "int32"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "run": {
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}:run",
- "id": "cloudbuild.projects.triggers.run",
- "path": "v1/projects/{projectId}/triggers/{triggerId}:run",
- "request": {
- "$ref": "RepoSource"
- },
- "description": "Runs a BuildTrigger at a particular source revision.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "triggerId"
],
+ "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."
+ },
+ "create": {
+ "description": "Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure).",
+ "request": {
+ "$ref": "Build"
+ },
"response": {
"$ref": "Operation"
},
- "parameters": {
- "triggerId": {
- "description": "ID of the trigger.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "ID of the project.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the project."
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/builds",
+ "path": "v1/projects/{projectId}/builds",
+ "id": "cloudbuild.projects.builds.create"
}
}
}
@@ -1163,47 +1172,62 @@
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
+ "default": "true"
+ },
+ "oauth_token": {
"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": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
+ "description": "OAuth 2.0 token for the current user.",
"type": "string"
},
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
"$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
"type": "string"
},
"alt": {
- "description": "Data format for response.",
"default": "json",
"enum": [
"json",
@@ -1216,7 +1240,8 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query"
+ "location": "query",
+ "description": "Data format for response."
},
"key": {
"type": "string",
@@ -1224,41 +1249,16 @@
"description": "API key. 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"
+ "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": {
- "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."
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
}
},
"version": "v1",
- "baseUrl": "https://cloudbuild.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Builds container images in the cloud.",
- "servicePath": "",
- "basePath": "",
- "revision": "20180124",
- "documentationLink": "https://cloud.google.com/container-builder/docs/",
- "id": "cloudbuild:v1",
- "discoveryVersion": "v1",
- "version_module": true
+ "baseUrl": "https://cloudbuild.googleapis.com/"
}
diff --git a/clouddebugger/v2/clouddebugger-api.json b/clouddebugger/v2/clouddebugger-api.json
index 894e1d4..e44020e 100644
--- a/clouddebugger/v2/clouddebugger-api.json
+++ b/clouddebugger/v2/clouddebugger-api.json
@@ -1,420 +1,9 @@
{
- "rootUrl": "https://clouddebugger.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "clouddebugger",
- "batchPath": "batch",
- "title": "Stackdriver Debugger API",
- "ownerName": "Google",
- "resources": {
- "debugger": {
- "resources": {
- "debuggees": {
- "resources": {
- "breakpoints": {
- "methods": {
- "set": {
- "response": {
- "$ref": "SetBreakpointResponse"
- },
- "parameterOrder": [
- "debuggeeId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "clientVersion": {
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string",
- "location": "query"
- },
- "debuggeeId": {
- "location": "path",
- "description": "ID of the debuggee where the breakpoint is to be set.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
- "id": "clouddebugger.debugger.debuggees.breakpoints.set",
- "description": "Sets the breakpoint to the debuggee.",
- "request": {
- "$ref": "Breakpoint"
- }
- },
- "delete": {
- "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": {
- "location": "path",
- "description": "ID of the breakpoint to delete.",
- "required": true,
- "type": "string"
- },
- "debuggeeId": {
- "location": "path",
- "description": "ID of the debuggee whose breakpoint to delete.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}"
- },
- "get": {
- "response": {
- "$ref": "GetBreakpointResponse"
- },
- "parameterOrder": [
- "debuggeeId",
- "breakpointId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "clientVersion": {
- "location": "query",
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string"
- },
- "breakpointId": {
- "description": "ID of the breakpoint to get.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "debuggeeId": {
- "description": "ID of the debuggee whose breakpoint to get.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "id": "clouddebugger.debugger.debuggees.breakpoints.get",
- "description": "Gets breakpoint information."
- },
- "list": {
- "id": "clouddebugger.debugger.debuggees.breakpoints.list",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
- "description": "Lists all breakpoints for the debuggee.",
- "httpMethod": "GET",
- "parameterOrder": [
- "debuggeeId"
- ],
- "response": {
- "$ref": "ListBreakpointsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "debuggeeId": {
- "location": "path",
- "description": "ID of the debuggee whose breakpoints to list.",
- "required": true,
- "type": "string"
- },
- "waitToken": {
- "description": "A wait token that, if specified, blocks the call until the breakpoints\nlist has changed, or a server selected timeout has expired. The value\nshould be set from the last response. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which\nshould be called again with the same `wait_token`.",
- "type": "string",
- "location": "query"
- },
- "action.value": {
- "enum": [
- "CAPTURE",
- "LOG"
- ],
- "description": "Only breakpoints with the specified action will pass the filter.",
- "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"
- },
- "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": {
- "location": "query",
- "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`.",
- "type": "boolean"
- }
- },
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints"
- }
- }
- }
- },
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListDebuggeesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "includeInactive": {
- "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.",
- "type": "boolean",
- "location": "query"
- },
- "project": {
- "location": "query",
- "description": "Project number of a Google Cloud project whose debuggees to list.",
- "type": "string"
- },
- "clientVersion": {
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v2/debugger/debuggees",
- "id": "clouddebugger.debugger.debuggees.list",
- "path": "v2/debugger/debuggees",
- "description": "Lists all the debuggees that the user has access to."
- }
- }
- }
- }
- },
- "controller": {
- "resources": {
- "debuggees": {
- "methods": {
- "register": {
- "description": "Registers the debuggee with the controller service.\n\nAll agents attached to the same application must call this method with\nexactly the same request content to get back the same stable `debuggee_id`.\nAgents should call this method again whenever `google.rpc.Code.NOT_FOUND`\nis returned from any controller method.\n\nThis protocol allows the controller service to disable debuggees, recover\nfrom data loss, or change the `debuggee_id` format. Agents must handle\n`debuggee_id` value changing upon re-registration.",
- "request": {
- "$ref": "RegisterDebuggeeRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "RegisterDebuggeeResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {},
- "flatPath": "v2/controller/debuggees/register",
- "id": "clouddebugger.controller.debuggees.register",
- "path": "v2/controller/debuggees/register"
- }
- },
- "resources": {
- "breakpoints": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListActiveBreakpointsResponse"
- },
- "parameterOrder": [
- "debuggeeId"
- ],
- "parameters": {
- "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"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints",
- "id": "clouddebugger.controller.debuggees.breakpoints.list",
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints",
- "description": "Returns the list of all active breakpoints for the debuggee.\n\nThe breakpoint specification (`location`, `condition`, and `expressions`\nfields) is semantically immutable, although the field values may\nchange. For example, an agent may update the location line number\nto reflect the actual line where the breakpoint was set, but this\ndoesn't change the breakpoint semantics.\n\nThis means that an agent does not need to check if a breakpoint has changed\nwhen it encounters the same breakpoint on a successive call.\nMoreover, an agent should remember the breakpoints that are completed\nuntil the controller removes them from the active list to avoid\nsetting those breakpoints again."
- },
- "update": {
- "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": {
- "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": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- }
- },
"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",
+ "description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n",
+ "servicePath": "",
"basePath": "",
"revision": "20180112",
"documentationLink": "http://cloud.google.com/debugger",
@@ -422,150 +11,9 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "StackFrame": {
- "properties": {
- "function": {
- "description": "Demangled function name at the call site.",
- "type": "string"
- },
- "arguments": {
- "description": "Set of arguments passed to this function.\nNote that this might not be populated for all stack frames.",
- "type": "array",
- "items": {
- "$ref": "Variable"
- }
- },
- "locals": {
- "description": "Set of local variables at the stack frame location.\nNote that this might not be populated for all stack frames.",
- "type": "array",
- "items": {
- "$ref": "Variable"
- }
- },
- "location": {
- "$ref": "SourceLocation",
- "description": "Source location of the call site."
- }
- },
- "id": "StackFrame",
- "description": "Represents a stack frame context.",
- "type": "object"
- },
- "RepoId": {
- "properties": {
- "uid": {
- "description": "A server-assigned, globally unique identifier.",
- "type": "string"
- },
- "projectRepoId": {
- "$ref": "ProjectRepoId",
- "description": "A combination of a project ID and a repo name."
- }
- },
- "id": "RepoId",
- "description": "A unique identifier for a cloud repo.",
- "type": "object"
- },
- "FormatMessage": {
- "properties": {
- "parameters": {
- "description": "Optional parameters to be embedded into the message.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "format": {
- "description": "Format template for the message. The `format` uses placeholders `$0`,\n`$1`, etc. to reference parameters. `$$` can be used to denote the `$`\ncharacter.\n\nExamples:\n\n* `Failed to load '$0' which helps debug $1 the first time it\n is loaded. Again, $0 is very important.`\n* `Please pay $$10 to use $0 instead of $1.`",
- "type": "string"
- }
- },
- "id": "FormatMessage",
- "description": "Represents a message with parameters.",
- "type": "object"
- },
- "ExtendedSourceContext": {
- "properties": {
- "context": {
- "description": "Any source context.",
- "$ref": "SourceContext"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels with user defined metadata.",
- "type": "object"
- }
- },
- "id": "ExtendedSourceContext",
- "description": "An ExtendedSourceContext is a SourceContext combined with additional\ndetails describing the context.",
- "type": "object"
- },
- "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": {
- "description": "An alias to a repo revision.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The alias name.",
- "type": "string"
- },
- "kind": {
- "enumDescriptions": [
- "Do not use.",
- "Git tag",
- "Git branch",
- "OTHER is used to specify non-standard aliases, those not of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar\", it\nis considered to be of kind OTHER."
- ],
- "enum": [
- "ANY",
- "FIXED",
- "MOVABLE",
- "OTHER"
- ],
- "description": "The alias kind.",
- "type": "string"
- }
- },
- "id": "AliasContext"
- },
- "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"
- },
- "SourceLocation": {
- "description": "Represents a location in the source code.",
- "type": "object",
- "properties": {
- "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.",
@@ -606,11 +54,11 @@
}
},
"labels": {
+ "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
- "type": "object"
+ }
},
"isInactive": {
"description": "If set to `true`, indicates that Controller service does not detect any\nactivity from the debuggee agents and the application is possibly stopped.",
@@ -621,14 +69,16 @@
"$ref": "StatusMessage"
}
},
- "id": "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"
+ "id": "Debuggee"
},
"ListActiveBreakpointsResponse": {
"description": "Response for listing active breakpoints.",
"type": "object",
"properties": {
+ "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"
@@ -639,10 +89,6 @@
"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"
@@ -663,6 +109,8 @@
"id": "ProjectRepoId"
},
"CloudWorkspaceSourceContext": {
+ "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
+ "type": "object",
"properties": {
"snapshotId": {
"description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot.",
@@ -673,14 +121,20 @@
"$ref": "CloudWorkspaceId"
}
},
- "id": "CloudWorkspaceSourceContext",
- "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
- "type": "object"
+ "id": "CloudWorkspaceSourceContext"
},
"GerritSourceContext": {
"description": "A SourceContext referring to a Gerrit project.",
"type": "object",
"properties": {
+ "gerritProject": {
+ "description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"repo name\" is hostURI/project.",
+ "type": "string"
+ },
+ "aliasContext": {
+ "description": "An alias, which may be a branch or tag.",
+ "$ref": "AliasContext"
+ },
"hostUri": {
"description": "The URI of a running Gerrit instance.",
"type": "string"
@@ -692,25 +146,19 @@
"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": {
- "description": "An alias, which may be a branch or tag.",
- "$ref": "AliasContext"
}
},
"id": "GerritSourceContext"
},
"UpdateActiveBreakpointResponse": {
- "properties": {},
- "id": "UpdateActiveBreakpointResponse",
"description": "Response for updating an active breakpoint.\nThe message is defined to allow future extensions.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "UpdateActiveBreakpointResponse"
},
"CloudWorkspaceId": {
+ "description": "A CloudWorkspaceId is a unique identifier for a cloud workspace.\nA cloud workspace is a place associated with a repo where modified files\ncan be stored before they are committed.",
+ "type": "object",
"properties": {
"repoId": {
"description": "The ID of the repo containing the workspace.",
@@ -721,9 +169,7 @@
"type": "string"
}
},
- "id": "CloudWorkspaceId",
- "description": "A CloudWorkspaceId is a unique identifier for a cloud workspace.\nA cloud workspace is a place associated with a repo where modified files\ncan be stored before they are committed.",
- "type": "object"
+ "id": "CloudWorkspaceId"
},
"ListBreakpointsResponse": {
"description": "Response for listing breakpoints.",
@@ -744,35 +190,9 @@
"id": "ListBreakpointsResponse"
},
"Breakpoint": {
+ "description": "Represents the breakpoint specification, status and results.",
+ "type": "object",
"properties": {
- "finalTime": {
- "description": "Time this breakpoint was finalized as seen by the server in seconds\nresolution.",
- "format": "google-datetime",
- "type": "string"
- },
- "variableTable": {
- "description": "The `variable_table` exists to aid with computation, memory and network\ntraffic optimization. It enables storing a variable once and reference\nit from multiple variables, including variables stored in the\n`variable_table` itself.\nFor example, the same `this` object, which may appear at many levels of\nthe stack, can have all of its data stored once in this table. The\nstack frame variables then would hold only a reference to it.\n\nThe variable `var_table_index` field is an index into this repeated field.\nThe stored objects are nameless and get their name from the referencing\nvariable. The effective variable is a merge of the referencing variable\nand the referenced variable.",
- "type": "array",
- "items": {
- "$ref": "Variable"
- }
- },
- "createTime": {
- "description": "Time this breakpoint was created by the server in seconds resolution.",
- "format": "google-datetime",
- "type": "string"
- },
- "logMessageFormat": {
- "description": "Only relevant when action is `LOG`. Defines the message to log when\nthe breakpoint hits. The message may include parameter placeholders `$0`,\n`$1`, etc. These placeholders are replaced with the evaluated value\nof the appropriate expression. Expressions not referenced in\n`log_message_format` are not logged.\n\nExample: `Message received, id = $0, count = $1` with\n`expressions` = `[ message.id, message.count ]`.",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.",
- "type": "object"
- },
"expressions": {
"description": "List of read-only expressions to evaluate at the breakpoint location.\nThe expressions are composed using expressions in the programming language\nat the source location. If the breakpoint action is `LOG`, the evaluated\nexpressions are included in log statements.",
"type": "array",
@@ -811,95 +231,119 @@
"type": "string"
},
"action": {
- "enum": [
- "CAPTURE",
- "LOG"
- ],
"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."
+ ],
+ "enum": [
+ "CAPTURE",
+ "LOG"
]
},
"logLevel": {
+ "enumDescriptions": [
+ "Information log message.",
+ "Warning log message.",
+ "Error log message."
+ ],
"enum": [
"INFO",
"WARNING",
"ERROR"
],
"description": "Indicates the severity of the log. Only relevant when action is `LOG`.",
- "type": "string",
- "enumDescriptions": [
- "Information log message.",
- "Warning log message.",
- "Error log message."
- ]
+ "type": "string"
},
"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.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "variableTable": {
+ "description": "The `variable_table` exists to aid with computation, memory and network\ntraffic optimization. It enables storing a variable once and reference\nit from multiple variables, including variables stored in the\n`variable_table` itself.\nFor example, the same `this` object, which may appear at many levels of\nthe stack, can have all of its data stored once in this table. The\nstack frame variables then would hold only a reference to it.\n\nThe variable `var_table_index` field is an index into this repeated field.\nThe stored objects are nameless and get their name from the referencing\nvariable. The effective variable is a merge of the referencing variable\nand the referenced variable.",
+ "type": "array",
+ "items": {
+ "$ref": "Variable"
+ }
+ },
+ "createTime": {
+ "description": "Time this breakpoint was created by the server in seconds resolution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "logMessageFormat": {
+ "description": "Only relevant when action is `LOG`. Defines the message to log when\nthe breakpoint hits. The message may include parameter placeholders `$0`,\n`$1`, etc. These placeholders are replaced with the evaluated value\nof the appropriate expression. Expressions not referenced in\n`log_message_format` are not logged.\n\nExample: `Message received, id = $0, count = $1` with\n`expressions` = `[ message.id, message.count ]`.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object"
}
},
- "id": "Breakpoint",
- "description": "Represents the breakpoint specification, status and results.",
- "type": "object"
- },
- "SetBreakpointResponse": {
- "description": "Response for setting a breakpoint.",
- "type": "object",
- "properties": {
- "breakpoint": {
- "$ref": "Breakpoint",
- "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds)."
- }
- },
- "id": "SetBreakpointResponse"
+ "id": "Breakpoint"
},
"UpdateActiveBreakpointRequest": {
+ "description": "Request to update an active breakpoint.",
+ "type": "object",
"properties": {
"breakpoint": {
"$ref": "Breakpoint",
"description": "Updated breakpoint information.\nThe field `id` must be set.\nThe agent must echo all Breakpoint specification fields in the update."
}
},
- "id": "UpdateActiveBreakpointRequest",
- "description": "Request to update an active breakpoint.",
- "type": "object"
+ "id": "UpdateActiveBreakpointRequest"
+ },
+ "SetBreakpointResponse": {
+ "description": "Response for setting a breakpoint.",
+ "type": "object",
+ "properties": {
+ "breakpoint": {
+ "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds).",
+ "$ref": "Breakpoint"
+ }
+ },
+ "id": "SetBreakpointResponse"
},
"SourceContext": {
+ "description": "A SourceContext is a reference to a tree of files. A SourceContext together\nwith a path point to a unique revision of a single file or directory.",
+ "type": "object",
"properties": {
+ "git": {
+ "$ref": "GitSourceContext",
+ "description": "A SourceContext referring to any third party Git repo (e.g. GitHub)."
+ },
"gerrit": {
- "description": "A SourceContext referring to a Gerrit project.",
- "$ref": "GerritSourceContext"
+ "$ref": "GerritSourceContext",
+ "description": "A SourceContext referring to a Gerrit project."
},
"cloudRepo": {
"$ref": "CloudRepoSourceContext",
"description": "A SourceContext referring to a revision in a cloud repo."
},
"cloudWorkspace": {
- "description": "A SourceContext referring to a snapshot in a cloud workspace.",
- "$ref": "CloudWorkspaceSourceContext"
- },
- "git": {
- "$ref": "GitSourceContext",
- "description": "A SourceContext referring to any third party Git repo (e.g. GitHub)."
+ "$ref": "CloudWorkspaceSourceContext",
+ "description": "A SourceContext referring to a snapshot in a cloud workspace."
}
},
- "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"
+ "id": "SourceContext"
},
"CloudRepoSourceContext": {
+ "description": "A CloudRepoSourceContext denotes a particular revision in a cloud\nrepo (a repo hosted by the Google Cloud Platform).",
+ "type": "object",
"properties": {
- "aliasContext": {
- "description": "An alias, which may be a branch or tag.",
- "$ref": "AliasContext"
- },
"revisionId": {
"description": "A revision ID.",
"type": "string"
@@ -909,36 +353,38 @@
"type": "string"
},
"repoId": {
- "$ref": "RepoId",
- "description": "The ID of the repo."
+ "description": "The ID of the repo.",
+ "$ref": "RepoId"
+ },
+ "aliasContext": {
+ "description": "An alias, which may be a branch or tag.",
+ "$ref": "AliasContext"
}
},
- "id": "CloudRepoSourceContext",
- "description": "A CloudRepoSourceContext denotes a particular revision in a cloud\nrepo (a repo hosted by the Google Cloud Platform).",
- "type": "object"
- },
- "RegisterDebuggeeResponse": {
- "properties": {
- "debuggee": {
- "$ref": "Debuggee",
- "description": "Debuggee resource.\nThe field `id` is guranteed to be set (in addition to the echoed fields).\nIf the field `is_disabled` is set to `true`, the agent should disable\nitself by removing all breakpoints and detaching from the application.\nIt should however continue to poll `RegisterDebuggee` until reenabled."
- }
- },
- "id": "RegisterDebuggeeResponse",
- "description": "Response for registering a debuggee.",
- "type": "object"
+ "id": "CloudRepoSourceContext"
},
"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."
+ "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",
+ "properties": {
+ "debuggee": {
+ "$ref": "Debuggee",
+ "description": "Debuggee resource.\nThe field `id` is guranteed to be set (in addition to the echoed fields).\nIf the field `is_disabled` is set to `true`, the agent should disable\nitself by removing all breakpoints and detaching from the application.\nIt should however continue to poll `RegisterDebuggee` until reenabled."
+ }
+ },
+ "id": "RegisterDebuggeeResponse"
+ },
"GetBreakpointResponse": {
"description": "Response for getting breakpoint information.",
"type": "object",
@@ -951,6 +397,8 @@
"id": "GetBreakpointResponse"
},
"StatusMessage": {
+ "description": "Represents a contextual status message.\nThe message can indicate an error or informational status, and refer to\nspecific parts of the containing object.\nFor example, the `Breakpoint.status` field can indicate an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.",
+ "type": "object",
"properties": {
"isError": {
"description": "Distinguishes errors from informational messages.",
@@ -961,6 +409,8 @@
"$ref": "FormatMessage"
},
"refersTo": {
+ "description": "Reference to which the message applies.",
+ "type": "string",
"enumDescriptions": [
"Status doesn't refer to any particular input.",
"Status applies to the breakpoint and is related to its location.",
@@ -978,14 +428,10 @@
"BREAKPOINT_AGE",
"VARIABLE_NAME",
"VARIABLE_VALUE"
- ],
- "description": "Reference to which the message applies.",
- "type": "string"
+ ]
}
},
- "id": "StatusMessage",
- "description": "Represents a contextual status message.\nThe message can indicate an error or informational status, and refer to\nspecific parts of the containing object.\nFor example, the `Breakpoint.status` field can indicate an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.",
- "type": "object"
+ "id": "StatusMessage"
},
"GitSourceContext": {
"description": "A GitSourceContext denotes a particular revision in a third party Git\nrepository (e.g. GitHub).",
@@ -1003,7 +449,20 @@
"id": "GitSourceContext"
},
"Variable": {
+ "description": "Represents a variable or an argument possibly of a compound object type.\nNote how the following variables are represented:\n\n1) A simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"int\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured variable\n name: \"x\",\n type: \"T\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T x = { 3, 7 };\n T* p = &x;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00500500\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captured:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00400400\"\n status { is_error: true, description { format: \"unavailable\" } }\n }\n\nThe status should describe the reason for the missing value,\nsuch as `\u003coptimized out\u003e`, `\u003cinaccessible\u003e`, `\u003cpointers limit reached\u003e`.\n\nNote that a null pointer should not have members.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captured variable\n name: \"p\",\n value: \"0x00500500\",\n type: \"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed pointer where the pointee was not captured:\n\n int* p = new int(7);\n int** pp = &p;\n\n { // Captured variable\n name: \"pp\",\n value: \"0x00500500\",\n type: \"int**\",\n members {\n value: \"0x00400400\",\n type: \"int*\"\n status {\n is_error: true,\n description: { format: \"unavailable\" } }\n }\n }\n }\n\nTo optimize computation, memory and network traffic, variables that\nrepeat in the output multiple times can be stored once in a shared\nvariable table and be referenced using the `var_table_index` field. The\nvariables stored in the shared table are nameless and are essentially\na partition of the complete variable. To reconstruct the complete\nvariable, merge the referencing variable with the referenced variable.\n\nWhen using the shared variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = &x;\n T& r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Captured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table_index: 3 }\n { name: \"r\", type=\"T&\", var_table_index: 3 }\n\n { // Shared variable table entry #3:\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\nNote that the pointer address is stored with the referencing variable\nand not with the referenced variable. This allows the referenced variable\nto be shared between pointers and references.\n\nThe type field is optional. The debugger agent may or may not support it.",
+ "type": "object",
"properties": {
+ "members": {
+ "description": "Members contained or pointed to by the variable.",
+ "type": "array",
+ "items": {
+ "$ref": "Variable"
+ }
+ },
+ "status": {
+ "description": "Status associated with the variable. This field will usually stay\nunset. A status of a single variable only applies to that variable or\nexpression. The rest of breakpoint data still remains valid. Variables\nmight be reported in error state even when breakpoint is not in final\nstate.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either case variable value and members will be unset.\n\nExample of error message applied to name: `Invalid expression syntax`.\n\nExample of information message applied to value: `Not captured`.\n\nExamples of error message applied to value:\n\n* `Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dereference`",
+ "$ref": "StatusMessage"
+ },
"name": {
"description": "Name of the variable, if any.",
"type": "string"
@@ -1020,40 +479,581 @@
"value": {
"description": "Simple value of the variable.",
"type": "string"
- },
- "members": {
- "description": "Members contained or pointed to by the variable.",
+ }
+ },
+ "id": "Variable"
+ },
+ "StackFrame": {
+ "description": "Represents a stack frame context.",
+ "type": "object",
+ "properties": {
+ "arguments": {
+ "description": "Set of arguments passed to this function.\nNote that this might not be populated for all stack frames.",
"type": "array",
"items": {
"$ref": "Variable"
}
},
- "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"
+ "locals": {
+ "description": "Set of local variables at the stack frame location.\nNote that this might not be populated for all stack frames.",
+ "type": "array",
+ "items": {
+ "$ref": "Variable"
+ }
+ },
+ "location": {
+ "description": "Source location of the call site.",
+ "$ref": "SourceLocation"
+ },
+ "function": {
+ "description": "Demangled function name at the call site.",
+ "type": "string"
}
},
- "id": "Variable",
- "description": "Represents a variable or an argument possibly of a compound object type.\nNote how the following variables are represented:\n\n1) A simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"int\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured variable\n name: \"x\",\n type: \"T\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T x = { 3, 7 };\n T* p = &x;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00500500\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captured:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00400400\"\n status { is_error: true, description { format: \"unavailable\" } }\n }\n\nThe status should describe the reason for the missing value,\nsuch as `\u003coptimized out\u003e`, `\u003cinaccessible\u003e`, `\u003cpointers limit reached\u003e`.\n\nNote that a null pointer should not have members.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captured variable\n name: \"p\",\n value: \"0x00500500\",\n type: \"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed pointer where the pointee was not captured:\n\n int* p = new int(7);\n int** pp = &p;\n\n { // Captured variable\n name: \"pp\",\n value: \"0x00500500\",\n type: \"int**\",\n members {\n value: \"0x00400400\",\n type: \"int*\"\n status {\n is_error: true,\n description: { format: \"unavailable\" } }\n }\n }\n }\n\nTo optimize computation, memory and network traffic, variables that\nrepeat in the output multiple times can be stored once in a shared\nvariable table and be referenced using the `var_table_index` field. The\nvariables stored in the shared table are nameless and are essentially\na partition of the complete variable. To reconstruct the complete\nvariable, merge the referencing variable with the referenced variable.\n\nWhen using the shared variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = &x;\n T& r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Captured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table_index: 3 }\n { name: \"r\", type=\"T&\", var_table_index: 3 }\n\n { // Shared variable table entry #3:\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\nNote that the pointer address is stored with the referencing variable\nand not with the referenced variable. This allows the referenced variable\nto be shared between pointers and references.\n\nThe type field is optional. The debugger agent may or may not support it.",
- "type": "object"
+ "id": "StackFrame"
+ },
+ "RepoId": {
+ "description": "A unique identifier for a cloud repo.",
+ "type": "object",
+ "properties": {
+ "projectRepoId": {
+ "$ref": "ProjectRepoId",
+ "description": "A combination of a project ID and a repo name."
+ },
+ "uid": {
+ "description": "A server-assigned, globally unique identifier.",
+ "type": "string"
+ }
+ },
+ "id": "RepoId"
+ },
+ "FormatMessage": {
+ "description": "Represents a message with parameters.",
+ "type": "object",
+ "properties": {
+ "parameters": {
+ "description": "Optional parameters to be embedded into the message.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "format": {
+ "description": "Format template for the message. The `format` uses placeholders `$0`,\n`$1`, etc. to reference parameters. `$$` can be used to denote the `$`\ncharacter.\n\nExamples:\n\n* `Failed to load '$0' which helps debug $1 the first time it\n is loaded. Again, $0 is very important.`\n* `Please pay $$10 to use $0 instead of $1.`",
+ "type": "string"
+ }
+ },
+ "id": "FormatMessage"
+ },
+ "ExtendedSourceContext": {
+ "description": "An ExtendedSourceContext is a SourceContext combined with additional\ndetails describing the context.",
+ "type": "object",
+ "properties": {
+ "context": {
+ "description": "Any source context.",
+ "$ref": "SourceContext"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels with user defined metadata.",
+ "type": "object"
+ }
+ },
+ "id": "ExtendedSourceContext"
+ },
+ "AliasContext": {
+ "description": "An alias to a repo revision.",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "description": "The alias kind.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use.",
+ "Git tag",
+ "Git branch",
+ "OTHER is used to specify non-standard aliases, those not of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar\", it\nis considered to be of kind OTHER."
+ ],
+ "enum": [
+ "ANY",
+ "FIXED",
+ "MOVABLE",
+ "OTHER"
+ ]
+ },
+ "name": {
+ "description": "The alias name.",
+ "type": "string"
+ }
+ },
+ "id": "AliasContext"
+ },
+ "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"
+ },
+ "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"
+ },
+ "SourceLocation": {
+ "description": "Represents a location in the source code.",
+ "type": "object",
+ "properties": {
+ "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"
}
},
"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 Debugger",
"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_debugger": {
"description": "Use Stackdriver 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": {
+ "controller": {
+ "resources": {
+ "debuggees": {
+ "methods": {
+ "register": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "RegisterDebuggeeResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "flatPath": "v2/controller/debuggees/register",
+ "id": "clouddebugger.controller.debuggees.register",
+ "path": "v2/controller/debuggees/register",
+ "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."
+ }
+ },
+ "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",
+ "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",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "debugger": {
+ "resources": {
+ "debuggees": {
+ "methods": {
+ "list": {
+ "description": "Lists all the debuggees that the user has access to.",
+ "response": {
+ "$ref": "ListDebuggeesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "parameters": {
+ "clientVersion": {
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string",
+ "location": "query"
+ },
+ "includeInactive": {
+ "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "project": {
+ "description": "Project number of a Google Cloud project whose debuggees to list.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/debugger/debuggees",
+ "path": "v2/debugger/debuggees",
+ "id": "clouddebugger.debugger.debuggees.list"
+ }
+ },
+ "resources": {
+ "breakpoints": {
+ "methods": {
+ "get": {
+ "description": "Gets breakpoint information.",
+ "response": {
+ "$ref": "GetBreakpointResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId",
+ "breakpointId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "debuggeeId": {
+ "location": "path",
+ "description": "ID of the debuggee whose breakpoint to get.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.get"
+ },
+ "list": {
+ "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": {
+ "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": {
+ "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": {
+ "location": "path",
+ "description": "ID of the debuggee whose breakpoints to list.",
+ "required": true,
+ "type": "string"
+ },
+ "waitToken": {
+ "location": "query",
+ "description": "A wait token that, if specified, blocks the call until the breakpoints\nlist has changed, or a server selected timeout has expired. The value\nshould be set from the last response. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which\nshould be called again with the same `wait_token`.",
+ "type": "string"
+ }
+ }
+ },
+ "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": {
+ "debuggeeId": {
+ "location": "path",
+ "description": "ID of the debuggee where the breakpoint is to be set.",
+ "required": true,
+ "type": "string"
+ },
+ "clientVersion": {
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.set"
+ },
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "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": {
+ "location": "path",
+ "description": "ID of the debuggee whose breakpoint to delete.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ }
}
}
diff --git a/clouderrorreporting/v1beta1/clouderrorreporting-api.json b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
index 126c7b4..c3b6e50 100644
--- a/clouderrorreporting/v1beta1/clouderrorreporting-api.json
+++ b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
@@ -1,524 +1,15 @@
{
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "deleteEvents": {
- "path": "v1beta1/{+projectName}/events",
- "id": "clouderrorreporting.projects.deleteEvents",
- "description": "Deletes all error events of a given project.",
- "response": {
- "$ref": "DeleteEventsResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "DELETE",
- "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\nID](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"
- }
- },
- "resources": {
- "events": {
- "methods": {
- "report": {
- "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",
- "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"
- }
- },
- "list": {
- "id": "clouderrorreporting.projects.events.list",
- "path": "v1beta1/{+projectName}/events",
- "description": "Lists the specified events.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectName"
- ],
- "response": {
- "$ref": "ListEventsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageToken": {
- "description": "[Optional] A `next_page_token` provided by a previous response.",
- "type": "string",
- "location": "query"
- },
- "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.",
- "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"
- },
- "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": {
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/events"
- }
- }
- },
- "groups": {
- "methods": {
- "get": {
- "response": {
- "$ref": "ErrorGroup"
- },
- "parameterOrder": [
- "groupName"
- ],
- "httpMethod": "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}",
- "path": "v1beta1/{+groupName}",
- "id": "clouderrorreporting.projects.groups.get",
- "description": "Get the specified group."
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ErrorGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
- "id": "clouderrorreporting.projects.groups.update",
- "path": "v1beta1/{+name}",
- "description": "Replace the data for the specified group.\nFails if the group does not exist.",
- "request": {
- "$ref": "ErrorGroup"
- }
- }
- }
- },
- "groupStats": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListGroupStatsResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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": {
- "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
- "type": "string",
- "location": "query"
- },
- "timeRange.period": {
- "description": "Restricts the query to the specified time range.",
- "type": "string",
- "location": "query",
- "enum": [
- "PERIOD_UNSPECIFIED",
- "PERIOD_1_HOUR",
- "PERIOD_6_HOURS",
- "PERIOD_1_DAY",
- "PERIOD_1_WEEK",
- "PERIOD_30_DAYS"
- ]
- },
- "alignment": {
- "location": "query",
- "enum": [
- "ERROR_COUNT_ALIGNMENT_UNSPECIFIED",
- "ALIGNMENT_EQUAL_ROUNDED",
- "ALIGNMENT_EQUAL_AT_END"
- ],
- "description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",
- "type": "string"
- },
- "groupId": {
- "repeated": true,
- "location": "query",
- "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.",
- "type": "string"
- },
- "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"
- },
- "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"
- ]
- },
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/groupStats",
- "path": "v1beta1/{+projectName}/groupStats",
- "id": "clouderrorreporting.projects.groupStats.list",
- "description": "Lists the specified groups."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- }
- },
- "version": "v1beta1",
- "baseUrl": "https://clouderrorreporting.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.\n",
- "servicePath": "",
- "basePath": "",
- "revision": "20180119",
- "documentationLink": "https://cloud.google.com/error-reporting/",
- "id": "clouderrorreporting:v1beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ReportedErrorEvent": {
- "id": "ReportedErrorEvent",
- "description": "An error event which is reported to the Error Reporting system.",
- "type": "object",
- "properties": {
- "message": {
- "description": "[Required] The error message.\nIf no `context.reportLocation` is provided, the message must contain a\nheader (typically consisting of the exception type name and an error\nmessage) and an exception stack trace in one of the supported programming\nlanguages and formats.\nSupported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.\nSupported stack trace formats are:\n\n* **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).\n* **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).\n* **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API)\nas returned by V8.\n* **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).\n* **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).\n* **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`\nand contain the result of [`(string)$exception`](http://php.net/manual/en/exception.tostring.php).\n* **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).",
- "type": "string"
- },
- "serviceContext": {
- "$ref": "ServiceContext",
- "description": "[Required] The service context in which this error has occurred."
- },
- "eventTime": {
- "description": "[Optional] Time when the event occurred.\nIf not provided, the time when the event was received by the\nError Reporting system will be used.",
- "format": "google-datetime",
- "type": "string"
- },
- "context": {
- "$ref": "ErrorContext",
- "description": "[Optional] A description of the context in which the error occurred."
- }
- }
- },
- "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": {
- "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.",
- "$ref": "SourceLocation"
- },
- "sourceReferences": {
- "description": "Source code that was used to build the executable which has\ncaused the given error message.",
- "type": "array",
- "items": {
- "$ref": "SourceReference"
- }
- },
- "httpRequest": {
- "description": "The HTTP request which was processed when the error was\ntriggered.",
- "$ref": "HttpRequestContext"
- }
- }
- },
- "TrackingIssue": {
- "id": "TrackingIssue",
- "description": "Information related to tracking the progress on resolving the error.",
- "type": "object",
- "properties": {
- "url": {
- "description": "A URL pointing to a related entry in an issue tracking system.\nExample: https://github.com/user/project/issues/4",
- "type": "string"
- }
- }
- },
- "ErrorGroupStats": {
- "description": "Data extracted for a specific group based on certain filter criteria,\nsuch as a given time period and/or service filter.",
- "type": "object",
- "properties": {
- "affectedServices": {
- "description": "Service contexts with a non-zero error count for the given filter\ncriteria. This list can be truncated if multiple services are affected.\nRefer to `num_affected_services` for the total count.",
- "type": "array",
- "items": {
- "$ref": "ServiceContext"
- }
- },
- "numAffectedServices": {
- "description": "The total number of services with a non-zero error count for the given\nfilter criteria.",
- "format": "int32",
- "type": "integer"
- },
- "representative": {
- "$ref": "ErrorEvent",
- "description": "An arbitrary event that is chosen as representative for the whole group.\nThe representative event is intended to be used as a quick preview for\nthe whole group. Events in the group are usually sufficiently similar\nto each other such that showing an arbitrary representative provides\ninsight into the characteristics of the group as a whole."
- },
- "timedCounts": {
- "description": "Approximate number of occurrences over time.\nTimed counts returned by ListGroups are guaranteed to be:\n\n- Inside the requested time interval\n- Non-overlapping, and\n- Ordered by ascending time.",
- "type": "array",
- "items": {
- "$ref": "TimedCount"
- }
- },
- "group": {
- "$ref": "ErrorGroup",
- "description": "Group data that is independent of the filter criteria."
- },
- "firstSeenTime": {
- "description": "Approximate first occurrence that was ever seen for this group\nand which matches the given filter criteria, ignoring the\ntime_range that was specified in the request.",
- "format": "google-datetime",
- "type": "string"
- },
- "count": {
- "description": "Approximate total number of events in the given group that match\nthe filter criteria.",
- "format": "int64",
- "type": "string"
- },
- "lastSeenTime": {
- "description": "Approximate last occurrence that was ever seen for this group and\nwhich matches the given filter criteria, ignoring the time_range\nthat was specified in the request.",
- "format": "google-datetime",
- "type": "string"
- },
- "affectedUsersCount": {
- "description": "Approximate number of affected users in the given group that\nmatch the filter criteria.\nUsers are distinguished by data in the `ErrorContext` of the\nindividual error events, such as their login name or their remote\nIP address in case of HTTP requests.\nThe number of affected users can be zero even if the number of\nerrors is non-zero if no data was provided from which the\naffected user could be deduced.\nUsers are counted based on data in the request\ncontext that was provided in the error report. If more users are\nimplicitly affected, such as due to a crash of the whole service,\nthis is not reflected here.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "ErrorGroupStats"
- },
"ListEventsResponse": {
- "id": "ListEventsResponse",
"description": "Contains a set of requested error events.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.",
+ "type": "string"
+ },
"timeRangeBegin": {
"description": "The timestamp specifies the start time to which the request was restricted.",
"format": "google-datetime",
@@ -530,12 +21,9 @@
"items": {
"$ref": "ErrorEvent"
}
- },
- "nextPageToken": {
- "description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.",
- "type": "string"
}
- }
+ },
+ "id": "ListEventsResponse"
},
"TimedCount": {
"description": "The number of errors in a given time period.\nAll numbers are approximate since the error events are sampled\nbefore counting them.",
@@ -582,10 +70,13 @@
"id": "ErrorGroup"
},
"SourceLocation": {
- "id": "SourceLocation",
"description": "Indicates a location in the source code of the service for which errors are\nreported. `functionName` must be provided by the application when reporting\nan error, unless the error report contains a `message` with a supported\nexception stack trace. All fields are optional for the later case.",
"type": "object",
"properties": {
+ "functionName": {
+ "description": "Human-readable name of a function or method.\nThe value can include optional context like the class or package name.\nFor example, `my.package.MyClass.method` in case of Java.",
+ "type": "string"
+ },
"filePath": {
"description": "The source code filename, which can include a truncated relative\npath, or a full path from a production machine.",
"type": "string"
@@ -594,12 +85,9 @@
"description": "1-based. 0 indicates that the line number is unknown.",
"format": "int32",
"type": "integer"
- },
- "functionName": {
- "description": "Human-readable name of a function or method.\nThe value can include optional context like the class or package name.\nFor example, `my.package.MyClass.method` in case of Java.",
- "type": "string"
}
- }
+ },
+ "id": "SourceLocation"
},
"ServiceContext": {
"description": "Describes a running service that sends errors.\nIts version changes over time and multiple versions can run in parallel.",
@@ -681,10 +169,13 @@
},
"id": "ListGroupStatsResponse"
},
+ "DeleteEventsResponse": {
+ "properties": {},
+ "id": "DeleteEventsResponse",
+ "description": "Response message for deleting error events.",
+ "type": "object"
+ },
"SourceReference": {
- "id": "SourceReference",
- "description": "A reference to a particular snapshot of the source tree used to build and\ndeploy an application.",
- "type": "object",
"properties": {
"repository": {
"description": "Optional. A URI string identifying the repository.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
@@ -694,13 +185,10 @@
"description": "The canonical and persistent identifier of the deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
"type": "string"
}
- }
- },
- "DeleteEventsResponse": {
- "id": "DeleteEventsResponse",
- "description": "Response message for deleting error events.",
- "type": "object",
- "properties": {}
+ },
+ "id": "SourceReference",
+ "description": "A reference to a particular snapshot of the source tree used to build and\ndeploy an application.",
+ "type": "object"
},
"ErrorEvent": {
"description": "An error event which is returned by the Error Reporting system.",
@@ -712,26 +200,141 @@
"type": "string"
},
"context": {
- "description": "Data about the context in which the error occurred.",
- "$ref": "ErrorContext"
+ "$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": {
- "$ref": "ServiceContext",
- "description": "The `ServiceContext` for which this error was reported."
+ "description": "The `ServiceContext` for which this error was reported.",
+ "$ref": "ServiceContext"
}
},
"id": "ErrorEvent"
+ },
+ "ReportedErrorEvent": {
+ "description": "An error event which is reported to the Error Reporting system.",
+ "type": "object",
+ "properties": {
+ "context": {
+ "$ref": "ErrorContext",
+ "description": "[Optional] A description of the context in which the error occurred."
+ },
+ "message": {
+ "description": "[Required] The error message.\nIf no `context.reportLocation` is provided, the message must contain a\nheader (typically consisting of the exception type name and an error\nmessage) and an exception stack trace in one of the supported programming\nlanguages and formats.\nSupported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.\nSupported stack trace formats are:\n\n* **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).\n* **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).\n* **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API)\nas returned by V8.\n* **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).\n* **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).\n* **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`\nand contain the result of [`(string)$exception`](http://php.net/manual/en/exception.tostring.php).\n* **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).",
+ "type": "string"
+ },
+ "serviceContext": {
+ "description": "[Required] The service context in which this error has occurred.",
+ "$ref": "ServiceContext"
+ },
+ "eventTime": {
+ "description": "[Optional] Time when the event occurred.\nIf not provided, the time when the event was received by the\nError Reporting system will be used.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "ReportedErrorEvent"
+ },
+ "ErrorContext": {
+ "properties": {
+ "reportLocation": {
+ "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.",
+ "$ref": "SourceLocation"
+ },
+ "sourceReferences": {
+ "description": "Source code that was used to build the executable which has\ncaused the given error message.",
+ "type": "array",
+ "items": {
+ "$ref": "SourceReference"
+ }
+ },
+ "httpRequest": {
+ "$ref": "HttpRequestContext",
+ "description": "The HTTP request which was processed when the error was\ntriggered."
+ },
+ "user": {
+ "description": "The user who caused or was affected by the crash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniquely identifies the user.\nWhen sending an error report, leave this field empty if the user was not\nlogged in. In this case the\nError Reporting system will use other data, such as remote IP address, to\ndistinguish affected users. See `affected_users_count` in\n`ErrorGroupStats`.",
+ "type": "string"
+ }
+ },
+ "id": "ErrorContext",
+ "description": "A description of the context in which an error occurred.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.",
+ "type": "object"
+ },
+ "TrackingIssue": {
+ "properties": {
+ "url": {
+ "description": "A URL pointing to a related entry in an issue tracking system.\nExample: https://github.com/user/project/issues/4",
+ "type": "string"
+ }
+ },
+ "id": "TrackingIssue",
+ "description": "Information related to tracking the progress on resolving the error.",
+ "type": "object"
+ },
+ "ErrorGroupStats": {
+ "description": "Data extracted for a specific group based on certain filter criteria,\nsuch as a given time period and/or service filter.",
+ "type": "object",
+ "properties": {
+ "affectedServices": {
+ "description": "Service contexts with a non-zero error count for the given filter\ncriteria. This list can be truncated if multiple services are affected.\nRefer to `num_affected_services` for the total count.",
+ "type": "array",
+ "items": {
+ "$ref": "ServiceContext"
+ }
+ },
+ "numAffectedServices": {
+ "description": "The total number of services with a non-zero error count for the given\nfilter criteria.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "representative": {
+ "description": "An arbitrary event that is chosen as representative for the whole group.\nThe representative event is intended to be used as a quick preview for\nthe whole group. Events in the group are usually sufficiently similar\nto each other such that showing an arbitrary representative provides\ninsight into the characteristics of the group as a whole.",
+ "$ref": "ErrorEvent"
+ },
+ "timedCounts": {
+ "description": "Approximate number of occurrences over time.\nTimed counts returned by ListGroups are guaranteed to be:\n\n- Inside the requested time interval\n- Non-overlapping, and\n- Ordered by ascending time.",
+ "type": "array",
+ "items": {
+ "$ref": "TimedCount"
+ }
+ },
+ "group": {
+ "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.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "count": {
+ "description": "Approximate total number of events in the given group that match\nthe filter criteria.",
+ "format": "int64",
+ "type": "string"
+ },
+ "affectedUsersCount": {
+ "description": "Approximate number of affected users in the given group that\nmatch the filter criteria.\nUsers are distinguished by data in the `ErrorContext` of the\nindividual error events, such as their login name or their remote\nIP address in case of HTTP requests.\nThe number of affected users can be zero even if the number of\nerrors is non-zero if no data was provided from which the\naffected user could be deduced.\nUsers are counted based on data in the request\ncontext that was provided in the error report. If more users are\nimplicitly affected, such as due to a crash of the whole service,\nthis is not reflected here.",
+ "format": "int64",
+ "type": "string"
+ },
+ "lastSeenTime": {
+ "description": "Approximate last occurrence that was ever seen for this group and\nwhich matches the given filter criteria, ignoring the time_range\nthat was specified in the request.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "ErrorGroupStats"
}
},
- "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"canonicalName": "Clouderrorreporting",
"auth": {
"oauth2": {
@@ -746,5 +349,402 @@
"ownerDomain": "google.com",
"name": "clouderrorreporting",
"batchPath": "batch",
- "title": "Stackdriver Error Reporting API"
+ "title": "Stackdriver Error Reporting API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "methods": {
+ "deleteEvents": {
+ "description": "Deletes all error events of a given project.",
+ "response": {
+ "$ref": "DeleteEventsResponse"
+ },
+ "parameterOrder": [
+ "projectName"
+ ],
+ "httpMethod": "DELETE",
+ "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\nID](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",
+ "path": "v1beta1/{+projectName}/events",
+ "id": "clouderrorreporting.projects.deleteEvents"
+ }
+ },
+ "resources": {
+ "events": {
+ "methods": {
+ "list": {
+ "description": "Lists the specified events.",
+ "response": {
+ "$ref": "ListEventsResponse"
+ },
+ "parameterOrder": [
+ "projectName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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": {
+ "location": "query",
+ "description": "[Optional] A `next_page_token` provided by a previous response.",
+ "type": "string"
+ },
+ "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"
+ },
+ "timeRange.period": {
+ "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",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/events",
+ "path": "v1beta1/{+projectName}/events",
+ "id": "clouderrorreporting.projects.events.list"
+ },
+ "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": {
+ "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"
+ }
+ }
+ },
+ "groups": {
+ "methods": {
+ "update": {
+ "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
+ "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"
+ ]
+ },
+ "get": {
+ "description": "Get the specified group.",
+ "response": {
+ "$ref": "ErrorGroup"
+ },
+ "parameterOrder": [
+ "groupName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "groupName": {
+ "description": "[Required] The group resource name. Written as\n\u003ccode\u003eprojects/\u003cvar\u003eprojectID\u003c/var\u003e/groups/\u003cvar\u003egroup_name\u003c/var\u003e\u003c/code\u003e.\nCall\n\u003ca href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\"\u003e\n\u003ccode\u003egroupStats.list\u003c/code\u003e\u003c/a\u003e to return a list of groups belonging to\nthis project.\n\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-group\u003c/code\u003e",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
+ "path": "v1beta1/{+groupName}",
+ "id": "clouderrorreporting.projects.groups.get"
+ }
+ }
+ },
+ "groupStats": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListGroupStatsResponse"
+ },
+ "parameterOrder": [
+ "projectName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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": {
+ "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
+ "type": "string",
+ "location": "query"
+ },
+ "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": [
+ "ERROR_COUNT_ALIGNMENT_UNSPECIFIED",
+ "ALIGNMENT_EQUAL_ROUNDED",
+ "ALIGNMENT_EQUAL_AT_END"
+ ],
+ "description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",
+ "type": "string"
+ },
+ "groupId": {
+ "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "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"
+ },
+ "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": {
+ "location": "query",
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
+ "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"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/groupStats",
+ "path": "v1beta1/{+projectName}/groupStats",
+ "id": "clouderrorreporting.projects.groupStats.list",
+ "description": "Lists the specified groups."
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "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": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ }
+ },
+ "version": "v1beta1",
+ "baseUrl": "https://clouderrorreporting.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.\n",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20180119",
+ "documentationLink": "https://cloud.google.com/error-reporting/",
+ "id": "clouderrorreporting:v1beta1"
}
diff --git a/cloudfunctions/v1/cloudfunctions-api.json b/cloudfunctions/v1/cloudfunctions-api.json
index 4f9b0e8..55736b1 100644
--- a/cloudfunctions/v1/cloudfunctions-api.json
+++ b/cloudfunctions/v1/cloudfunctions-api.json
@@ -17,183 +17,121 @@
"title": "Google Cloud Functions API",
"ownerName": "Google",
"resources": {
+ "operations": {
+ "methods": {
+ "list": {
+ "path": "v1/operations",
+ "id": "cloudfunctions.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "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"
+ },
+ "get": {
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "cloudfunctions.operations.get",
+ "path": "v1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
"projects": {
"resources": {
"locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource that owns the locations collection, if applicable.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "path": "v1/{+name}/locations",
+ "id": "cloudfunctions.projects.locations.list"
+ }
+ },
"resources": {
"functions": {
"methods": {
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "location"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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."
- },
- "call": {
- "path": "v1/{+name}:call",
- "id": "cloudfunctions.projects.locations.functions.call",
- "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
- "request": {
- "$ref": "CallFunctionRequest"
- },
- "response": {
- "$ref": "CallFunctionResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path",
- "description": "The name of the function to be called.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call"
- },
- "generateUploadUrl": {
- "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls.\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-google-content-length-range: 0,104857600`",
- "request": {
- "$ref": "GenerateUploadUrlRequest"
- },
- "response": {
- "$ref": "GenerateUploadUrlResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl",
- "path": "v1/{+parent}/functions:generateUploadUrl",
- "id": "cloudfunctions.projects.locations.functions.generateUploadUrl"
- },
- "generateDownloadUrl": {
- "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls",
- "request": {
- "$ref": "GenerateDownloadUrlRequest"
- },
- "response": {
- "$ref": "GenerateDownloadUrlResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl",
- "path": "v1/{+name}:generateDownloadUrl",
- "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "CloudFunction"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path",
- "description": "The name of the function which details should be obtained.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "id": "cloudfunctions.projects.locations.functions.get",
- "path": "v1/{+name}",
- "description": "Returns a function with the given name from the requested project."
- },
- "patch": {
- "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": {
- "location": "path",
- "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "path": "v1/{+name}",
- "id": "cloudfunctions.projects.locations.functions.patch"
- },
"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": {
@@ -232,151 +170,234 @@
"parent"
],
"parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of functions to return per call.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
+ "required": true,
+ "type": "string"
+ },
"pageToken": {
"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": {
- "description": "Maximum number of functions to return per call.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
+ }
+ },
+ "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.",
+ "response": {
+ "$ref": "CallFunctionResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The name of the function to be called.",
+ "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}:call",
+ "path": "v1/{+name}:call",
+ "id": "cloudfunctions.projects.locations.functions.call"
+ },
+ "create": {
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "location"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "location": {
+ "location": "path",
+ "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions",
+ "path": "v1/{+location}/functions",
+ "id": "cloudfunctions.projects.locations.functions.create"
+ },
+ "generateUploadUrl": {
+ "response": {
+ "$ref": "GenerateUploadUrlResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
"parent": {
- "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.",
+ "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path"
}
},
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl",
+ "path": "v1/{+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": {
+ "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": {
+ "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
+ },
+ "patch": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "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": {
+ "location": "query",
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "name": {
+ "location": "path",
+ "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
+ }
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "CloudFunction"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function which details should be obtained.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "path": "v1/{+name}",
+ "id": "cloudfunctions.projects.locations.functions.get",
+ "description": "Returns a function with the given name from the requested project."
}
}
}
- },
- "methods": {
- "list": {
- "path": "v1/{+name}/locations",
- "id": "cloudfunctions.projects.locations.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": {
- "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": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations"
- }
}
}
}
- },
- "operations": {
- "methods": {
- "list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "name": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations",
- "path": "v1/operations",
- "id": "cloudfunctions.operations.list"
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "id": "cloudfunctions.operations.get",
- "path": "v1/{+name}"
- }
- }
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
@@ -393,22 +414,22 @@
"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"
+ },
+ "callback": {
+ "description": "JSONP",
"type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
"location": "query"
},
"alt": {
@@ -433,51 +454,176 @@
"type": "string"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "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://cloudfunctions.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "API for managing lightweight user-provided functions executed in response to events.",
"servicePath": "",
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "revision": "20180120",
"documentationLink": "https://cloud.google.com/functions",
"id": "cloudfunctions:v1",
+ "revision": "20180120",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "ListFunctionsResponse": {
+ "properties": {
+ "functions": {
+ "description": "The functions that match the request.",
+ "type": "array",
+ "items": {
+ "$ref": "CloudFunction"
+ }
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1.ListFunctionsRequest\nto get more functions.",
+ "type": "string"
+ }
+ },
+ "id": "ListFunctionsResponse",
+ "description": "Response for the `ListFunctions` method.",
+ "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"
+ },
+ "CallFunctionResponse": {
+ "description": "Response of `CallFunction` method.",
+ "type": "object",
+ "properties": {
+ "executionId": {
+ "description": "Execution id of function invocation.",
+ "type": "string"
+ },
+ "result": {
+ "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.",
+ "type": "string"
+ },
+ "error": {
+ "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
+ "type": "string"
+ }
+ },
+ "id": "CallFunctionResponse"
+ },
+ "EventTrigger": {
+ "properties": {
+ "service": {
+ "description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the `google.storage` namespace.",
+ "type": "string"
+ },
+ "failurePolicy": {
+ "description": "Specifies policy for failed executions.",
+ "$ref": "FailurePolicy"
+ },
+ "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"
+ }
+ },
+ "id": "EventTrigger",
+ "description": "Describes EventTrigger, used to request events be sent from another\nservice.",
+ "type": "object"
+ },
+ "FailurePolicy": {
+ "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).",
+ "type": "object",
+ "properties": {
+ "retry": {
+ "$ref": "Retry",
+ "description": "If specified, then the function will be retried in case of a failure."
+ }
+ },
+ "id": "FailurePolicy"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata describing an Operation",
+ "type": "object",
+ "properties": {
+ "updateTime": {
+ "description": "The last update timestamp of the operation.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "target": {
+ "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
+ "type": "string"
+ },
+ "request": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The original request that started the operation.",
+ "type": "object"
+ },
+ "versionId": {
+ "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unknown operation type.",
+ "Triggered by CreateFunction call",
+ "Triggered by UpdateFunction call",
+ "Triggered by DeleteFunction call."
+ ],
+ "enum": [
+ "OPERATION_UNSPECIFIED",
+ "CREATE_FUNCTION",
+ "UPDATE_FUNCTION",
+ "DELETE_FUNCTION"
+ ],
+ "description": "Type of operation.",
+ "type": "string"
+ }
+ },
+ "id": "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"
+ },
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
"error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
@@ -507,6 +653,8 @@
"id": "Operation"
},
"OperationMetadataV1Beta2": {
+ "description": "Metadata describing an Operation",
+ "type": "object",
"properties": {
"updateTime": {
"description": "The last update timestamp of the operation.",
@@ -547,23 +695,12 @@
"type": "string"
}
},
- "id": "OperationMetadataV1Beta2",
- "description": "Metadata describing an Operation",
- "type": "object"
+ "id": "OperationMetadataV1Beta2"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"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",
@@ -574,6 +711,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"
@@ -590,30 +736,41 @@
"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.",
- "type": "string"
- },
"deployedUrl": {
"description": "Output only. The URL pointing to the hosted repository where the function\nwere defined at the time of deployment. It always points to a specific\ncommit in the format described above.",
"type": "string"
+ },
+ "url": {
+ "description": "The URL pointing to the hosted repository where the function is defined.\nThere are supported Cloud Source Repository URLs in the following\nformats:\n\nTo refer to a specific commit:\n`https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`\nTo refer to a moveable alias (branch):\n`https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`\nIn particular, to refer to HEAD use `master` moveable alias.\nTo refer to a specific fixed alias (tag):\n`https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`\n\nYou may omit `paths/*` if you want to use the main directory.",
+ "type": "string"
}
},
- "id": "SourceRepository",
- "description": "Describes SourceRepository, used to represent parameters related to\nsource repository where a function is hosted.",
- "type": "object"
+ "id": "SourceRepository"
},
"CloudFunction": {
"description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.",
"type": "object",
"properties": {
- "timeout": {
- "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.",
- "format": "google-duration",
+ "sourceUploadUrl": {
+ "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1.GenerateUploadUrl",
"type": "string"
},
+ "eventTrigger": {
+ "$ref": "EventTrigger",
+ "description": "A source that fires events in response to a condition in another service."
+ },
"status": {
+ "enumDescriptions": [
+ "Not specified. Invalid state.",
+ "Function has been succesfully deployed and is serving.",
+ "Function deployment failed and the function isn’t serving.",
+ "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",
@@ -623,22 +780,11 @@
"UNKNOWN"
],
"description": "Output only. Status of the function deployment.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. Invalid state.",
- "Function has been succesfully deployed and is serving.",
- "Function deployment failed and the function isn’t serving.",
- "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."
- ]
+ "type": "string"
},
- "eventTrigger": {
- "$ref": "EventTrigger",
- "description": "A source that fires events in response to a condition in another service."
- },
- "sourceUploadUrl": {
- "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1.GenerateUploadUrl",
+ "timeout": {
+ "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.",
+ "format": "google-duration",
"type": "string"
},
"availableMemoryMb": {
@@ -663,6 +809,10 @@
"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"
@@ -670,18 +820,14 @@
"description": "Labels associated with this Cloud Function.",
"type": "object"
},
- "entryPoint": {
- "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.",
- "type": "string"
- },
"updateTime": {
"description": "Output only. The last update timestamp of a Cloud Function.",
"format": "google-datetime",
"type": "string"
},
"httpsTrigger": {
- "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.",
@@ -706,34 +852,34 @@
"id": "HttpsTrigger"
},
"Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
"properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
- },
"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"
- },
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object"
+ }
+ },
+ "labels": {
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "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.",
@@ -762,16 +908,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": "Operation"
}
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
"id": "ListOperationsResponse"
@@ -786,152 +932,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.",
- "type": "string"
- },
- "functions": {
- "description": "The functions that match the request.",
- "type": "array",
- "items": {
- "$ref": "CloudFunction"
- }
- }
- },
- "id": "ListFunctionsResponse"
- },
- "CallFunctionResponse": {
- "description": "Response of `CallFunction` method.",
- "type": "object",
- "properties": {
- "executionId": {
- "description": "Execution id of function invocation.",
- "type": "string"
- },
- "result": {
- "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.",
- "type": "string"
- },
- "error": {
- "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
- "type": "string"
- }
- },
- "id": "CallFunctionResponse"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "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"
- },
- "EventTrigger": {
- "description": "Describes EventTrigger, used to request events be sent from another\nservice.",
- "type": "object",
- "properties": {
- "failurePolicy": {
- "description": "Specifies policy for failed executions.",
- "$ref": "FailurePolicy"
- },
- "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"
- }
- },
- "id": "EventTrigger"
- },
- "OperationMetadataV1": {
- "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": {
- "enum": [
- "OPERATION_UNSPECIFIED",
- "CREATE_FUNCTION",
- "UPDATE_FUNCTION",
- "DELETE_FUNCTION"
- ],
- "description": "Type of operation.",
- "type": "string",
- "enumDescriptions": [
- "Unknown operation type.",
- "Triggered by CreateFunction call",
- "Triggered by UpdateFunction call",
- "Triggered by DeleteFunction call."
- ]
- }
- },
- "id": "OperationMetadataV1",
- "description": "Metadata describing an Operation",
- "type": "object"
- },
- "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": {
- "description": "If specified, then the function will be retried in case of a failure.",
- "$ref": "Retry"
- }
- },
- "id": "FailurePolicy"
}
},
"protocol": "rest",
diff --git a/cloudfunctions/v1beta2/cloudfunctions-api.json b/cloudfunctions/v1beta2/cloudfunctions-api.json
index f387aff..e47e58e 100644
--- a/cloudfunctions/v1beta2/cloudfunctions-api.json
+++ b/cloudfunctions/v1beta2/cloudfunctions-api.json
@@ -1,7 +1,536 @@
{
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The resource that owns the locations collection, if applicable.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "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",
+ "description": "Lists information about the supported locations for this service."
+ }
+ },
+ "resources": {
+ "functions": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the function which should be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "path": "v1beta2/{+name}",
+ "id": "cloudfunctions.projects.locations.functions.delete",
+ "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListFunctionsResponse"
+ },
+ "parameterOrder": [
+ "location"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "location": {
+ "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of functions to return per call.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
+ "path": "v1beta2/{+location}/functions",
+ "id": "cloudfunctions.projects.locations.functions.list",
+ "description": "Returns a list of functions that belong to the requested project."
+ },
+ "create": {
+ "path": "v1beta2/{+location}/functions",
+ "id": "cloudfunctions.projects.locations.functions.create",
+ "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.",
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "location"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "location": {
+ "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"
+ },
+ "call": {
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
+ "path": "v1beta2/{+name}:call",
+ "id": "cloudfunctions.projects.locations.functions.call",
+ "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
+ "request": {
+ "$ref": "CallFunctionRequest"
+ },
+ "response": {
+ "$ref": "CallFunctionResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the function to be called.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
+ }
+ }
+ },
+ "generateUploadUrl": {
+ "id": "cloudfunctions.projects.locations.functions.generateUploadUrl",
+ "path": "v1beta2/{+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": {
+ "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": {
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl",
+ "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl",
+ "path": "v1beta2/{+name}:generateDownloadUrl",
+ "request": {
+ "$ref": "GenerateDownloadUrlRequest"
+ },
+ "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GenerateDownloadUrlResponse"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "response": {
+ "$ref": "CloudFunction"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function which details should be obtained.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "path": "v1beta2/{+name}",
+ "id": "cloudfunctions.projects.locations.functions.get",
+ "description": "Returns a function with the given name from the requested project."
+ },
+ "update": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "The name of the function to be updated.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "path": "v1beta2/{+name}",
+ "id": "cloudfunctions.projects.locations.functions.update",
+ "description": "Updates existing function.",
+ "request": {
+ "$ref": "CloudFunction"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "list": {
+ "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": "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": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/operations/{operationsId}",
+ "id": "cloudfunctions.operations.get",
+ "path": "v1beta2/{+name}"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.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": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ }
+ },
+ "version": "v1beta2",
+ "baseUrl": "https://cloudfunctions.googleapis.com/",
+ "servicePath": "",
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "cloudfunctions:v1beta2",
+ "documentationLink": "https://cloud.google.com/functions",
+ "revision": "20180120",
+ "discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "HTTPSTrigger": {
+ "description": "Describes HTTPSTrigger, could be used to connect web hooks to function.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "Output only. The deployed url for the function.",
+ "type": "string"
+ }
+ },
+ "id": "HTTPSTrigger"
+ },
+ "FailurePolicy": {
+ "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).",
+ "type": "object",
+ "properties": {
+ "retry": {
+ "$ref": "Retry",
+ "description": "If specified, then the function will be retried in case of a failure."
+ }
+ },
+ "id": "FailurePolicy"
+ },
+ "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"
+ },
+ "request": {
+ "description": "The original request that started the operation.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "versionId": {
+ "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unknown operation type.",
+ "Triggered by CreateFunction call",
+ "Triggered by UpdateFunction call",
+ "Triggered by DeleteFunction call."
+ ],
+ "enum": [
+ "OPERATION_UNSPECIFIED",
+ "CREATE_FUNCTION",
+ "UPDATE_FUNCTION",
+ "DELETE_FUNCTION"
+ ],
+ "description": "Type of operation.",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1"
+ },
"Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
"properties": {
"response": {
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
@@ -32,9 +561,7 @@
"type": "boolean"
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
+ "id": "Operation"
},
"OperationMetadataV1Beta2": {
"description": "Metadata describing an Operation",
@@ -82,6 +609,8 @@
"id": "OperationMetadataV1Beta2"
},
"Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
"properties": {
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
@@ -104,9 +633,7 @@
"type": "string"
}
},
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
+ "id": "Status"
},
"CallFunctionRequest": {
"description": "Request for the `CallFunction` method.",
@@ -121,18 +648,22 @@
},
"SourceRepository": {
"properties": {
+ "tag": {
+ "description": "The name of the tag that captures the state of the repository from\nwhich the function should be fetched.",
+ "type": "string"
+ },
"branch": {
"description": "The name of the branch from which the function should be fetched.",
"type": "string"
},
- "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"
},
+ "deployedRevision": {
+ "description": "Output only. The id of the revision that was resolved at the moment of\nfunction creation or update. For example when a user deployed from a\nbranch, it will be the revision id of the latest change on this branch at\nthat time. If user deployed from revision then this value will be always\nequal to the revision specified by the user.",
+ "type": "string"
+ },
"revision": {
"description": "The id of the revision that captures the state of the repository from\nwhich the function should be fetched.",
"type": "string"
@@ -140,10 +671,6 @@
"repositoryUrl": {
"description": "URL to the hosted repository where the function is defined. Only paths in\nhttps://source.developers.google.com domain are supported. The path should\ncontain the name of the repository.",
"type": "string"
- },
- "tag": {
- "description": "The name of the tag that captures the state of the repository from\nwhich the function should be fetched.",
- "type": "string"
}
},
"id": "SourceRepository",
@@ -151,11 +678,9 @@
"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": {
- "serviceAccount": {
- "description": "Output only. The service account of the function.",
- "type": "string"
- },
"sourceArchiveUrl": {
"description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function.",
"type": "string"
@@ -169,11 +694,11 @@
"type": "string"
},
"labels": {
- "description": "Labels associated with this Cloud Function.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Labels associated with this Cloud Function.",
+ "type": "object"
},
"sourceRepositoryUrl": {
"description": "The URL pointing to the hosted repository where the function is defined.\nThere are supported Cloud Source Repository URLs in the following\nformats:\n\nTo refer to a specific commit:\n`https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`\nTo refer to a moveable alias (branch):\n`https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`\nIn particular, to refer to HEAD use `master` moveable alias.\nTo refer to a specific fixed alias (tag):\n`https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`\n\nYou may omit `paths/*` if you want to use the main directory.",
@@ -192,11 +717,14 @@
"$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",
+ "sourceUploadUrl": {
+ "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1beta2.GenerateUploadUrl",
"type": "string"
},
+ "eventTrigger": {
+ "$ref": "EventTrigger",
+ "description": "A source that fires events in response to a condition in another service."
+ },
"status": {
"enumDescriptions": [
"Status not specified.",
@@ -215,12 +743,9 @@
"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",
+ "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": {
@@ -236,14 +761,22 @@
"description": "Output only.\nThe version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.",
"format": "int64",
"type": "string"
+ },
+ "serviceAccount": {
+ "description": "Output only. The service account of the function.",
+ "type": "string"
}
},
- "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"
+ "id": "CloudFunction"
},
"Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
"properties": {
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
+ "type": "string"
+ },
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
@@ -257,20 +790,14 @@
"type": "object"
},
"labels": {
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object"
}
},
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object"
+ "id": "Location"
},
"GenerateDownloadUrlResponse": {
"description": "Response of `GenerateDownloadUrl` method.",
@@ -296,22 +823,22 @@
"id": "GenerateUploadUrlRequest"
},
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Operation"
}
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
+ "id": "ListOperationsResponse"
},
"GenerateUploadUrlResponse": {
"description": "Response of `GenerateUploadUrl` method.",
@@ -328,22 +855,26 @@
"description": "Response for the `ListFunctions` method.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1beta2.ListFunctionsRequest\nto get more functions.",
- "type": "string"
- },
"functions": {
"description": "The functions that match the request.",
"type": "array",
"items": {
"$ref": "CloudFunction"
}
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1beta2.ListFunctionsRequest\nto get more functions.",
+ "type": "string"
}
},
"id": "ListFunctionsResponse"
},
"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"
@@ -351,10 +882,6 @@
"error": {
"description": "Either system or user-function generated error. Set if execution\nwas not successful.",
"type": "string"
- },
- "executionId": {
- "description": "Execution id of function invocation.",
- "type": "string"
}
},
"id": "CallFunctionResponse",
@@ -365,16 +892,16 @@
"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"
@@ -383,10 +910,6 @@
"description": "Describes EventTrigger, used to request events be sent from another\nservice.",
"type": "object",
"properties": {
- "eventType": {
- "description": "`event_type` names contain the service that is sending an event and the\nkind of event that was fired. Must be of the form\n`providers/*/eventTypes/*` e.g. Directly handle a Message published to\nGoogle Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.\n\nHandle an object changing in Google Cloud Storage:\n`providers/cloud.storage/eventTypes/object.change`\n\nHandle a write to the Firebase Realtime Database:\n`providers/google.firebase.database/eventTypes/ref.write`",
- "type": "string"
- },
"resource": {
"description": "Which instance of the source's service should send events. E.g. for Pub/Sub\nthis would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud\nStorage this would be a bucket at `projects/*/buckets/*`. For any source\nthat only supports one instance per-project, this should be the name of the\nproject (`projects/*`)",
"type": "string"
@@ -396,96 +919,21 @@
"type": "string"
},
"failurePolicy": {
- "description": "Specifies policy for failed executions.",
- "$ref": "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"
}
},
"id": "EventTrigger"
- },
- "HTTPSTrigger": {
- "properties": {
- "url": {
- "description": "Output only. The deployed url for the function.",
- "type": "string"
- }
- },
- "id": "HTTPSTrigger",
- "description": "Describes HTTPSTrigger, could be used to connect web hooks to function.",
- "type": "object"
- },
- "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.",
- "format": "uint64",
- "type": "string"
- }
- },
- "id": "GenerateDownloadUrlRequest"
- },
- "OperationMetadataV1": {
- "description": "Metadata describing an Operation",
- "type": "object",
- "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": {
- "description": "Type of operation.",
- "type": "string",
- "enumDescriptions": [
- "Unknown operation type.",
- "Triggered by CreateFunction call",
- "Triggered by UpdateFunction call",
- "Triggered by DeleteFunction call."
- ],
- "enum": [
- "OPERATION_UNSPECIFIED",
- "CREATE_FUNCTION",
- "UPDATE_FUNCTION",
- "DELETE_FUNCTION"
- ]
- },
- "updateTime": {
- "description": "The last update timestamp of the operation.",
- "format": "google-datetime",
- "type": "string"
- },
- "target": {
- "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1"
}
},
"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 Functions",
"auth": {
@@ -502,453 +950,5 @@
"name": "cloudfunctions",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Functions API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "resources": {
- "functions": {
- "methods": {
- "generateUploadUrl": {
- "id": "cloudfunctions.projects.locations.functions.generateUploadUrl",
- "path": "v1beta2/{+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": {
- "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",
- "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"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl",
- "path": "v1beta2/{+name}:generateDownloadUrl",
- "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl",
- "request": {
- "$ref": "GenerateDownloadUrlRequest"
- },
- "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls"
- },
- "get": {
- "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",
- "description": "Returns a function with the given name from the requested project."
- },
- "update": {
- "request": {
- "$ref": "CloudFunction"
- },
- "description": "Updates existing function.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path",
- "description": "The name of the function to be updated.",
- "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.update"
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the function which should be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "path": "v1beta2/{+name}",
- "id": "cloudfunctions.projects.locations.functions.delete",
- "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function."
- },
- "list": {
- "description": "Returns a list of functions that belong to the requested project.",
- "response": {
- "$ref": "ListFunctionsResponse"
- },
- "parameterOrder": [
- "location"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "location": {
- "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "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": {
- "description": "Maximum number of functions to return per call.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
- "path": "v1beta2/{+location}/functions",
- "id": "cloudfunctions.projects.locations.functions.list"
- },
- "call": {
- "request": {
- "$ref": "CallFunctionRequest"
- },
- "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
- "response": {
- "$ref": "CallFunctionResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the function to be called.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
- "path": "v1beta2/{+name}:call",
- "id": "cloudfunctions.projects.locations.functions.call"
- },
- "create": {
- "id": "cloudfunctions.projects.locations.functions.create",
- "path": "v1beta2/{+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": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions"
- }
- }
- }
- },
- "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": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations",
- "path": "v1beta2/{+name}/locations",
- "id": "cloudfunctions.projects.locations.list"
- }
- }
- }
- }
- },
- "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": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "name": {
- "location": "query",
- "description": "The name of the operation's parent resource.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1beta2/operations",
- "path": "v1beta2/operations",
- "id": "cloudfunctions.operations.list"
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/operations/{operationsId}",
- "id": "cloudfunctions.operations.get",
- "path": "v1beta2/{+name}"
- }
- }
- }
- },
- "parameters": {
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "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": {
- "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"
- }
- },
- "version": "v1beta2",
- "baseUrl": "https://cloudfunctions.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "API for managing lightweight user-provided functions executed in response to events.",
- "servicePath": "",
- "basePath": "",
- "revision": "20180120",
- "documentationLink": "https://cloud.google.com/functions",
- "id": "cloudfunctions:v1beta2",
- "discoveryVersion": "v1"
+ "title": "Google Cloud Functions API"
}
diff --git a/cloudiot/v1/cloudiot-api.json b/cloudiot/v1/cloudiot-api.json
index c9615b4..d59cf02 100644
--- a/cloudiot/v1/cloudiot-api.json
+++ b/cloudiot/v1/cloudiot-api.json
@@ -1,635 +1,4 @@
{
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "resources": {
- "registries": {
- "methods": {
- "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"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy"
- },
- "get": {
- "response": {
- "$ref": "DeviceRegistry"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path",
- "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.get",
- "description": "Gets a device registry configuration."
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "DeviceRegistry"
- },
- "parameters": {
- "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"
- },
- "name": {
- "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
- "id": "cloudiot.projects.locations.registries.patch",
- "path": "v1/{+name}",
- "request": {
- "$ref": "DeviceRegistry"
- },
- "description": "Updates a device registry configuration."
- },
- "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": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "cloudiot.projects.locations.registries.testIamPermissions"
- },
- "delete": {
- "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": {
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.delete"
- },
- "list": {
- "path": "v1/{+parent}/registries",
- "id": "cloudiot.projects.locations.registries.list",
- "description": "Lists device registries.",
- "response": {
- "$ref": "ListDeviceRegistriesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "description": "The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The value returned by the last `ListDeviceRegistriesResponse`; indicates\nthat this is a continuation of a prior `ListDeviceRegistries` call, and\nthat the system should return the next page of data.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of registries to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries"
- },
- "create": {
- "description": "Creates a device registry that contains devices.",
- "request": {
- "$ref": "DeviceRegistry"
- },
- "response": {
- "$ref": "DeviceRegistry"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The project and cloud region where this device registry must be created.\nFor example, `projects/example-project/locations/us-central1`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries",
- "path": "v1/{+parent}/registries",
- "id": "cloudiot.projects.locations.registries.create"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "cloudiot.projects.locations.registries.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
- }
- },
- "resources": {
- "devices": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListDevicesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "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"
- },
- "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": {
- "location": "path",
- "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/[^/]+$"
- },
- "deviceNumIds": {
- "description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries.",
- "format": "uint64",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "pageToken": {
- "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"
- }
- },
- "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."
- },
- "create": {
- "request": {
- "$ref": "Device"
- },
- "description": "Creates a device in a device registry.",
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "description": "The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
- "path": "v1/{+parent}/devices",
- "id": "cloudiot.projects.locations.registries.devices.create"
- },
- "modifyCloudToDeviceConfig": {
- "path": "v1/{+name}:modifyCloudToDeviceConfig",
- "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig",
- "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT Core servers. Returns the modified configuration version and\nits metadata.",
- "request": {
- "$ref": "ModifyCloudToDeviceConfigRequest"
- },
- "response": {
- "$ref": "DeviceConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "name": {
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig"
- },
- "get": {
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$"
- },
- "fieldMask": {
- "description": "The fields of the `Device` resource to be returned in the response. If the\nfield mask is unset or empty, all fields are returned.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.devices.get",
- "description": "Gets details about a device."
- },
- "patch": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.devices.patch",
- "request": {
- "$ref": "Device"
- },
- "description": "Updates a device.",
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ]
- },
- "delete": {
- "description": "Deletes a device.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "name": {
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.devices.delete"
- }
- },
- "resources": {
- "configVersions": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListDeviceConfigVersionsResponse"
- },
- "parameters": {
- "name": {
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path"
- },
- "numVersions": {
- "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions",
- "id": "cloudiot.projects.locations.registries.devices.configVersions.list",
- "path": "v1/{+name}/configVersions",
- "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first)."
- }
- }
- },
- "states": {
- "methods": {
- "list": {
- "description": "Lists the last few versions of the device state in descending order (i.e.:\nnewest first).",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListDeviceStatesResponse"
- },
- "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"
- },
- "numStates": {
- "description": "The number of states to list. States are listed in descending order of\nupdate time. The maximum number of states retained is 10. If this\nvalue is zero, it will return all the states available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/states",
- "id": "cloudiot.projects.locations.registries.devices.states.list",
- "path": "v1/{+name}/states"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "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": {
- "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": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- }
- },
- "version": "v1",
- "baseUrl": "https://cloudiot.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
"servicePath": "",
@@ -641,29 +10,44 @@
"version_module": true,
"schemas": {
"Device": {
+ "type": "object",
"properties": {
+ "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": {
+ "type": "string",
+ "description": "[Output only] The last time a heartbeat was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes. This field is only for devices connecting through MQTT.",
+ "format": "google-datetime"
+ },
+ "lastEventTime": {
+ "type": "string",
+ "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"
+ },
"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"
+ "$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": {
+ "type": "string",
"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"
+ "format": "google-datetime"
+ },
+ "config": {
+ "$ref": "DeviceConfig",
+ "description": "The most recent device configuration, which is eventually sent from\nCloud IoT Core to the device. If not present on creation, the\nconfiguration will be initialized with an empty payload and version value\nof `1`. To update this field after creation, use the\n`DeviceManager.ModifyCloudToDeviceConfig` method."
},
"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",
@@ -692,33 +76,18 @@
"type": "string"
},
"lastConfigAckTime": {
+ "type": "string",
"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"
+ "format": "google-datetime"
},
"numId": {
+ "type": "string",
"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"
+ "format": "uint64"
}
},
"id": "Device",
- "description": "The device resource.",
- "type": "object"
+ "description": "The device resource."
},
"ListDeviceConfigVersionsResponse": {
"description": "Response for `ListDeviceConfigVersions`.",
@@ -738,14 +107,6 @@
"description": "Details of an X.509 certificate. For informational purposes only.",
"type": "object",
"properties": {
- "issuer": {
- "description": "The entity that signed the certificate.",
- "type": "string"
- },
- "publicKeyType": {
- "description": "The type of public key in the certificate.",
- "type": "string"
- },
"signatureAlgorithm": {
"description": "The algorithm used to sign the certificate.",
"type": "string"
@@ -763,28 +124,19 @@
"subject": {
"description": "The entity the certificate and public key belong to.",
"type": "string"
+ },
+ "issuer": {
+ "type": "string",
+ "description": "The entity that signed the certificate."
+ },
+ "publicKeyType": {
+ "description": "The type of public key in the certificate.",
+ "type": "string"
}
},
"id": "X509CertificateDetails"
},
- "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"
- },
"EventNotificationConfig": {
- "description": "The configuration to forward telemetry events.",
"type": "object",
"properties": {
"pubsubTopicName": {
@@ -792,7 +144,24 @@
"type": "string"
}
},
- "id": "EventNotificationConfig"
+ "id": "EventNotificationConfig",
+ "description": "The configuration to forward telemetry events."
+ },
+ "SetIamPolicyRequest": {
+ "type": "object",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
+ "updateMask": {
+ "type": "string",
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask"
+ }
+ },
+ "id": "SetIamPolicyRequest",
+ "description": "Request message for `SetIamPolicy` method."
},
"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 `{}`.",
@@ -805,18 +174,10 @@
"type": "object",
"properties": {
"key": {
- "description": "The key data.",
- "type": "string"
+ "type": "string",
+ "description": "The key data."
},
"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.",
@@ -824,18 +185,29 @@
"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"
+ ],
+ "description": "The format of the key."
}
},
"id": "PublicKeyCredential"
},
"PublicKeyCertificate": {
- "description": "A public key certificate format and data.",
"type": "object",
"properties": {
+ "certificate": {
+ "type": "string",
+ "description": "The certificate data."
+ },
"x509Details": {
- "description": "[Output only] The certificate details. Used only for X.509 certificates.",
- "$ref": "X509CertificateDetails"
+ "$ref": "X509CertificateDetails",
+ "description": "[Output only] The certificate details. Used only for X.509 certificates."
},
"format": {
"enum": [
@@ -848,32 +220,42 @@
"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-----`."
]
- },
- "certificate": {
- "description": "The certificate data.",
- "type": "string"
}
},
- "id": "PublicKeyCertificate"
+ "id": "PublicKeyCertificate",
+ "description": "A public key certificate format and data."
},
"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"
+ },
+ "binaryData": {
+ "type": "string",
+ "description": "The device state data.",
+ "format": "byte"
}
},
"id": "DeviceState"
},
+ "StateNotificationConfig": {
+ "type": "object",
+ "properties": {
+ "pubsubTopicName": {
+ "type": "string",
+ "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`."
+ }
+ },
+ "id": "StateNotificationConfig",
+ "description": "The configuration for notification of new states received from the device."
+ },
"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).",
@@ -883,20 +265,7 @@
}
}
},
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
- },
- "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"
+ "id": "TestIamPermissionsRequest"
},
"RegistryCredential": {
"description": "A server-stored registry credential used to validate device credentials.",
@@ -942,41 +311,18 @@
"type": "string"
},
"deviceRegistries": {
- "description": "The registries that matched the query.",
"type": "array",
"items": {
"$ref": "DeviceRegistry"
- }
+ },
+ "description": "The registries that matched the query."
}
},
"id": "ListDeviceRegistriesResponse"
},
"DeviceRegistry": {
- "description": "A container for a group of devices.",
"type": "object",
"properties": {
- "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",
- "items": {
- "$ref": "RegistryCredential"
- }
- },
- "name": {
- "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "type": "string"
- },
- "eventNotificationConfigs": {
- "description": "The configuration for notification of telemetry events received from the\ndevice. All telemetry events that were successfully published by the\ndevice and acknowledged by Cloud IoT Core are guaranteed to be\ndelivered to Cloud Pub/Sub. Only the first configuration is used. If you\ntry to publish a device telemetry event using MQTT without specifying a\nCloud Pub/Sub topic for the device's registry, the connection closes\nautomatically. If you try to do so using an HTTP connection, an error\nis returned.",
- "type": "array",
- "items": {
- "$ref": "EventNotificationConfig"
- }
- },
"httpConfig": {
"$ref": "HttpConfig",
"description": "The DeviceService (HTTP) configuration for this device registry."
@@ -988,11 +334,35 @@
"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."
+ },
+ "credentials": {
+ "type": "array",
+ "items": {
+ "$ref": "RegistryCredential"
+ },
+ "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."
+ },
+ "name": {
+ "type": "string",
+ "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`."
+ },
+ "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"
+ }
}
},
- "id": "DeviceRegistry"
+ "id": "DeviceRegistry",
+ "description": "A container for a group of devices."
},
"ListDevicesResponse": {
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "If not empty, indicates that there may be more devices that match the\nrequest; this value should be passed in a new `ListDevicesRequest`.",
@@ -1007,29 +377,28 @@
}
},
"id": "ListDevicesResponse",
- "description": "Response for `ListDevices`.",
- "type": "object"
+ "description": "Response for `ListDevices`."
},
"HttpConfig": {
+ "type": "object",
"properties": {
"httpEnabledState": {
- "enumDescriptions": [
- "No HTTP state specified. If not specified, DeviceService will be\nenabled by default.",
- "Enables DeviceService (HTTP) service for the registry.",
- "Disables DeviceService (HTTP) service for the registry."
- ],
"enum": [
"HTTP_STATE_UNSPECIFIED",
"HTTP_ENABLED",
"HTTP_DISABLED"
],
"description": "If enabled, allows devices to use DeviceService via the HTTP protocol.\nOtherwise, any requests to DeviceService will fail for this registry.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "No HTTP state specified. If not specified, DeviceService will be\nenabled by default.",
+ "Enables DeviceService (HTTP) service for the registry.",
+ "Disables DeviceService (HTTP) service for the registry."
+ ]
}
},
"id": "HttpConfig",
- "description": "The configuration of the HTTP bridge for a device registry.",
- "type": "object"
+ "description": "The configuration of the HTTP bridge for a device registry."
},
"DeviceCredential": {
"description": "A server-stored device credential used for authentication.",
@@ -1041,18 +410,19 @@
"type": "string"
},
"publicKey": {
- "description": "A public key used to verify the signature of JSON Web Tokens (JWTs).\nWhen adding a new device credential, either via device creation or via\nmodifications, this public key credential may be required to be signed by\none of the registry level certificates. More specifically, if the\nregistry contains at least one certificate, any new device credential\nmust be signed by one of the registry certificates. As a result,\nwhen the registry contains certificates, only X.509 certificates are\naccepted as device credentials. However, if the registry does\nnot contain a certificate, self-signed certificates and public keys will\nbe accepted. New device credentials must be different from every\nregistry-level certificate.",
- "$ref": "PublicKeyCredential"
+ "$ref": "PublicKeyCredential",
+ "description": "A public key used to verify the signature of JSON Web Tokens (JWTs).\nWhen adding a new device credential, either via device creation or via\nmodifications, this public key credential may be required to be signed by\none of the registry level certificates. More specifically, if the\nregistry contains at least one certificate, any new device credential\nmust be signed by one of the registry certificates. As a result,\nwhen the registry contains certificates, only X.509 certificates are\naccepted as device credentials. However, if the registry does\nnot contain a certificate, self-signed certificates and public keys will\nbe accepted. New device credentials must be different from every\nregistry-level certificate."
}
},
"id": "DeviceCredential"
},
"DeviceConfig": {
+ "type": "object",
"properties": {
"version": {
+ "type": "string",
"description": "[Output only] The version of this update. The version number is assigned by\nthe server, and is always greater than 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.",
- "format": "int64",
- "type": "string"
+ "format": "int64"
},
"cloudUpdateTime": {
"description": "[Output only] The time at which this configuration version was updated in\nCloud IoT Core. This timestamp is set by the server.",
@@ -1065,35 +435,34 @@
"type": "string"
},
"binaryData": {
+ "type": "string",
"description": "The device configuration data.",
- "format": "byte",
- "type": "string"
+ "format": "byte"
}
},
"id": "DeviceConfig",
- "description": "The device configuration. Eventually delivered to devices.",
- "type": "object"
+ "description": "The device configuration. Eventually delivered to devices."
},
"MqttConfig": {
- "description": "The configuration of MQTT for a device registry.",
"type": "object",
"properties": {
"mqttEnabledState": {
+ "enum": [
+ "MQTT_STATE_UNSPECIFIED",
+ "MQTT_ENABLED",
+ "MQTT_DISABLED"
+ ],
"description": "If enabled, allows connections using the MQTT protocol. Otherwise, MQTT\nconnections to this registry will fail.",
"type": "string",
"enumDescriptions": [
"No MQTT state specified. If not specified, MQTT will be enabled by default.",
"Enables a MQTT connection.",
"Disables a MQTT connection."
- ],
- "enum": [
- "MQTT_STATE_UNSPECIFIED",
- "MQTT_ENABLED",
- "MQTT_DISABLED"
]
}
},
- "id": "MqttConfig"
+ "id": "MqttConfig",
+ "description": "The configuration of MQTT for a device registry."
},
"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.",
@@ -1103,17 +472,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"
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
}
},
"code": {
+ "type": "integer",
"description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "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.",
@@ -1123,7 +492,6 @@
"id": "Status"
},
"Binding": {
- "description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
"condition": {
@@ -1142,44 +510,45 @@
"type": "string"
}
},
- "id": "Binding"
+ "id": "Binding",
+ "description": "Associates `members` with a `role`."
},
"Expr": {
- "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
"type": "object",
"properties": {
- "description": {
- "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
- "type": "string"
- },
- "expression": {
- "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
- "type": "string"
- },
"title": {
- "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
- "type": "string"
+ "type": "string",
+ "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression."
},
"location": {
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
"type": "string"
+ },
+ "description": {
+ "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"
}
},
- "id": "Expr"
+ "id": "Expr",
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\""
},
"ModifyCloudToDeviceConfigRequest": {
"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"
+ },
+ "versionToUpdate": {
+ "type": "string",
+ "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"
}
},
"id": "ModifyCloudToDeviceConfigRequest"
@@ -1189,15 +558,21 @@
"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"
- }
+ },
+ "description": "The last few device states. States are listed in descending order of server\nupdate time, starting from the most recent one."
}
},
"id": "ListDeviceStatesResponse"
},
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
@@ -1211,28 +586,22 @@
}
},
"id": "TestIamPermissionsResponse"
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"canonicalName": "Cloud Iot",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/cloudiot": {
"description": "Register and manage devices in the Google Cloud IoT service"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -1243,5 +612,636 @@
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Cloud IoT API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "resources": {
+ "registries": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "path": "v1/{+name}",
+ "id": "cloudiot.projects.locations.registries.delete",
+ "description": "Deletes a device registry configuration."
+ },
+ "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"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "parent": {
+ "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`."
+ },
+ "pageToken": {
+ "type": "string",
+ "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."
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of registries to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "create": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries",
+ "path": "v1/{+parent}/registries",
+ "id": "cloudiot.projects.locations.registries.create",
+ "description": "Creates a device registry that contains devices.",
+ "request": {
+ "$ref": "DeviceRegistry"
+ },
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "The project and cloud region where this device registry must be created.\nFor example, `projects/example-project/locations/us-central1`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ }
+ }
+ },
+ "setIamPolicy": {
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "resource": {
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "cloudiot.projects.locations.registries.getIamPolicy"
+ },
+ "get": {
+ "description": "Gets a device registry configuration.",
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "path": "v1/{+name}",
+ "id": "cloudiot.projects.locations.registries.get"
+ },
+ "patch": {
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "updateMask": {
+ "type": "string",
+ "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"
+ },
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "location": "path",
+ "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`."
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "path": "v1/{+name}",
+ "id": "cloudiot.projects.locations.registries.patch",
+ "description": "Updates a device registry configuration.",
+ "request": {
+ "$ref": "DeviceRegistry"
+ }
+ },
+ "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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "cloudiot.projects.locations.registries.testIamPermissions"
+ }
+ },
+ "resources": {
+ "devices": {
+ "methods": {
+ "get": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "path": "v1/{+name}",
+ "id": "cloudiot.projects.locations.registries.devices.get",
+ "description": "Gets details about a device.",
+ "response": {
+ "$ref": "Device"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path",
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`."
+ },
+ "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"
+ }
+ }
+ },
+ "patch": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "path": "v1/{+name}",
+ "id": "cloudiot.projects.locations.registries.devices.patch",
+ "description": "Updates a device.",
+ "request": {
+ "$ref": "Device"
+ },
+ "response": {
+ "$ref": "Device"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `enabled_state`, and `metadata`",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path",
+ "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID."
+ }
+ }
+ },
+ "delete": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "path": "v1/{+name}",
+ "id": "cloudiot.projects.locations.registries.devices.delete",
+ "description": "Deletes a device.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path",
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "list": {
+ "description": "List devices in a device registry.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListDevicesResponse"
+ },
+ "parameters": {
+ "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
+ },
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "The fields of the `Device` resource to be returned in the response. The\nfields `id`, and `num_id` are always returned by default, along with any\nother fields specified.",
+ "format": "google-fieldmask"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of devices to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "deviceIds": {
+ "type": "string",
+ "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."
+ },
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "location": "path",
+ "description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
+ "id": "cloudiot.projects.locations.registries.devices.list",
+ "path": "v1/{+parent}/devices"
+ },
+ "create": {
+ "response": {
+ "$ref": "Device"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "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/[^/]+$"
+ }
+ },
+ "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"
+ }
+ },
+ "modifyCloudToDeviceConfig": {
+ "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT Core servers. Returns the modified configuration version and\nits metadata.",
+ "request": {
+ "$ref": "ModifyCloudToDeviceConfigRequest"
+ },
+ "response": {
+ "$ref": "DeviceConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "name": {
+ "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": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig",
+ "path": "v1/{+name}:modifyCloudToDeviceConfig",
+ "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig"
+ }
+ },
+ "resources": {
+ "configVersions": {
+ "methods": {
+ "list": {
+ "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first).",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListDeviceConfigVersionsResponse"
+ },
+ "parameters": {
+ "numVersions": {
+ "location": "query",
+ "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "location": "path",
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions",
+ "id": "cloudiot.projects.locations.registries.devices.configVersions.list",
+ "path": "v1/{+name}/configVersions"
+ }
+ }
+ },
+ "states": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListDeviceStatesResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the device. 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": {
+ "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"
+ }
+ },
+ "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)."
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "key": {
+ "type": "string",
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ },
+ "quotaUser": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "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"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://cloudiot.googleapis.com/"
}
diff --git a/cloudkms/v1/cloudkms-api.json b/cloudkms/v1/cloudkms-api.json
index e631563..9efe136 100644
--- a/cloudkms/v1/cloudkms-api.json
+++ b/cloudkms/v1/cloudkms-api.json
@@ -1,213 +1,13 @@
{
+ "basePath": "",
+ "revision": "20180117",
+ "documentationLink": "https://cloud.google.com/kms/",
+ "id": "cloudkms:v1",
+ "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "DestroyCryptoKeyVersionRequest": {
- "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
- "type": "object",
- "properties": {},
- "id": "DestroyCryptoKeyVersionRequest"
- },
- "AuditLogConfig": {
- "properties": {
- "logType": {
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string"
- },
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "AuditLogConfig",
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object"
- },
- "CryptoKey": {
- "description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.",
- "type": "object",
- "properties": {
- "purpose": {
- "enum": [
- "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
- "ENCRYPT_DECRYPT"
- ],
- "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
- ]
- },
- "nextRotationTime": {
- "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
- "format": "google-datetime",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels with user-defined metadata. For more information, see\n[Labeling Keys](/kms/docs/labeling-keys).",
- "type": "object"
- },
- "createTime": {
- "description": "Output only. The time at which this CryptoKey was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "rotationPeriod": {
- "description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.",
- "format": "google-duration",
- "type": "string"
- },
- "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": "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": "Deprecated.",
- "format": "int32",
- "type": "integer"
- },
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "type": "array",
- "items": {
- "$ref": "AuditConfig"
- }
- },
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- }
- },
- "id": "Policy",
- "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"
- },
- "ListLocationsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- }
- },
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
- },
- "KeyRing": {
- "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
- "type": "object",
- "properties": {
- "createTime": {
- "description": "Output only. The time at which this KeyRing was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
- "type": "string"
- }
- },
- "id": "KeyRing"
- },
- "EncryptResponse": {
- "description": "Response message for KeyManagementService.Encrypt.",
- "type": "object",
- "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"
- },
"UpdateCryptoKeyPrimaryVersionRequest": {
+ "id": "UpdateCryptoKeyPrimaryVersionRequest",
"description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
"type": "object",
"properties": {
@@ -215,14 +15,13 @@
"description": "The id of the child CryptoKeyVersion to use as primary.",
"type": "string"
}
- },
- "id": "UpdateCryptoKeyPrimaryVersionRequest"
+ }
},
"RestoreCryptoKeyVersionRequest": {
+ "id": "RestoreCryptoKeyVersionRequest",
"description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
"type": "object",
- "properties": {},
- "id": "RestoreCryptoKeyVersionRequest"
+ "properties": {}
},
"ListKeyRingsResponse": {
"description": "Response message for KeyManagementService.ListKeyRings.",
@@ -251,16 +50,16 @@
"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"
@@ -269,6 +68,15 @@
"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": {
+ "name": {
+ "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
+ "type": "string"
+ },
+ "destroyEventTime": {
+ "description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"destroyTime": {
"description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
"format": "google-datetime",
@@ -296,20 +104,12 @@
"DESTROYED",
"DESTROY_SCHEDULED"
]
- },
- "name": {
- "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
- "type": "string"
- },
- "destroyEventTime": {
- "description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
- "format": "google-datetime",
- "type": "string"
}
},
"id": "CryptoKeyVersion"
},
"SetIamPolicyRequest": {
+ "id": "SetIamPolicyRequest",
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
@@ -319,11 +119,10 @@
"type": "string"
},
"policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
}
- },
- "id": "SetIamPolicyRequest"
+ }
},
"DecryptRequest": {
"description": "Request message for KeyManagementService.Decrypt.",
@@ -343,6 +142,7 @@
"id": "DecryptRequest"
},
"Binding": {
+ "id": "Binding",
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
@@ -357,10 +157,11 @@
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
}
- },
- "id": "Binding"
+ }
},
"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.",
@@ -373,9 +174,7 @@
"type": "string"
}
},
- "id": "EncryptRequest",
- "description": "Request message for KeyManagementService.Encrypt.",
- "type": "object"
+ "id": "EncryptRequest"
},
"ListCryptoKeyVersionsResponse": {
"description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
@@ -401,13 +200,15 @@
"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\"}",
+ "type": "object",
"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\"`",
@@ -426,9 +227,7 @@
"type": "object"
}
},
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object"
+ "id": "Location"
},
"ListCryptoKeysResponse": {
"description": "Response message for KeyManagementService.ListCryptoKeys.",
@@ -452,6 +251,212 @@
}
},
"id": "ListCryptoKeysResponse"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsResponse"
+ },
+ "DestroyCryptoKeyVersionRequest": {
+ "id": "DestroyCryptoKeyVersionRequest",
+ "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
+ "type": "object",
+ "properties": {}
+ },
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "logType": {
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string"
+ }
+ },
+ "id": "AuditLogConfig"
+ },
+ "CryptoKey": {
+ "id": "CryptoKey",
+ "description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.",
+ "type": "object",
+ "properties": {
+ "nextRotationTime": {
+ "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Labels with user-defined metadata. For more information, see\n[Labeling Keys](/kms/docs/labeling-keys).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "createTime": {
+ "description": "Output only. The time at which this CryptoKey was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "rotationPeriod": {
+ "description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "primary": {
+ "$ref": "CryptoKeyVersion",
+ "description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion."
+ },
+ "name": {
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "type": "string"
+ },
+ "purpose": {
+ "enumDescriptions": [
+ "Not specified.",
+ "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
+ ],
+ "enum": [
+ "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
+ "ENCRYPT_DECRYPT"
+ ],
+ "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
+ "type": "string"
+ }
+ }
+ },
+ "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": {
+ "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"
+ }
+ }
+ }
+ },
+ "EncryptResponse": {
+ "description": "Response message for KeyManagementService.Encrypt.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion used in encryption.",
+ "type": "string"
+ },
+ "ciphertext": {
+ "description": "The encrypted data.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "EncryptResponse"
+ },
+ "KeyRing": {
+ "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
+ "type": "object",
+ "properties": {
+ "createTime": {
+ "description": "Output only. The time at which this KeyRing was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
+ "type": "string"
+ }
+ },
+ "id": "KeyRing"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Location"
+ }
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "Deprecated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "type": "array",
+ "items": {
+ "$ref": "AuditConfig"
+ }
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
+ }
+ }
+ },
+ "id": "Policy"
}
},
"icons": {
@@ -481,26 +486,13 @@
"locations": {
"methods": {
"list": {
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
"parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
"name": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
"description": "The resource that owns the locations collection, if applicable.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
+ "type": "string"
},
"pageToken": {
"location": "query",
@@ -512,45 +504,114 @@
"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": "v1/projects/{projectsId}/locations",
+ "id": "cloudkms.projects.locations.list",
"path": "v1/{+name}/locations",
- "id": "cloudkms.projects.locations.list"
- },
- "get": {
+ "description": "Lists information about the supported locations for this service.",
"httpMethod": "GET",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
"parameterOrder": [
"name"
- ],
- "response": {
- "$ref": "Location"
- },
+ ]
+ },
+ "get": {
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
"description": "Resource name for the location.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
- "id": "cloudkms.projects.locations.get",
"path": "v1/{+name}",
- "description": "Get information about a location."
+ "id": "cloudkms.projects.locations.get",
+ "description": "Get information about a location.",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET"
}
},
"resources": {
"keyRings": {
"methods": {
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ },
+ "get": {
+ "response": {
+ "$ref": "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."
+ },
"testIamPermissions": {
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "cloudkms.projects.locations.keyRings.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"
},
@@ -563,38 +624,31 @@
],
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "cloudkms.projects.locations.keyRings.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": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions"
},
"list": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
- "id": "cloudkms.projects.locations.keyRings.list",
- "path": "v1/{+parent}/keyRings",
- "description": "Lists KeyRings.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
"response": {
"$ref": "ListKeyRingsResponse"
},
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"pageToken": {
+ "location": "query",
"description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
@@ -603,67 +657,6 @@
"location": "query"
},
"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"
- }
- },
- "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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy"
- },
- "create": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
- "path": "v1/{+parent}/keyRings",
- "id": "cloudkms.projects.locations.keyRings.create",
- "request": {
- "$ref": "KeyRing"
- },
- "description": "Create a new KeyRing in a given Project and Location.",
- "response": {
- "$ref": "KeyRing"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "keyRingId": {
- "description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
- "type": "string",
- "location": "query"
- },
- "parent": {
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
"description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
@@ -671,250 +664,81 @@
"type": "string"
}
},
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
+ "path": "v1/{+parent}/keyRings",
+ "id": "cloudkms.projects.locations.keyRings.list",
+ "description": "Lists KeyRings."
+ },
+ "create": {
+ "response": {
+ "$ref": "KeyRing"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ },
+ "keyRingId": {
+ "location": "query",
+ "description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
+ "path": "v1/{+parent}/keyRings",
+ "id": "cloudkms.projects.locations.keyRings.create",
+ "request": {
+ "$ref": "KeyRing"
+ },
+ "description": "Create a new KeyRing in a given Project and Location."
},
- "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.",
+ "setIamPolicy": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy"
- },
- "get": {
- "description": "Returns metadata for a given KeyRing.",
- "response": {
- "$ref": "KeyRing"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the KeyRing to get.",
- "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}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.get"
+ "httpMethod": "POST"
}
},
"resources": {
"cryptoKeys": {
- "resources": {
- "cryptoKeyVersions": {
- "methods": {
- "restore": {
- "request": {
- "$ref": "RestoreCryptoKeyVersionRequest"
- },
- "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared.",
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "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"
- },
- "get": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get",
- "path": "v1/{+name}",
- "description": "Returns metadata for a given CryptoKeyVersion.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path",
- "description": "The name of the CryptoKeyVersion to get.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameters": {
- "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"
- },
- "updateMask": {
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
- "path": "v1/{+name}",
- "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."
- },
- "list": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
- "path": "v1/{+parent}/cryptoKeyVersions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
- "description": "Lists CryptoKeyVersions.",
- "response": {
- "$ref": "ListCryptoKeyVersionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "location": "path",
- "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "destroy": {
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
- "path": "v1/{+name}: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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path",
- "description": "The resource name of the CryptoKeyVersion to destroy.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy"
- },
- "create": {
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
- "path": "v1/{+parent}/cryptoKeyVersions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
- "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
- "request": {
- "$ref": "CryptoKeyVersion"
- }
- }
- }
- }
- },
"methods": {
"testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -936,20 +760,13 @@
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
+ "path": "v1/{+resource}:testIamPermissions"
},
"decrypt": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
- "path": "v1/{+name}:decrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
- "description": "Decrypts data that was protected by Encrypt.",
"request": {
"$ref": "DecryptRequest"
},
+ "description": "Decrypts data that was protected by Encrypt.",
"response": {
"$ref": "DecryptResponse"
},
@@ -957,20 +774,49 @@
"name"
],
"httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
+ "path": "v1/{+name}:decrypt",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt"
+ },
+ "list": {
"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.",
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
+ "type": "string"
+ },
+ "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"
}
- }
- },
- "list": {
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ "path": "v1/{+parent}/cryptoKeys",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
"description": "Lists CryptoKeys.",
"response": {
"$ref": "ListCryptoKeysResponse"
@@ -978,33 +824,7 @@
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageSize": {
- "description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
- },
- "pageToken": {
- "description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
- "path": "v1/{+parent}/cryptoKeys",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list"
+ "httpMethod": "GET"
},
"encrypt": {
"response": {
@@ -1014,9 +834,6 @@
"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.",
@@ -1026,15 +843,52 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
"path": "v1/{+name}:encrypt",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt",
- "description": "Encrypts data, so that it can only be recovered by a call to Decrypt.",
"request": {
"$ref": "EncryptRequest"
- }
+ },
+ "description": "Encrypts data, so that it can only be recovered by a call to Decrypt."
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}: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."
},
"create": {
+ "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.",
"httpMethod": "POST",
"parameterOrder": [
"parent"
@@ -1044,11 +898,11 @@
},
"parameters": {
"parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path",
"description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path"
},
"cryptoKeyId": {
"location": "query",
@@ -1059,53 +913,16 @@
"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": {
- "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",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys"
},
"updatePrimaryVersion": {
- "response": {
- "$ref": "CryptoKey"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "CryptoKey"
+ },
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
@@ -1115,15 +932,19 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
- "path": "v1/{+name}:updatePrimaryVersion",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
- "description": "Update the version of a CryptoKey that will be used in Encrypt",
+ "path": "v1/{+name}:updatePrimaryVersion",
"request": {
"$ref": "UpdateCryptoKeyPrimaryVersionRequest"
- }
+ },
+ "description": "Update the version of a CryptoKey that will be used in Encrypt"
},
"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"
},
@@ -1131,9 +952,6 @@
"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.",
@@ -1143,55 +961,28 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy"
},
- "get": {
- "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.",
- "response": {
- "$ref": "CryptoKey"
- },
+ "patch": {
+ "httpMethod": "PATCH",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "CryptoKey"
+ },
"parameters": {
"name": {
- "description": "The name of the CryptoKey to get.",
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get"
- },
- "patch": {
- "request": {
- "$ref": "CryptoKey"
- },
- "description": "Update a CryptoKey.",
- "response": {
- "$ref": "CryptoKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "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/[^/]+$"
},
"updateMask": {
"location": "query",
@@ -1204,8 +995,222 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
"path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch"
+ "request": {
+ "$ref": "CryptoKey"
+ },
+ "description": "Update a CryptoKey."
+ },
+ "get": {
+ "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.",
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "The name of the CryptoKey to get.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ }
+ },
+ "resources": {
+ "cryptoKeyVersions": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
+ "path": "v1/{+parent}/cryptoKeyVersions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
+ "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
+ "request": {
+ "$ref": "CryptoKeyVersion"
+ }
+ },
+ "destroy": {
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "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",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
+ "path": "v1/{+name}:destroy"
+ },
+ "restore": {
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore",
+ "path": "v1/{+name}:restore",
+ "request": {
+ "$ref": "RestoreCryptoKeyVersionRequest"
+ },
+ "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the CryptoKeyVersion to restore.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore"
+ },
+ "patch": {
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The resource name for this 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}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
+ "path": "v1/{+name}",
+ "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.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ }
+ },
+ "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": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
+ "path": "v1/{+parent}/cryptoKeyVersions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
+ "description": "Lists CryptoKeyVersions.",
+ "response": {
+ "$ref": "ListCryptoKeyVersionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET"
+ }
+ }
}
}
}
@@ -1217,28 +1222,66 @@
}
},
"parameters": {
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
- "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"
},
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1247,16 +1290,11 @@
"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",
@@ -1268,50 +1306,12 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
"location": "query"
- },
- "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://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": "20180117",
- "documentationLink": "https://cloud.google.com/kms/",
- "id": "cloudkms:v1",
- "discoveryVersion": "v1"
+ "description": "Manages encryption for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256 encryption keys.",
+ "servicePath": ""
}
diff --git a/cloudresourcemanager/v1/cloudresourcemanager-api.json b/cloudresourcemanager/v1/cloudresourcemanager-api.json
index 6315eb3..718d9e6 100644
--- a/cloudresourcemanager/v1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1/cloudresourcemanager-api.json
@@ -1,599 +1,21 @@
{
+ "kind": "discovery#restDescription",
+ "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20180124",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "id": "cloudresourcemanager:v1",
+ "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"
- },
- "ListConstraint": {
- "description": "A `Constraint` that allows or disallows a list of string values, which are\nconfigured by an Organization's policy administrator with a `Policy`.",
- "type": "object",
- "properties": {
- "suggestedValue": {
- "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Constraint`.",
- "type": "string"
- }
- },
- "id": "ListConstraint"
- },
- "SetOrgPolicyRequest": {
- "description": "The request sent to the SetOrgPolicyRequest method.",
- "type": "object",
- "properties": {
- "policy": {
- "description": "`Policy` to set on the resource.",
- "$ref": "OrgPolicy"
- }
- },
- "id": "SetOrgPolicyRequest"
- },
- "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"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "Organization": {
- "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
- "type": "object",
- "properties": {
- "creationTime": {
- "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"
- },
- "lifecycleState": {
- "enumDescriptions": [
- "Unspecified state. This is only useful for distinguishing unset values.",
- "The normal and active state.",
- "The organization has been marked for deletion by the user."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED"
- ],
- "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly",
- "type": "string"
- },
- "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": {
- "properties": {
- "nextPageToken": {
- "description": "Page token used to retrieve the next page. This is currently not used.",
- "type": "string"
- },
- "constraints": {
- "description": "The collection of constraints that are settable on the request resource.",
- "type": "array",
- "items": {
- "$ref": "Constraint"
- }
- }
- },
- "id": "ListAvailableOrgPolicyConstraintsResponse",
- "description": "The response returned from the ListAvailableOrgPolicyConstraints method.\nReturns all `Constraints` that could be set at this level of the hierarchy\n(contrast with the response from `ListPolicies`, which returns all policies\nwhich are set).",
- "type": "object"
- },
- "ListPolicy": {
- "properties": {
- "allowedValues": {
- "description": "List of values allowed at this resource. Can only be set if no values\nare set for `denied_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "suggestedValue": {
- "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Policy`. If `suggested_value`\nis not set, it will inherit the value specified higher in the hierarchy,\nunless `inherit_from_parent` is `false`.",
- "type": "string"
- },
- "inheritFromParent": {
- "description": "Determines the inheritance behavior for this `Policy`.\n\nBy default, a `ListPolicy` set at a resource supercedes any `Policy` set\nanywhere up the resource hierarchy. However, if `inherit_from_parent` is\nset to `true`, then the values from the effective `Policy` of the parent\nresource are inherited, meaning the values set in this `Policy` are\nadded to the values inherited up the hierarchy.\n\nSetting `Policy` hierarchies that inherit both allowed values and denied\nvalues isn't recommended in most circumstances to keep the configuration\nsimple and understandable. However, it is possible to set a `Policy` with\n`allowed_values` set that inherits a `Policy` with `denied_values` set.\nIn this case, the values that are allowed must be in `allowed_values` and\nnot present in `denied_values`.\n\nFor example, suppose you have a `Constraint`\n`constraints/serviceuser.services`, which has a `constraint_type` of\n`list_constraint`, and with `constraint_default` set to `ALLOW`.\nSuppose that at the Organization level, a `Policy` is applied that\nrestricts the allowed API activations to {`E1`, `E2`}. Then, if a\n`Policy` is applied to a project below the Organization that has\n`inherit_from_parent` set to `false` and field all_values set to DENY,\nthen an attempt to activate any API will be denied.\n\nThe following examples demonstrate different possible layerings:\n\nExample 1 (no inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n ``projects/bar`` has `inherit_from_parent` `false` and values:\n {allowed_values: \"E3\" allowed_values: \"E4\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E3`, and `E4`.\n\nExample 2 (inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {value: “E3” value: ”E4” inherit_from_parent: true}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.\n\nExample 3 (inheriting both allowed and denied values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {denied_values: \"E1\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe value accepted at `projects/bar` is `E2`.\n\nExample 4 (RestoreDefault):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {RestoreDefault: {}}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 5 (no policy inherits parent policy):\n `organizations/foo` has no `Policy` set.\n `projects/bar` has no `Policy` set.\nThe accepted values at both levels are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 6 (ListConstraint allowing all):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: ALLOW}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nAny value is accepted at `projects/bar`.\n\nExample 7 (ListConstraint allowing none):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: DENY}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nNo value is accepted at `projects/bar`.",
- "type": "boolean"
- },
- "deniedValues": {
- "description": "List of values denied at this resource. Can only be set if no values are\nset for `allowed_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "allValues": {
- "enum": [
- "ALL_VALUES_UNSPECIFIED",
- "ALLOW",
- "DENY"
- ],
- "description": "The policy all_values state.",
- "type": "string",
- "enumDescriptions": [
- "Indicates that either allowed_values or denied_values must be set.",
- "A policy with this set allows all values.",
- "A policy with this set denies all values."
- ]
- }
- },
- "id": "ListPolicy",
- "description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\nA `ListPolicy` can define specific values that are allowed or denied by\nsetting either the `allowed_values` or `denied_values` fields. It can also\nbe used to allow or deny all values, by setting the `all_values` field. If\n`all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`\nor `denied_values` must be set (attempting to set both or neither will\nresult in a failed request). If `all_values` is set to either `ALLOW` or\n`DENY`, `allowed_values` and `denied_values` must be unset.",
- "type": "object"
- },
- "GetAncestryResponse": {
- "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"
- }
- }
- },
- "id": "GetAncestryResponse",
- "description": "Response from the GetAncestry method.",
- "type": "object"
- },
- "AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "logType": {
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string",
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ]
- }
- },
- "id": "AuditLogConfig"
- },
- "SearchOrganizationsRequest": {
- "description": "The request sent to the `SearchOrganizations` method.",
- "type": "object",
- "properties": {
- "filter": {
- "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with\n`owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
- "type": "string"
- },
- "pageToken": {
- "description": "A pagination token returned from a previous call to `SearchOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "SearchOrganizationsRequest"
- },
- "GetAncestryRequest": {
- "description": "The request sent to the\nGetAncestry\nmethod.",
- "type": "object",
- "properties": {},
- "id": "GetAncestryRequest"
- },
- "TestIamPermissionsRequest": {
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
- },
- "ListAvailableOrgPolicyConstraintsRequest": {
- "properties": {
- "pageToken": {
- "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
- "type": "string"
- },
- "pageSize": {
- "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListAvailableOrgPolicyConstraintsRequest",
- "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.",
- "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/docs).",
- "type": "object",
- "properties": {
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Deprecated.",
- "format": "int32",
- "type": "integer"
- },
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "type": "array",
- "items": {
- "$ref": "AuditConfig"
- }
- },
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- }
- },
- "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": {
- "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",
- "description": "Metadata describing a long running folder operation",
- "type": "object"
- },
- "ResourceId": {
- "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
- "type": "string"
- },
- "type": {
- "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\"",
- "type": "string"
- }
- },
- "id": "ResourceId"
- },
- "GetEffectiveOrgPolicyRequest": {
- "properties": {
- "constraint": {
- "description": "The name of the `Constraint` to compute the effective `Policy`.",
- "type": "string"
- }
- },
- "id": "GetEffectiveOrgPolicyRequest",
- "description": "The request sent to the GetEffectiveOrgPolicy method.",
- "type": "object"
- },
- "ListOrgPoliciesRequest": {
- "description": "The request sent to the ListOrgPolicies method.",
- "type": "object",
- "properties": {
- "pageToken": {
- "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
- "type": "string"
- },
- "pageSize": {
- "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListOrgPoliciesRequest"
- },
- "AuditConfig": {
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- }
- },
- "id": "AuditConfig",
- "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\nAuditLogConfig 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": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- }
- },
- "id": "Operation"
- },
- "Constraint": {
- "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": {
- "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": {
- "description": "Defines this constraint as being a ListConstraint.",
- "$ref": "ListConstraint"
- }
- },
- "id": "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"
- },
- "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": {
- "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": {
- "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"
- },
- "RestoreDefault": {
- "properties": {},
- "id": "RestoreDefault",
- "description": "Ignores policies set above this resource and restores the\n`constraint_default` enforcement behavior of the specific `Constraint` at\nthis resource.\n\nSuppose that `constraint_default` is set to `ALLOW` for the\n`Constraint` `constraints/serviceuser.services`. Suppose that organization\nfoo.com sets a `Policy` at their Organization resource node that restricts\nthe allowed service activations to deny all service activations. They\ncould then set a `Policy` with the `policy_type` `restore_default` on\nseveral experimental projects, restoring the `constraint_default`\nenforcement of the `Constraint` for only those projects, allowing those\nprojects to have all services activated.",
- "type": "object"
- },
- "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"
- },
- "UndeleteProjectRequest": {
- "properties": {},
- "id": "UndeleteProjectRequest",
- "description": "The request sent to the UndeleteProject\nmethod.",
- "type": "object"
- },
- "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"
- },
- "ProjectCreationStatus": {
- "properties": {
- "ready": {
- "description": "True if the project creation process is complete.",
- "type": "boolean"
- },
- "createTime": {
- "description": "Creation time of the project creation workflow.",
- "format": "google-datetime",
- "type": "string"
- },
- "gettable": {
- "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
- "type": "boolean"
- }
- },
- "id": "ProjectCreationStatus",
- "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
- "type": "object"
- },
- "BooleanConstraint": {
- "description": "A `Constraint` that is either enforced or not.\n\nFor example a constraint `constraints/compute.disableSerialPortAccess`.\nIf it is enforced on a VM instance, serial port connections will not be\nopened to that instance.",
- "type": "object",
- "properties": {},
- "id": "BooleanConstraint"
- },
"GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
"type": "object",
"properties": {},
- "id": "GetIamPolicyRequest"
+ "id": "GetIamPolicyRequest",
+ "description": "Request message for `GetIamPolicy` method."
},
"TestIamPermissionsResponse": {
+ "type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
@@ -604,19 +26,18 @@
}
},
"id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
+ "description": "Response message for `TestIamPermissions` method."
},
"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",
- "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"
+ "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.",
@@ -637,7 +58,6 @@
"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": {
"name": {
@@ -686,7 +106,8 @@
"type": "string"
}
},
- "id": "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."
},
"SearchOrganizationsResponse": {
"description": "The response returned from the `SearchOrganizations` method.",
@@ -707,28 +128,40 @@
"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": {
- "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"
}
+ },
+ "nextPageToken": {
+ "description": "Page token used to retrieve the next page. This is currently not used, but\nthe server may at any point start supplying a valid token.",
+ "type": "string"
}
},
- "id": "ListOrgPoliciesResponse",
- "description": "The response returned from the ListOrgPolicies method. It will be empty\nif no `Policies` are set on the resource.",
- "type": "object"
+ "id": "ListOrgPoliciesResponse"
},
"FolderOperationError": {
"description": "A classification of the Folder Operation error.",
"type": "object",
"properties": {
"errorMessageId": {
+ "enumDescriptions": [
+ "The error type was unrecognized or unspecified.",
+ "The attempted action would violate the max folder depth constraint.",
+ "The attempted action would violate the max child folders constraint.",
+ "The attempted action would violate the locally-unique folder\ndisplay_name constraint.",
+ "The resource being moved has been deleted.",
+ "The resource a folder was being added to has been deleted.",
+ "The attempted action would introduce cycle in resource path.",
+ "The attempted action would move a folder that is already being moved.",
+ "The folder the caller is trying to delete contains active resources.",
+ "The attempted action would violate the max deleted folder depth\nconstraint."
+ ],
"enum": [
"ERROR_TYPE_UNSPECIFIED",
"ACTIVE_FOLDER_HEIGHT_VIOLATION",
@@ -742,24 +175,13 @@
"DELETED_FOLDER_HEIGHT_VIOLATION"
],
"description": "The type of operation error experienced.",
- "type": "string",
- "enumDescriptions": [
- "The error type was unrecognized or unspecified.",
- "The attempted action would violate the max folder depth constraint.",
- "The attempted action would violate the max child folders constraint.",
- "The attempted action would violate the locally-unique folder\ndisplay_name constraint.",
- "The resource being moved has been deleted.",
- "The resource a folder was being added to has been deleted.",
- "The attempted action would introduce cycle in resource path.",
- "The attempted action would move a folder that is already being moved.",
- "The folder the caller is trying to delete contains active resources.",
- "The attempted action would violate the max deleted folder depth\nconstraint."
- ]
+ "type": "string"
}
},
"id": "FolderOperationError"
},
"BooleanPolicy": {
+ "id": "BooleanPolicy",
"description": "Used in `policy_type` to specify how `boolean_policy` will behave at this\nresource.",
"type": "object",
"properties": {
@@ -767,24 +189,11 @@
"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": {
+ "type": "object",
"properties": {
- "version": {
- "description": "Version of the `Policy`. Default version is 0;",
- "format": "int32",
- "type": "integer"
- },
- "restoreDefault": {
- "$ref": "RestoreDefault",
- "description": "Restores the default behavior of the constraint; independent of\n`Constraint` type."
- },
- "listPolicy": {
- "$ref": "ListPolicy",
- "description": "List of values either allowed or disallowed."
- },
"etag": {
"description": "An opaque tag indicating the current version of the `Policy`, used for\nconcurrency control.\n\nWhen the `Policy` is returned from either a `GetPolicy` or a\n`ListOrgPolicy` request, this `etag` indicates the version of the current\n`Policy` to use when executing a read-modify-write loop.\n\nWhen the `Policy` is returned from a `GetEffectivePolicy` request, the\n`etag` will be unset.\n\nWhen the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value\nthat was returned from a `GetOrgPolicy` request as part of a\nread-modify-write loop for concurrency control. Not setting the `etag`in a\n`SetOrgPolicy` request will result in an unconditional write of the\n`Policy`.",
"format": "byte",
@@ -802,11 +211,23 @@
"description": "The time stamp the `Policy` was previously updated. This is set by the\nserver, not specified by the caller, and represents the last time a call to\n`SetOrgPolicy` was made for that `Policy`. Any value set by the client will\nbe ignored.",
"format": "google-datetime",
"type": "string"
+ },
+ "version": {
+ "description": "Version of the `Policy`. Default version is 0;",
+ "format": "int32",
+ "type": "integer"
+ },
+ "restoreDefault": {
+ "$ref": "RestoreDefault",
+ "description": "Restores the default behavior of the constraint; independent of\n`Constraint` type."
+ },
+ "listPolicy": {
+ "description": "List of values either allowed or disallowed.",
+ "$ref": "ListPolicy"
}
},
"id": "OrgPolicy",
- "description": "Defines a Cloud Organization `Policy` which is used to specify `Constraints`\nfor configurations of Cloud Platform resources.",
- "type": "object"
+ "description": "Defines a Cloud Organization `Policy` which is used to specify `Constraints`\nfor configurations of Cloud Platform resources."
},
"Lien": {
"description": "A Lien represents an encumbrance on the actions that can be performed on a\nresource.",
@@ -830,8 +251,8 @@
"type": "string"
},
"origin": {
- "description": "A stable, user-visible/meaningful string identifying the origin of the\nLien, intended to be inspected programmatically. Maximum length of 200\ncharacters.\n\nExample: 'compute.googleapis.com'",
- "type": "string"
+ "type": "string",
+ "description": "A stable, user-visible/meaningful string identifying the origin of the\nLien, intended to be inspected programmatically. Maximum length of 200\ncharacters.\n\nExample: 'compute.googleapis.com'"
},
"restrictions": {
"description": "The types of operations which should be blocked as a result of this Lien.\nEach value should correspond to an IAM permission. The server will\nvalidate the permissions against those for which Liens are supported.\n\nAn empty list is meaningless and will be rejected.\n\nExample: ['resourcemanager.projects.delete']",
@@ -842,13 +263,600 @@
}
},
"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."
+ }
+ },
+ "id": "Ancestor"
+ },
+ "ListConstraint": {
+ "description": "A `Constraint` that allows or disallows a list of string values, which are\nconfigured by an Organization's policy administrator with a `Policy`.",
+ "type": "object",
+ "properties": {
+ "suggestedValue": {
+ "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Constraint`.",
+ "type": "string"
+ }
+ },
+ "id": "ListConstraint"
+ },
+ "SetOrgPolicyRequest": {
+ "type": "object",
+ "properties": {
+ "policy": {
+ "description": "`Policy` to set on the resource.",
+ "$ref": "OrgPolicy"
+ }
+ },
+ "id": "SetOrgPolicyRequest",
+ "description": "The request sent to the SetOrgPolicyRequest method."
+ },
+ "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": {
+ "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"
+ }
+ }
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "Organization": {
+ "type": "object",
+ "properties": {
+ "owner": {
+ "$ref": "OrganizationOwner",
+ "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required."
+ },
+ "lifecycleState": {
+ "enumDescriptions": [
+ "Unspecified state. This is only useful for distinguishing unset values.",
+ "The normal and active state.",
+ "The organization has been marked for deletion by the user."
+ ],
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED"
+ ],
+ "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly",
+ "type": "string"
+ },
+ "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"
+ },
+ "creationTime": {
+ "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Organization",
+ "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong."
+ },
+ "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": {
+ "description": "The collection of constraints that are settable on the request resource.",
+ "type": "array",
+ "items": {
+ "$ref": "Constraint"
+ }
+ },
+ "nextPageToken": {
+ "description": "Page token used to retrieve the next page. This is currently not used.",
+ "type": "string"
+ }
+ },
+ "id": "ListAvailableOrgPolicyConstraintsResponse"
+ },
+ "ListPolicy": {
+ "description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\nA `ListPolicy` can define specific values that are allowed or denied by\nsetting either the `allowed_values` or `denied_values` fields. It can also\nbe used to allow or deny all values, by setting the `all_values` field. If\n`all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`\nor `denied_values` must be set (attempting to set both or neither will\nresult in a failed request). If `all_values` is set to either `ALLOW` or\n`DENY`, `allowed_values` and `denied_values` must be unset.",
+ "type": "object",
+ "properties": {
+ "suggestedValue": {
+ "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Policy`. If `suggested_value`\nis not set, it will inherit the value specified higher in the hierarchy,\nunless `inherit_from_parent` is `false`.",
+ "type": "string"
+ },
+ "inheritFromParent": {
+ "description": "Determines the inheritance behavior for this `Policy`.\n\nBy default, a `ListPolicy` set at a resource supercedes any `Policy` set\nanywhere up the resource hierarchy. However, if `inherit_from_parent` is\nset to `true`, then the values from the effective `Policy` of the parent\nresource are inherited, meaning the values set in this `Policy` are\nadded to the values inherited up the hierarchy.\n\nSetting `Policy` hierarchies that inherit both allowed values and denied\nvalues isn't recommended in most circumstances to keep the configuration\nsimple and understandable. However, it is possible to set a `Policy` with\n`allowed_values` set that inherits a `Policy` with `denied_values` set.\nIn this case, the values that are allowed must be in `allowed_values` and\nnot present in `denied_values`.\n\nFor example, suppose you have a `Constraint`\n`constraints/serviceuser.services`, which has a `constraint_type` of\n`list_constraint`, and with `constraint_default` set to `ALLOW`.\nSuppose that at the Organization level, a `Policy` is applied that\nrestricts the allowed API activations to {`E1`, `E2`}. Then, if a\n`Policy` is applied to a project below the Organization that has\n`inherit_from_parent` set to `false` and field all_values set to DENY,\nthen an attempt to activate any API will be denied.\n\nThe following examples demonstrate different possible layerings:\n\nExample 1 (no inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n ``projects/bar`` has `inherit_from_parent` `false` and values:\n {allowed_values: \"E3\" allowed_values: \"E4\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E3`, and `E4`.\n\nExample 2 (inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {value: “E3” value: ”E4” inherit_from_parent: true}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.\n\nExample 3 (inheriting both allowed and denied values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {denied_values: \"E1\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe value accepted at `projects/bar` is `E2`.\n\nExample 4 (RestoreDefault):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {RestoreDefault: {}}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 5 (no policy inherits parent policy):\n `organizations/foo` has no `Policy` set.\n `projects/bar` has no `Policy` set.\nThe accepted values at both levels are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 6 (ListConstraint allowing all):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: ALLOW}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nAny value is accepted at `projects/bar`.\n\nExample 7 (ListConstraint allowing none):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: DENY}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nNo value is accepted at `projects/bar`.",
+ "type": "boolean"
+ },
+ "deniedValues": {
+ "description": "List of values denied at this resource. Can only be set if no values are\nset for `allowed_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "allValues": {
+ "enum": [
+ "ALL_VALUES_UNSPECIFIED",
+ "ALLOW",
+ "DENY"
+ ],
+ "description": "The policy all_values state.",
+ "type": "string",
+ "enumDescriptions": [
+ "Indicates that either allowed_values or denied_values must be set.",
+ "A policy with this set allows all values.",
+ "A policy with this set denies all values."
+ ]
+ },
+ "allowedValues": {
+ "description": "List of values allowed at this resource. Can only be set if no values\nare set for `denied_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ListPolicy"
+ },
+ "GetAncestryResponse": {
+ "description": "Response from the GetAncestry method.",
+ "type": "object",
+ "properties": {
+ "ancestor": {
+ "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The\nfirst ancestor is the project itself, followed by the project's parent,\netc.",
+ "type": "array",
+ "items": {
+ "$ref": "Ancestor"
+ }
+ }
+ },
+ "id": "GetAncestryResponse"
+ },
+ "AuditLogConfig": {
+ "type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members."
+ },
+ "logType": {
+ "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",
+ "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.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with\n`owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to `SearchOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "SearchOrganizationsRequest"
+ },
+ "GetAncestryRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "GetAncestryRequest",
+ "description": "The request sent to the\nGetAncestry\nmethod."
+ },
+ "TestIamPermissionsRequest": {
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "FolderOperation": {
+ "description": "Metadata describing a long running folder operation",
+ "type": "object",
+ "properties": {
+ "destinationParent": {
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
+ "type": "string"
+ },
+ "operationType": {
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "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"
+ }
+ },
+ "id": "FolderOperation"
+ },
+ "Policy": {
+ "type": "object",
+ "properties": {
+ "version": {
+ "type": "integer",
+ "description": "Deprecated.",
+ "format": "int32"
+ },
+ "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"
+ }
+ },
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "Policy",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs)."
+ },
+ "ListAvailableOrgPolicyConstraintsRequest": {
+ "properties": {
+ "pageToken": {
+ "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ListAvailableOrgPolicyConstraintsRequest",
+ "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.",
+ "type": "object"
+ },
+ "ResourceId": {
+ "id": "ResourceId",
+ "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\"",
+ "type": "string"
+ },
+ "id": {
+ "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
+ "type": "string"
+ }
+ }
+ },
+ "GetEffectiveOrgPolicyRequest": {
+ "description": "The request sent to the GetEffectiveOrgPolicy method.",
+ "type": "object",
+ "properties": {
+ "constraint": {
+ "description": "The name of the `Constraint` to compute the effective `Policy`.",
+ "type": "string"
+ }
+ },
+ "id": "GetEffectiveOrgPolicyRequest"
+ },
+ "ListOrgPoliciesRequest": {
+ "description": "The request sent to the ListOrgPolicies method.",
+ "type": "object",
+ "properties": {
+ "pageToken": {
+ "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ListOrgPoliciesRequest"
+ },
+ "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\nAuditLogConfig 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": {
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4"
+ }
+ },
+ "id": "AuditConfig"
+ },
+ "Operation": {
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
+ },
+ "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": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ }
+ }
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "type": "array",
+ "items": {
+ "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"
+ },
+ "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": {
+ "constraintDefault": {
+ "enum": [
+ "CONSTRAINT_DEFAULT_UNSPECIFIED",
+ "ALLOW",
+ "DENY"
+ ],
+ "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."
+ ]
+ },
+ "name": {
+ "description": "Immutable value, required to globally be unique. For example,\n`constraints/serviceuser.services`",
+ "type": "string"
+ },
+ "listConstraint": {
+ "$ref": "ListConstraint",
+ "description": "Defines this constraint as being a ListConstraint."
+ },
+ "version": {
+ "description": "Version of the `Constraint`. Default version is 0;",
+ "format": "int32",
+ "type": "integer"
+ },
+ "description": {
+ "type": "string",
+ "description": "Detailed description of what this `Constraint` controls as well as how and\nwhere it is enforced.\n\nMutable."
+ },
+ "displayName": {
+ "description": "The human readable name.\n\nMutable.",
+ "type": "string"
+ },
+ "booleanConstraint": {
+ "$ref": "BooleanConstraint",
+ "description": "Defines this constraint as being a BooleanConstraint."
+ }
+ },
+ "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"
+ },
+ "Binding": {
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ }
+ },
+ "GetOrgPolicyRequest": {
+ "description": "The request sent to the GetOrgPolicy method.",
+ "type": "object",
+ "properties": {
+ "constraint": {
+ "description": "Name of the `Constraint` to get the `Policy`.",
+ "type": "string"
+ }
+ },
+ "id": "GetOrgPolicyRequest"
+ },
+ "RestoreDefault": {
+ "description": "Ignores policies set above this resource and restores the\n`constraint_default` enforcement behavior of the specific `Constraint` at\nthis resource.\n\nSuppose that `constraint_default` is set to `ALLOW` for the\n`Constraint` `constraints/serviceuser.services`. Suppose that organization\nfoo.com sets a `Policy` at their Organization resource node that restricts\nthe allowed service activations to deny all service activations. They\ncould then set a `Policy` with the `policy_type` `restore_default` on\nseveral experimental projects, restoring the `constraint_default`\nenforcement of the `Constraint` for only those projects, allowing those\nprojects to have all services activated.",
+ "type": "object",
+ "properties": {},
+ "id": "RestoreDefault"
+ },
+ "ClearOrgPolicyRequest": {
+ "type": "object",
+ "properties": {
+ "constraint": {
+ "description": "Name of the `Constraint` of the `Policy` to clear.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "The current version, for concurrency control. Not sending an `etag`\nwill cause the `Policy` to be cleared blindly.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "ClearOrgPolicyRequest",
+ "description": "The request sent to the ClearOrgPolicy method."
+ },
+ "UndeleteProjectRequest": {
+ "description": "The request sent to the UndeleteProject\nmethod.",
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteProjectRequest"
+ },
+ "ProjectCreationStatus": {
+ "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
+ "type": "object",
+ "properties": {
+ "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"
}
},
- "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 Resource Manager",
"auth": {
"oauth2": {
@@ -870,9 +878,847 @@
"title": "Google Cloud Resource Manager API",
"ownerName": "Google",
"resources": {
+ "folders": {
+ "methods": {
+ "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",
+ "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"
+ }
+ },
+ "listOrgPolicies": {
+ "response": {
+ "$ref": "ListOrgPoliciesResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^folders/[^/]+$",
+ "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/folders/{foldersId}:listOrgPolicies",
+ "path": "v1/{+resource}:listOrgPolicies",
+ "id": "cloudresourcemanager.folders.listOrgPolicies",
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ },
+ "description": "Lists all the `Policies` set for a particular resource."
+ },
+ "getOrgPolicy": {
+ "id": "cloudresourcemanager.folders.getOrgPolicy",
+ "path": "v1/{+resource}:getOrgPolicy",
+ "request": {
+ "$ref": "GetOrgPolicyRequest"
+ },
+ "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^folders/[^/]+$",
+ "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/folders/{foldersId}:getOrgPolicy"
+ },
+ "getEffectiveOrgPolicy": {
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "The name of the resource to start computing the effective `Policy`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$"
+ }
+ },
+ "flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy",
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "id": "cloudresourcemanager.folders.getEffectiveOrgPolicy",
+ "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "projects": {
+ "methods": {
+ "listAvailableOrgPolicyConstraints": {
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
+ "id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints",
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ },
+ "response": {
+ "$ref": "ListAvailableOrgPolicyConstraintsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource to list `Constraints` for.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:listAvailableOrgPolicyConstraints"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{resource}:getIamPolicy",
+ "path": "v1/projects/{resource}:getIamPolicy",
+ "id": "cloudresourcemanager.projects.getIamPolicy",
+ "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.getIamPolicy` on the project.\n\nFor additional information about resource structure and identification,\nsee [Resource Names](/apis/design/resource_names).",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ }
+ },
+ "getOrgPolicy": {
+ "flatPath": "v1/projects/{projectsId}:getOrgPolicy",
+ "path": "v1/{+resource}:getOrgPolicy",
+ "id": "cloudresourcemanager.projects.getOrgPolicy",
+ "request": {
+ "$ref": "GetOrgPolicyRequest"
+ },
+ "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource the `Policy` is set on.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "undelete": {
+ "request": {
+ "$ref": "UndeleteProjectRequest"
+ },
+ "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The project ID (for example, `foo-bar-123`).\n\nRequired."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}:undelete",
+ "path": "v1/projects/{projectId}:undelete",
+ "id": "cloudresourcemanager.projects.undelete"
+ },
+ "getEffectiveOrgPolicy": {
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The name of the resource to start computing the effective `Policy`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/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"
+ }
+ },
+ "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"
+ },
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.update",
+ "path": "v1/projects/{projectId}"
+ },
+ "list": {
+ "flatPath": "v1/projects",
+ "id": "cloudresourcemanager.projects.list",
+ "path": "v1/projects",
+ "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the\nGetProject method.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListProjectsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "location": "path",
+ "description": "Resource name of the resource to attach the `Policy`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}:setOrgPolicy"
+ },
+ "create": {
+ "flatPath": "v1/projects",
+ "path": "v1/projects",
+ "id": "cloudresourcemanager.projects.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.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "listOrgPolicies": {
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ },
+ "description": "Lists all the `Policies` set for a particular resource.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "ListOrgPoliciesResponse"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+$",
+ "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/projects/{projectsId}:listOrgPolicies",
+ "id": "cloudresourcemanager.projects.listOrgPolicies",
+ "path": "v1/{+resource}:listOrgPolicies"
+ },
+ "get": {
+ "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectId}",
+ "path": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.get"
+ },
+ "getAncestry": {
+ "response": {
+ "$ref": "GetAncestryResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired."
+ }
+ },
+ "flatPath": "v1/projects/{projectId}:getAncestry",
+ "path": "v1/projects/{projectId}:getAncestry",
+ "id": "cloudresourcemanager.projects.getAncestry",
+ "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.",
+ "request": {
+ "$ref": "GetAncestryRequest"
+ }
+ },
+ "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.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{resource}:testIamPermissions",
+ "path": "v1/projects/{resource}:testIamPermissions",
+ "id": "cloudresourcemanager.projects.testIamPermissions"
+ },
+ "delete": {
+ "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}",
+ "path": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.delete"
+ },
+ "clearOrgPolicy": {
+ "request": {
+ "$ref": "ClearOrgPolicyRequest"
+ },
+ "description": "Clears a `Policy` from a resource.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "Name of the resource for the `Policy` to clear.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}:clearOrgPolicy",
+ "id": "cloudresourcemanager.projects.clearOrgPolicy",
+ "path": "v1/{+resource}:clearOrgPolicy"
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{resource}:setIamPolicy",
+ "path": "v1/projects/{resource}:setIamPolicy",
+ "id": "cloudresourcemanager.projects.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`;\nthey must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.setIamPolicy` on the project"
+ }
+ }
+ },
"organizations": {
"methods": {
+ "setIamPolicy": {
+ "flatPath": "v1/organizations/{organizationsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "cloudresourcemanager.organizations.setIamPolicy",
+ "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.setIamPolicy` on the specified organization",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "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": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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"
+ },
+ "listAvailableOrgPolicyConstraints": {
+ "id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints",
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ },
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "ListAvailableOrgPolicyConstraintsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "Name of the resource to list `Constraints` for.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints"
+ },
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:getIamPolicy",
+ "path": "v1/{+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\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.getIamPolicy` on the specified organization"
+ },
+ "search": {
+ "flatPath": "v1/organizations:search",
+ "id": "cloudresourcemanager.organizations.search",
+ "path": "v1/organizations:search",
+ "request": {
+ "$ref": "SearchOrganizationsRequest"
+ },
+ "description": "Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults.\n\nSearch will only return organizations on which the user has the permission\n`resourcemanager.organizations.get`",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchOrganizationsResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "getOrgPolicy": {
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource the `Policy` is set on.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:getOrgPolicy",
+ "path": "v1/{+resource}:getOrgPolicy",
+ "id": "cloudresourcemanager.organizations.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"
+ },
+ "get": {
+ "description": "Fetches an Organization resource identified by the specified resource name.",
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}",
+ "path": "v1/{+name}",
+ "id": "cloudresourcemanager.organizations.get"
+ },
+ "getEffectiveOrgPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "The name of the resource to start computing the effective `Policy`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy",
+ "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."
+ },
"testIamPermissions": {
+ "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"
@@ -896,16 +1742,9 @@
"required": true,
"type": "string"
}
- },
- "flatPath": "v1/organizations/{organizationsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "cloudresourcemanager.organizations.testIamPermissions"
+ }
},
"clearOrgPolicy": {
- "description": "Clears a `Policy` from a resource.",
- "request": {
- "$ref": "ClearOrgPolicyRequest"
- },
"response": {
"$ref": "Empty"
},
@@ -913,9 +1752,6 @@
"resource"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"resource": {
"description": "Name of the resource for the `Policy` to clear.",
@@ -925,279 +1761,49 @@
"location": "path"
}
},
- "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy",
- "id": "cloudresourcemanager.organizations.clearOrgPolicy"
- },
- "setOrgPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameters": {
- "resource": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "Resource name of the resource to attach the `Policy`.",
- "required": true,
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/organizations/{organizationsId}:setOrgPolicy",
- "id": "cloudresourcemanager.organizations.setOrgPolicy",
+ "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy",
+ "path": "v1/{+resource}:clearOrgPolicy",
+ "id": "cloudresourcemanager.organizations.clearOrgPolicy",
+ "request": {
+ "$ref": "ClearOrgPolicyRequest"
+ },
+ "description": "Clears a `Policy` from a resource."
+ },
+ "setOrgPolicy": {
"path": "v1/{+resource}:setOrgPolicy",
+ "id": "cloudresourcemanager.organizations.setOrgPolicy",
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
"request": {
"$ref": "SetOrgPolicyRequest"
},
- "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": {
"response": {
- "$ref": "Policy"
+ "$ref": "OrgPolicy"
},
"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": "^organizations/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/organizations/{organizationsId}: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"
- },
- "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"
- },
- "listAvailableOrgPolicyConstraints": {
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints",
- "description": "Lists `Constraints` that could be applied on the specified resource.",
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "description": "Name of the resource to list `Constraints` for.",
+ "description": "Resource name of the resource to attach the `Policy`.",
"required": true,
"type": "string",
"pattern": "^organizations/[^/]+$",
"location": "path"
}
},
- "flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints"
- },
- "getIamPolicy": {
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.getIamPolicy` on the specified organization",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "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",
- "id": "cloudresourcemanager.organizations.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
- },
- "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": {
- "description": "Name of the resource the `Policy` is set on.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy",
- "id": "cloudresourcemanager.organizations.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"
- }
- },
- "search": {
- "path": "v1/organizations:search",
- "id": "cloudresourcemanager.organizations.search",
- "request": {
- "$ref": "SearchOrganizationsRequest"
- },
- "description": "Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults.\n\nSearch will only return organizations on which the user has the permission\n`resourcemanager.organizations.get`",
- "response": {
- "$ref": "SearchOrganizationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations:search"
- },
- "getEffectiveOrgPolicy": {
- "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameters": {
- "resource": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "The name of the resource to start computing the effective `Policy`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Organization"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
- "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}",
- "id": "cloudresourcemanager.organizations.get",
- "path": "v1/{+name}",
- "description": "Fetches an Organization resource identified by the specified resource name."
+ "flatPath": "v1/organizations/{organizationsId}:setOrgPolicy"
}
}
},
"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": {
"response": {
"$ref": "Empty"
@@ -1206,33 +1812,31 @@
"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"
],
- "parameters": {
- "name": {
- "description": "The name/identifier of the Lien to delete.",
- "required": true,
- "type": "string",
- "pattern": "^liens/.+$",
- "location": "path"
- }
- },
"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`."
},
"list": {
- "id": "cloudresourcemanager.liens.list",
- "path": "v1/liens",
"description": "List all Liens applied to the `parent` resource.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.get`.",
"httpMethod": "GET",
+ "parameterOrder": [],
"response": {
"$ref": "ListLiensResponse"
},
- "parameterOrder": [],
"parameters": {
"parent": {
"description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
@@ -1245,26 +1849,44 @@
"type": "string"
},
"pageSize": {
+ "location": "query",
"description": "The maximum number of items to return. This is a suggestion for the server.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/liens"
+ "flatPath": "v1/liens",
+ "id": "cloudresourcemanager.liens.list",
+ "path": "v1/liens"
+ },
+ "create": {
+ "request": {
+ "$ref": "Lien"
+ },
+ "description": "Create a Lien which applies to the resource denoted by the `parent` field.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, applying to `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.\n\nNOTE: Some resources may limit the number of Liens which may be applied.",
+ "response": {
+ "$ref": "Lien"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/liens",
+ "path": "v1/liens",
+ "id": "cloudresourcemanager.liens.create"
}
}
},
"operations": {
"methods": {
"get": {
- "id": "cloudresourcemanager.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"
@@ -1285,664 +1907,55 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/operations/{operationsId}"
- }
- }
- },
- "folders": {
- "methods": {
- "clearOrgPolicy": {
- "path": "v1/{+resource}:clearOrgPolicy",
- "id": "cloudresourcemanager.folders.clearOrgPolicy",
- "description": "Clears a `Policy` from a resource.",
- "request": {
- "$ref": "ClearOrgPolicyRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "description": "Name of the resource for the `Policy` to clear.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/folders/{foldersId}:clearOrgPolicy"
- },
- "setOrgPolicy": {
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "Resource name of the resource to attach the `Policy`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/folders/{foldersId}:setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy",
- "id": "cloudresourcemanager.folders.setOrgPolicy",
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
- "request": {
- "$ref": "SetOrgPolicyRequest"
- }
- },
- "listAvailableOrgPolicyConstraints": {
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints",
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "description": "Lists `Constraints` that could be applied on the specified resource.",
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "Name of the resource to list `Constraints` for.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/folders/{foldersId}:listAvailableOrgPolicyConstraints"
- },
- "listOrgPolicies": {
- "id": "cloudresourcemanager.folders.listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies",
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- },
- "description": "Lists all the `Policies` set for a particular resource.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "ListOrgPoliciesResponse"
- },
- "parameters": {
- "resource": {
- "pattern": "^folders/[^/]+$",
- "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/folders/{foldersId}: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": {
- "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"
- ],
- "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."
- }
- }
- },
- "projects": {
- "methods": {
- "update": {
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "projectId": {
- "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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."
- },
- "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."
- },
- "setOrgPolicy": {
- "request": {
- "$ref": "SetOrgPolicyRequest"
- },
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameters": {
- "resource": {
- "description": "Resource name of the resource to attach the `Policy`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}:setOrgPolicy",
- "id": "cloudresourcemanager.projects.setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy"
- },
- "create": {
- "description": "Request that a new Project be created. The result is an Operation which\ncan be used to track the creation process. It is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.\n\nOur SLO permits Project creation to take up to 30 seconds at the 90th\npercentile. As of 2016-08-29, we are observing 6 seconds 50th percentile\nlatency. 95th percentile latency is around 11 seconds. We recommend\npolling at the 5th second with an exponential backoff.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.create` on the specified parent for the new\nproject.",
- "request": {
- "$ref": "Project"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/projects",
- "path": "v1/projects",
- "id": "cloudresourcemanager.projects.create"
- },
- "listOrgPolicies": {
- "response": {
- "$ref": "ListOrgPoliciesResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Name of the resource to list Policies for.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}:listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies",
- "id": "cloudresourcemanager.projects.listOrgPolicies",
- "description": "Lists all the `Policies` set for a particular resource.",
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- }
- },
- "get": {
- "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"
- },
- "parameterOrder": [
- "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.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}"
- },
- "getAncestry": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "GetAncestryResponse"
- },
- "parameters": {
- "projectId": {
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectId}:getAncestry",
- "id": "cloudresourcemanager.projects.getAncestry",
- "path": "v1/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": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Project.\n\nThere are no permissions required for making this API call.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{resource}:testIamPermissions",
- "id": "cloudresourcemanager.projects.testIamPermissions",
- "path": "v1/projects/{resource}:testIamPermissions"
- },
- "delete": {
- "path": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.delete",
- "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}"
- },
- "clearOrgPolicy": {
- "description": "Clears a `Policy` from a resource.",
- "request": {
- "$ref": "ClearOrgPolicyRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Name of the resource for the `Policy` to clear.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}:clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy",
- "id": "cloudresourcemanager.projects.clearOrgPolicy"
- },
- "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",
- "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": {
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+$",
- "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/projects/{projectsId}:listAvailableOrgPolicyConstraints",
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints",
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "description": "Lists `Constraints` that could be applied on the specified 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.\n\nFor additional information about resource structure and identification,\nsee [Resource Names](/apis/design/resource_names).",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "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"
- },
- "getOrgPolicy": {
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
- "request": {
- "$ref": "GetOrgPolicyRequest"
- },
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "description": "Name of the resource the `Policy` is set on.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}:getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy",
- "id": "cloudresourcemanager.projects.getOrgPolicy"
- },
- "getEffectiveOrgPolicy": {
- "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": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.projects.getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources."
- },
- "undelete": {
- "path": "v1/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"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}:undelete"
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "cloudresourcemanager.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": {
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "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": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format."
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1950,7 +1963,13 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
},
"access_token": {
"description": "OAuth access token.",
@@ -1963,9 +1982,9 @@
"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.",
- "type": "string"
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
},
"pp": {
"description": "Pretty-print response.",
@@ -1979,30 +1998,11 @@
"type": "string"
},
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
}
},
"version": "v1",
- "baseUrl": "https://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": "20180124",
- "documentationLink": "https://cloud.google.com/resource-manager",
- "id": "cloudresourcemanager:v1",
- "discoveryVersion": "v1"
+ "baseUrl": "https://cloudresourcemanager.googleapis.com/"
}
diff --git a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
index a52b9a8..ed8da5a 100644
--- a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
@@ -1,181 +1,14 @@
{
+ "baseUrl": "https://cloudresourcemanager.googleapis.com/",
+ "servicePath": "",
+ "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "revision": "20180124",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "id": "cloudresourcemanager:v1beta1",
"discoveryVersion": "v1",
"schemas": {
- "AuditConfig": {
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- }
- },
- "id": "AuditConfig",
- "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\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object"
- },
- "Ancestor": {
- "description": "Identifying information for a single ancestor of a project.",
- "type": "object",
- "properties": {
- "resourceId": {
- "description": "Resource id of the ancestor.",
- "$ref": "ResourceId"
- }
- },
- "id": "Ancestor"
- },
- "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"
- },
- "ListOrganizationsResponse": {
- "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",
- "description": "The response returned from the `ListOrganizations` method.",
- "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"
- },
- "Organization": {
- "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
- "type": "object",
- "properties": {
- "creationTime": {
- "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "owner": {
- "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required.",
- "$ref": "OrganizationOwner"
- },
- "name": {
- "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
- "type": "string"
- },
- "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": {
- "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"
- }
- },
- "id": "Organization"
- },
- "UndeleteProjectRequest": {
- "properties": {},
- "id": "UndeleteProjectRequest",
- "description": "The request sent to the UndeleteProject\nmethod.",
- "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"
- },
- "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"
- },
"GetAncestryResponse": {
"description": "Response from the GetAncestry method.",
"type": "object",
@@ -201,6 +34,36 @@
},
"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": {
+ "logType": {
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string"
+ },
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "AuditLogConfig"
+ },
"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",
@@ -219,36 +82,6 @@
},
"id": "ListProjectsResponse"
},
- "AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "logType": {
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string"
- }
- },
- "id": "AuditLogConfig"
- },
"GetAncestryRequest": {
"description": "The request sent to the\nGetAncestry\nmethod.",
"type": "object",
@@ -259,6 +92,35 @@
"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": {
+ "$ref": "ResourceId",
+ "description": "An optional reference to a parent Resource.\n\nSupported parent types include \"organization\" and \"folder\". Once set, the\nparent cannot be cleared. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write."
+ },
+ "createTime": {
+ "description": "Creation time.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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": {
"description": "The Project lifecycle state.\n\nRead-only.",
"type": "string",
@@ -274,40 +136,13 @@
"DELETE_REQUESTED",
"DELETE_IN_PROGRESS"
]
- },
- "projectNumber": {
- "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
- "format": "int64",
- "type": "string"
- },
- "parent": {
- "$ref": "ResourceId",
- "description": "An optional reference to a parent Resource.\n\nSupported parent types include \"organization\" and \"folder\". Once set, the\nparent cannot be cleared. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write."
- },
- "labels": {
- "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"
}
},
"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).",
@@ -317,14 +152,22 @@
}
}
},
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
+ "id": "TestIamPermissionsRequest"
},
"Policy": {
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
"type": "object",
"properties": {
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "Deprecated.",
+ "format": "int32",
+ "type": "integer"
+ },
"auditConfigs": {
"description": "Specifies cloud audit logging configuration for this policy.",
"type": "array",
@@ -338,53 +181,10 @@
"items": {
"$ref": "Binding"
}
- },
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Deprecated.",
- "format": "int32",
- "type": "integer"
}
},
"id": "Policy"
},
- "FolderOperation": {
- "description": "Metadata describing a long running folder operation",
- "type": "object",
- "properties": {
- "operationType": {
- "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"
- },
"FolderOperationError": {
"description": "A classification of the Folder Operation error.",
"type": "object",
@@ -420,6 +220,39 @@
},
"id": "FolderOperationError"
},
+ "FolderOperation": {
+ "description": "Metadata describing a long running folder operation",
+ "type": "object",
+ "properties": {
+ "operationType": {
+ "description": "The type of this operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Operation type not specified.",
+ "A create folder operation.",
+ "A move folder operation."
+ ],
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE",
+ "MOVE"
+ ]
+ },
+ "displayName": {
+ "description": "The display name of the folder.",
+ "type": "string"
+ },
+ "sourceParent": {
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
+ "type": "string"
+ },
+ "destinationParent": {
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
+ "type": "string"
+ }
+ },
+ "id": "FolderOperation"
+ },
"ResourceId": {
"description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
"type": "object",
@@ -434,13 +267,188 @@
}
},
"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\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object",
+ "properties": {
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ }
+ }
+ },
+ "id": "AuditConfig"
+ },
+ "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": {
+ "$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"
+ },
+ "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"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "UndeleteProjectRequest": {
+ "description": "The request sent to the UndeleteProject\nmethod.",
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteProjectRequest"
+ },
+ "Organization": {
+ "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
+ "type": "object",
+ "properties": {
+ "owner": {
+ "$ref": "OrganizationOwner",
+ "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required."
+ },
+ "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"
+ },
+ "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"
+ ]
+ },
+ "displayName": {
+ "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Organization"
+ },
+ "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"
+ },
+ "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"
}
},
- "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": {
@@ -464,36 +472,65 @@
"resources": {
"organizations": {
"methods": {
- "get": {
- "response": {
- "$ref": "Organization"
- },
+ "getIamPolicy": {
+ "httpMethod": "POST",
"parameterOrder": [
- "name"
+ "resource"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
+ "response": {
+ "$ref": "Policy"
+ },
"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": {
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
+ "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": "v1beta1/organizations/{organizationsId}:getIamPolicy",
+ "id": "cloudresourcemanager.organizations.getIamPolicy",
+ "path": "v1beta1/{+resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\"."
+ },
+ "get": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1beta1/organizations/{organizationsId}",
- "path": "v1beta1/{+name}",
"id": "cloudresourcemanager.organizations.get",
- "description": "Fetches an Organization resource identified by the specified resource name."
+ "path": "v1beta1/{+name}"
},
"update": {
"description": "Updates an Organization resource identified by the specified resource name.",
@@ -524,33 +561,33 @@
"id": "cloudresourcemanager.organizations.update"
},
"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"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"parameters": {
"resource": {
- "pattern": "^organizations/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string"
+ "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}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "cloudresourcemanager.organizations.testIamPermissions"
},
"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.",
@@ -561,20 +598,20 @@
"parameterOrder": [],
"parameters": {
"filter": {
- "location": "query",
"description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
- "type": "string"
- },
- "pageToken": {
- "description": "A pagination token returned from a previous call to `ListOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
"type": "string",
"location": "query"
},
+ "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",
- "location": "query"
+ "type": "integer"
}
},
"scopes": [
@@ -586,9 +623,6 @@
"path": "v1beta1/organizations"
},
"setIamPolicy": {
- "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy",
- "path": "v1beta1/{+resource}:setIamPolicy",
- "id": "cloudresourcemanager.organizations.setIamPolicy",
"description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".",
"request": {
"$ref": "SetIamPolicyRequest"
@@ -605,131 +639,21 @@
],
"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/[^/]+$",
- "location": "path"
- }
- }
- },
- "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": {
- "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"
+ "pattern": "^organizations/[^/]+$"
}
},
- "flatPath": "v1beta1/organizations/{organizationsId}:getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy",
- "id": "cloudresourcemanager.organizations.getIamPolicy",
- "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".",
- "request": {
- "$ref": "GetIamPolicyRequest"
- }
+ "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy",
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "id": "cloudresourcemanager.organizations.setIamPolicy"
}
}
},
"projects": {
"methods": {
- "list": {
- "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the GetProjectmethod.",
- "response": {
- "$ref": "ListProjectsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "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"
- },
- "create": {
- "request": {
- "$ref": "Project"
- },
- "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage.",
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {
- "useLegacyStack": {
- "description": "A safety hatch to opt out of the new reliable project creation process.",
- "type": "boolean",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects",
- "path": "v1beta1/projects",
- "id": "cloudresourcemanager.projects.create"
- },
- "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",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
- "path": "v1beta1/projects/{resource}:setIamPolicy",
- "id": "cloudresourcemanager.projects.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles."
- },
"getIamPolicy": {
"response": {
"$ref": "Policy"
@@ -758,7 +682,35 @@
"$ref": "GetIamPolicyRequest"
}
},
+ "get": {
+ "flatPath": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.get",
+ "path": "v1beta1/projects/{projectId}",
+ "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
"undelete": {
+ "flatPath": "v1beta1/projects/{projectId}:undelete",
+ "id": "cloudresourcemanager.projects.undelete",
+ "path": "v1beta1/projects/{projectId}:undelete",
"request": {
"$ref": "UndeleteProjectRequest"
},
@@ -772,79 +724,24 @@
},
"parameters": {
"projectId": {
- "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}:undelete",
- "id": "cloudresourcemanager.projects.undelete",
- "path": "v1beta1/projects/{projectId}:undelete"
- },
- "get": {
- "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Project"
- },
- "parameters": {
- "projectId": {
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.get",
- "path": "v1beta1/projects/{projectId}"
- },
- "getAncestry": {
- "flatPath": "v1beta1/projects/{projectId}:getAncestry",
- "path": "v1beta1/projects/{projectId}:getAncestry",
- "id": "cloudresourcemanager.projects.getAncestry",
- "request": {
- "$ref": "GetAncestryRequest"
- },
- "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
- "response": {
- "$ref": "GetAncestryResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
"location": "path",
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
"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/cloud-platform"
]
},
"update": {
+ "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"
},
+ "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"
},
@@ -852,9 +749,6 @@
"projectId"
],
"httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"projectId": {
"location": "path",
@@ -863,26 +757,56 @@
"type": "string"
}
},
- "flatPath": "v1beta1/projects/{projectId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "getAncestry": {
+ "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.",
+ "request": {
+ "$ref": "GetAncestryRequest"
+ },
+ "response": {
+ "$ref": "GetAncestryResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "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.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}:getAncestry",
+ "path": "v1beta1/projects/{projectId}:getAncestry",
+ "id": "cloudresourcemanager.projects.getAncestry"
},
"testIamPermissions": {
"request": {
"$ref": "TestIamPermissionsRequest"
},
"description": "Returns permissions that a caller has on the specified Project.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "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"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -890,20 +814,18 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1beta1/projects/{resource}:testIamPermissions",
- "path": "v1beta1/projects/{resource}:testIamPermissions",
- "id": "cloudresourcemanager.projects.testIamPermissions"
+ "id": "cloudresourcemanager.projects.testIamPermissions",
+ "path": "v1beta1/projects/{resource}:testIamPermissions"
},
"delete": {
- "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.",
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "DELETE",
"parameterOrder": [
"projectId"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"projectId": {
"location": "path",
@@ -915,65 +837,101 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/projects/{projectId}"
+ "flatPath": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.delete",
+ "path": "v1beta1/projects/{projectId}"
+ },
+ "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.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListProjectsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of 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": {
+ "location": "query",
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects",
+ "id": "cloudresourcemanager.projects.list",
+ "path": "v1beta1/projects"
+ },
+ "setIamPolicy": {
+ "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
+ "id": "cloudresourcemanager.projects.setIamPolicy",
+ "path": "v1beta1/projects/{resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "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"
}
}
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
+ "access_token": {
"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"
- ],
+ "description": "OAuth access token.",
"type": "string"
},
"key": {
@@ -981,11 +939,6 @@
"description": "API key. Your API 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",
@@ -998,23 +951,70 @@
"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": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
"location": "query",
- "description": "OAuth bearer token.",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
"type": "string"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
}
},
- "version": "v1beta1",
- "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.",
- "basePath": "",
- "revision": "20180124",
- "documentationLink": "https://cloud.google.com/resource-manager",
- "id": "cloudresourcemanager:v1beta1"
+ "version": "v1beta1"
}
diff --git a/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
index bec3511..58c639c 100644
--- a/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
@@ -1,79 +1,205 @@
{
- "basePath": "",
- "revision": "20180124",
- "documentationLink": "https://cloud.google.com/resource-manager",
- "id": "cloudresourcemanager:v2beta1",
"discoveryVersion": "v1",
"schemas": {
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "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": {
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
- "$ref": "AuditConfig"
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
}
},
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- },
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Deprecated.",
+ "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": "Policy"
+ "id": "Status"
},
- "FolderOperation": {
- "description": "Metadata describing a long running folder operation",
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
- "displayName": {
- "description": "The display name of the folder.",
- "type": "string"
- },
- "sourceParent": {
- "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
- "type": "string"
- },
- "destinationParent": {
- "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
- "type": "string"
- },
- "operationType": {
- "description": "The type of this operation.",
+ "role": {
"type": "string",
- "enumDescriptions": [
- "Operation type not specified.",
- "A create folder operation.",
- "A move folder operation."
- ],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "CREATE",
- "MOVE"
- ]
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired"
+ },
+ "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": "FolderOperation"
+ "id": "Binding"
+ },
+ "SearchFoldersRequest": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "Search criteria used to select the Folders to return.\nIf no search criteria is specified then all accessible folders will be\nreturned.\n\nQuery expressions can be used to restrict results based upon displayName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nSome example queries are:\n\n|Query | Description|\n|----- | -----------|\n|displayName=Test*|Folders whose display name starts with \"Test\".|\n|lifecycleState=ACTIVE|Folders whose lifecycleState is ACTIVE.|\n|parent=folders/123|Folders whose parent is \"folders/123\".|\n|parent=folders/123 AND lifecycleState=ACTIVE|Active folders whose parent is \"folders/123\".|",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.\nThis field is optional.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "The maximum number of folders to return in the response.\nThis field is optional.",
+ "format": "int32"
+ }
+ },
+ "id": "SearchFoldersRequest",
+ "description": "The request message for searching folders."
+ },
+ "Folder": {
+ "type": "object",
+ "properties": {
+ "lifecycleState": {
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED"
+ ],
+ "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified state.",
+ "The normal and active state.",
+ "The folder has been marked for deletion by the user."
+ ]
+ },
+ "name": {
+ "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The folder’s display name.\nA folder’s display name must be unique amongst its siblings, e.g.\nno two folders with the same parent can share the same display name.\nThe display name must start and end with a letter or digit, may contain\nletters, digits, spaces, hyphens and underscores and can be no longer\nthan 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.",
+ "type": "string"
+ },
+ "parent": {
+ "type": "string",
+ "description": "The Folder’s parent's resource name.\nUpdates to the folder's parent must be performed via\nMoveFolder."
+ },
+ "createTime": {
+ "type": "string",
+ "description": "Output only. Timestamp when the Folder was created. Assigned by the server.",
+ "format": "google-datetime"
+ }
+ },
+ "id": "Folder",
+ "description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources."
+ },
+ "ProjectCreationStatus": {
+ "type": "object",
+ "properties": {
+ "ready": {
+ "type": "boolean",
+ "description": "True if the project creation process is complete."
+ },
+ "createTime": {
+ "type": "string",
+ "description": "Creation time of the project creation workflow.",
+ "format": "google-datetime"
+ },
+ "gettable": {
+ "type": "boolean",
+ "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete."
+ }
+ },
+ "id": "ProjectCreationStatus",
+ "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed."
+ },
+ "GetIamPolicyRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest",
+ "description": "Request message for `GetIamPolicy` method."
+ },
+ "TestIamPermissionsResponse": {
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed."
+ }
+ },
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method."
+ },
+ "UndeleteFolderRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteFolderRequest",
+ "description": "The UndeleteFolder request message."
+ },
+ "AuditLogConfig": {
+ "type": "object",
+ "properties": {
+ "logType": {
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ]
+ },
+ "exemptedMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members."
+ }
+ },
+ "id": "AuditLogConfig",
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging."
+ },
+ "TestIamPermissionsRequest": {
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)."
+ }
+ },
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method."
},
"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.",
@@ -98,79 +224,142 @@
"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"
},
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "FolderOperation": {
+ "description": "Metadata describing a long running folder operation",
"type": "object",
"properties": {
+ "destinationParent": {
+ "type": "string",
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to."
+ },
+ "operationType": {
+ "type": "string",
+ "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."
+ },
+ "displayName": {
+ "type": "string",
+ "description": "The display name of the folder."
+ },
+ "sourceParent": {
+ "type": "string",
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE."
+ }
+ },
+ "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/docs).",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "type": "string",
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte"
+ },
+ "version": {
+ "type": "integer",
+ "description": "Deprecated.",
+ "format": "int32"
+ },
+ "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"
+ },
+ "Operation": {
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any."
+ },
"done": {
"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"
- }
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`."
},
"name": {
"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"
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
},
"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\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"type": "object",
"properties": {
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- },
"service": {
"description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
"type": "string"
+ },
+ "auditLogConfigs": {
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4"
}
},
- "id": "AuditConfig"
+ "id": "AuditConfig",
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging."
},
"ListFoldersResponse": {
"description": "The ListFolders response message.",
"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"
+ },
+ "folders": {
+ "type": "array",
+ "items": {
+ "$ref": "Folder"
+ },
+ "description": "A possibly paginated list of Folders that are direct descendants of\nthe specified parent resource."
}
},
"id": "ListFoldersResponse"
@@ -180,28 +369,12 @@
"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"
+ "type": "string",
+ "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}`."
}
},
"id": "MoveFolderRequest"
},
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "updateMask": {
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "policy": {
- "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"
- },
"SearchFoldersResponse": {
"description": "The response message for searching folders.",
"type": "object",
@@ -214,211 +387,34 @@
}
},
"nextPageToken": {
- "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.\nThis field is optional.",
- "type": "string"
+ "type": "string",
+ "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.\nThis field is optional."
}
},
"id": "SearchFoldersResponse"
},
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
"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"
- }
+ "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."
},
- "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.",
+ "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": "Status"
- },
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "SearchFoldersRequest": {
- "description": "The request message for searching folders.",
- "type": "object",
- "properties": {
- "pageSize": {
- "description": "The maximum number of folders to return in the response.\nThis field is optional.",
- "format": "int32",
- "type": "integer"
- },
- "query": {
- "description": "Search criteria used to select the Folders to return.\nIf no search criteria is specified then all accessible folders will be\nreturned.\n\nQuery expressions can be used to restrict results based upon displayName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nSome example queries are:\n\n|Query | Description|\n|----- | -----------|\n|displayName=Test*|Folders whose display name starts with \"Test\".|\n|lifecycleState=ACTIVE|Folders whose lifecycleState is ACTIVE.|\n|parent=folders/123|Folders whose parent is \"folders/123\".|\n|parent=folders/123 AND lifecycleState=ACTIVE|Active folders whose parent is \"folders/123\".|",
- "type": "string"
- },
- "pageToken": {
- "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.\nThis field is optional.",
- "type": "string"
- }
- },
- "id": "SearchFoldersRequest"
- },
- "ProjectCreationStatus": {
- "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
- "type": "object",
- "properties": {
- "createTime": {
- "description": "Creation time of the project creation workflow.",
- "format": "google-datetime",
- "type": "string"
- },
- "gettable": {
- "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
- "type": "boolean"
- },
- "ready": {
- "description": "True if the project creation process is complete.",
- "type": "boolean"
- }
- },
- "id": "ProjectCreationStatus"
- },
- "Folder": {
- "description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "The folder’s display name.\nA folder’s display name must be unique amongst its siblings, e.g.\nno two folders with the same parent can share the same display name.\nThe display name must start and end with a letter or digit, may contain\nletters, digits, spaces, hyphens and underscores and can be no longer\nthan 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.",
- "type": "string"
- },
- "parent": {
- "description": "The Folder’s parent's resource name.\nUpdates to the folder's parent must be performed via\nMoveFolder.",
- "type": "string"
- },
- "createTime": {
- "description": "Output only. Timestamp when the Folder was created. Assigned by the server.",
- "format": "google-datetime",
- "type": "string"
- },
- "lifecycleState": {
- "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified state.",
- "The normal and active state.",
- "The folder has been marked for deletion by the user."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED"
- ]
- },
- "name": {
- "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
- "type": "string"
- }
- },
- "id": "Folder"
- },
- "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"
- },
- "UndeleteFolderRequest": {
- "description": "The UndeleteFolder request message.",
- "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.",
- "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"
- },
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest"
+ "id": "SetIamPolicyRequest"
}
},
- "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"canonicalName": "Cloud Resource Manager",
"auth": {
"oauth2": {
@@ -443,10 +439,6 @@
"folders": {
"methods": {
"getIamPolicy": {
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for a Folder. The returned policy may be\nempty if no such policy or resource exists. The `resource` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe caller must have `resourcemanager.folders.getIamPolicy` permission\non the identified folder.",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -454,83 +446,89 @@
"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": "^folders/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$"
+ }
+ },
"flatPath": "v2beta1/folders/{foldersId}:getIamPolicy",
"id": "cloudresourcemanager.folders.getIamPolicy",
- "path": "v2beta1/{+resource}:getIamPolicy"
+ "path": "v2beta1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a Folder. The returned policy may be\nempty if no such policy or resource exists. The `resource` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe caller must have `resourcemanager.folders.getIamPolicy` permission\non the identified folder.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ }
},
"search": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "SearchFoldersResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {},
"flatPath": "v2beta1/folders:search",
- "path": "v2beta1/folders:search",
"id": "cloudresourcemanager.folders.search",
+ "path": "v2beta1/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"
}
},
- "undelete": {
- "description": "Cancels the deletion request for a Folder. This method may only be\ncalled on a Folder in the\nDELETE_REQUESTED state.\nIn order to succeed, the Folder's parent must be in the\nACTIVE state.\nIn addition, reintroducing the folder into the tree must not violate\nfolder naming, height and fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.undelete` permission on the\nidentified folder.",
- "request": {
- "$ref": "UndeleteFolderRequest"
- },
- "response": {
- "$ref": "Folder"
- },
+ "patch": {
+ "httpMethod": "PATCH",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Folder"
+ },
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Fields to be updated.\nOnly the `display_name` can be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\"."
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$"
- }
+ "flatPath": "v2beta1/folders/{foldersId}",
+ "id": "cloudresourcemanager.folders.patch",
+ "path": "v2beta1/{+name}",
+ "request": {
+ "$ref": "Folder"
},
- "flatPath": "v2beta1/folders/{foldersId}:undelete",
- "path": "v2beta1/{+name}:undelete",
- "id": "cloudresourcemanager.folders.undelete"
+ "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."
},
"get": {
"description": "Retrieves a Folder identified by the supplied resource name.\nValid Folder resource names have the format `folders/{folder_id}`\n(for example, `folders/1234`).\nThe caller must have `resourcemanager.folders.get` permission on the\nidentified folder.",
+ "httpMethod": "GET",
"response": {
"$ref": "Folder"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"name": {
"location": "path",
@@ -540,32 +538,30 @@
"pattern": "^folders/[^/]+$"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v2beta1/folders/{foldersId}",
- "path": "v2beta1/{+name}",
- "id": "cloudresourcemanager.folders.get"
+ "id": "cloudresourcemanager.folders.get",
+ "path": "v2beta1/{+name}"
},
- "patch": {
+ "undelete": {
"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"
- },
+ "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.",
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Folder"
+ },
"parameters": {
- "updateMask": {
- "description": "Fields to be updated.\nOnly the `display_name` can be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
"name": {
"location": "path",
- "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/[^/]+$"
@@ -574,22 +570,25 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta1/folders/{foldersId}",
- "path": "v2beta1/{+name}",
- "id": "cloudresourcemanager.folders.patch"
+ "flatPath": "v2beta1/folders/{foldersId}:undelete",
+ "id": "cloudresourcemanager.folders.undelete",
+ "path": "v2beta1/{+name}:undelete"
},
"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"
},
- "description": "Moves a Folder under a new resource parent.\nReturns an Operation which can be used to track the progress of the\nfolder move workflow.\nUpon success the Operation.response field will be populated with the\nmoved Folder.\nUpon failure, a FolderOperationError categorizing the failure cause will\nbe returned - if the failure occurs synchronously then the\nFolderOperationError will be returned via the Status.details field\nand if it occurs asynchronously then the FolderOperation will be returned\nvia the the Operation.error field.\nIn addition, the Operation.metadata field will be populated with a\nFolderOperation message as an aid to stateless clients.\nFolder moves will be rejected if they violate either the naming, height\nor fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.move` permission on the\nfolder's current and proposed new parent.",
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
"location": "path",
@@ -599,12 +598,9 @@
"pattern": "^folders/[^/]+$"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v2beta1/folders/{foldersId}:move",
- "path": "v2beta1/{+name}:move",
- "id": "cloudresourcemanager.folders.move"
+ "id": "cloudresourcemanager.folders.move",
+ "path": "v2beta1/{+name}:move"
},
"testIamPermissions": {
"response": {
@@ -642,62 +638,94 @@
"name"
],
"httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`."
+ }
+ },
"flatPath": "v2beta1/folders/{foldersId}",
"path": "v2beta1/{+name}",
"id": "cloudresourcemanager.folders.delete",
"description": "Requests deletion of a Folder. The Folder is moved into the\nDELETE_REQUESTED state\nimmediately, and is deleted approximately 30 days later. This method may\nonly be called on an empty Folder in the\nACTIVE state, where a Folder is empty if\nit doesn't contain any Folders or Projects in the\nACTIVE state.\nThe caller must have `resourcemanager.folders.delete` permission on the\nidentified folder."
},
"list": {
- "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": {
+ "type": "string",
+ "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`."
+ },
+ "showDeleted": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Controls whether Folders in the\nDELETE_REQUESTED\nstate should be returned. Defaults to false. This field is optional."
+ },
+ "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"
],
- "parameters": {
- "pageSize": {
- "description": "The maximum number of Folders to return in the response.\nThis field is optional.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "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. Defaults to false. This field is optional.",
- "type": "boolean",
- "location": "query"
- },
- "pageToken": {
- "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\nThis field is optional.",
- "type": "string",
- "location": "query"
- }
- },
"flatPath": "v2beta1/folders",
"path": "v2beta1/folders",
- "id": "cloudresourcemanager.folders.list"
+ "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."
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on a Folder, replacing any existing policy.\nThe `resource` field should be the Folder's resource name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folders.setIamPolicy` permission\non the identified folder.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "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."
+ }
+ },
+ "flatPath": "v2beta1/folders/{foldersId}:setIamPolicy",
+ "path": "v2beta1/{+resource}:setIamPolicy",
+ "id": "cloudresourcemanager.folders.setIamPolicy"
},
"create": {
+ "description": "Creates a Folder in the resource hierarchy.\nReturns an Operation which can be used to track the progress of the\nfolder creation workflow.\nUpon success the Operation.response field will be populated with the\ncreated Folder.\n\nIn order to succeed, the addition of this new Folder must not violate\nthe Folder naming, height or fanout constraints.\n\n+ The Folder's display_name must be distinct from all other Folder's that\nshare its parent.\n+ The addition of the Folder must not cause the active Folder hierarchy\nto exceed a height of 4. Note, the full active + deleted Folder hierarchy\nis allowed to reach a height of 8; this provides additional headroom when\nmoving folders that contain deleted folders.\n+ The addition of the Folder must not cause the total number of Folders\nunder its parent to exceed 100.\n\nIf the operation fails due to a folder constraint violation,\na PreconditionFailure explaining the violation will be returned.\nIf the failure occurs synchronously then the PreconditionFailure\nwill be returned via the Status.details field and if it occurs\nasynchronously then the PreconditionFailure will be returned\nvia the the Operation.error field.\n\nThe caller must have `resourcemanager.folders.create` permission on the\nidentified parent.",
+ "request": {
+ "$ref": "Folder"
+ },
"response": {
"$ref": "Operation"
},
@@ -708,107 +736,96 @@
],
"parameters": {
"parent": {
+ "type": "string",
"location": "query",
- "description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
- "type": "string"
+ "description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`."
}
},
"flatPath": "v2beta1/folders",
"path": "v2beta1/folders",
- "id": "cloudresourcemanager.folders.create",
- "description": "Creates a Folder in the resource hierarchy.\nReturns an Operation which can be used to track the progress of the\nfolder creation workflow.\nUpon success the Operation.response field will be populated with the\ncreated Folder.\n\nIn order to succeed, the addition of this new Folder must not violate\nthe Folder naming, height or fanout constraints.\n\n+ The Folder's display_name must be distinct from all other Folder's that\nshare its parent.\n+ The addition of the Folder must not cause the active Folder hierarchy\nto exceed a height of 4. Note, the full active + deleted Folder hierarchy\nis allowed to reach a height of 8; this provides additional headroom when\nmoving folders that contain deleted folders.\n+ The addition of the Folder must not cause the total number of Folders\nunder its parent to exceed 100.\n\nIf the operation fails due to a folder constraint violation,\na PreconditionFailure explaining the violation will be returned.\nIf the failure occurs synchronously then the PreconditionFailure\nwill be returned via the Status.details field and if it occurs\nasynchronously then the PreconditionFailure will be returned\nvia the the Operation.error field.\n\nThe caller must have `resourcemanager.folders.create` permission on the\nidentified parent.",
- "request": {
- "$ref": "Folder"
- }
- },
- "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": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "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."
+ "id": "cloudresourcemanager.folders.create"
}
}
}
},
"parameters": {
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "key": {
+ "type": "string",
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ },
+ "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",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "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"
+ "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.",
- "type": "string"
+ "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"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "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"
- ],
- "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",
@@ -816,33 +833,16 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use 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"
+ "default": "json"
}
},
"version": "v2beta1",
"baseUrl": "https://cloudresourcemanager.googleapis.com/",
"kind": "discovery#restDescription",
"description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
- "servicePath": ""
+ "servicePath": "",
+ "basePath": "",
+ "id": "cloudresourcemanager:v2beta1",
+ "revision": "20180124",
+ "documentationLink": "https://cloud.google.com/resource-manager"
}
diff --git a/cloudshell/v1/cloudshell-api.json b/cloudshell/v1/cloudshell-api.json
index 2bac8f9..fd989d2 100644
--- a/cloudshell/v1/cloudshell-api.json
+++ b/cloudshell/v1/cloudshell-api.json
@@ -1,15 +1,4 @@
{
- "canonicalName": "Cloud Shell",
- "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",
@@ -19,73 +8,18 @@
"resources": {
"operations": {
"methods": {
- "cancel": {
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "cloudshell.operations.cancel"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "cloudshell.operations.delete",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
- },
"list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
"response": {
"$ref": "ListOperationsResponse"
},
- "parameterOrder": [
- "name"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
],
- "httpMethod": "GET",
"parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
"name": {
"pattern": "^operations$",
"location": "path",
@@ -94,34 +28,36 @@
"type": "string"
},
"pageToken": {
- "description": "The standard list page token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "The standard list page token."
},
"pageSize": {
+ "location": "query",
"description": "The standard list page size.",
"format": "int32",
- "type": "integer",
+ "type": "integer"
+ },
+ "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": "cloudshell.operations.list",
+ "path": "v1/{+name}",
"description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "httpMethod": "GET",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
"parameters": {
"name": {
"pattern": "^operations/.+$",
@@ -135,14 +71,108 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/operations/{operationsId}",
- "id": "cloudshell.operations.get",
- "path": "v1/{+name}"
+ "path": "v1/{+name}",
+ "id": "cloudshell.operations.get"
+ },
+ "cancel": {
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "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": "cloudshell.operations.cancel",
+ "path": "v1/{+name}:cancel"
+ },
+ "delete": {
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "cloudshell.operations.delete",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted."
+ }
+ }
}
}
}
},
"parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "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",
@@ -154,86 +184,45 @@
"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"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
- "oauth_token": {
+ "pp": {
"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.",
+ "description": "Pretty-print response.",
"type": "boolean",
"default": "true"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
},
- "fields": {
+ "bearer_token": {
+ "type": "string",
"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"
+ "description": "OAuth bearer token."
}
},
"version": "v1",
"baseUrl": "https://cloudshell.googleapis.com/",
+ "servicePath": "",
"kind": "discovery#restDescription",
"description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n",
- "servicePath": "",
"basePath": "",
"id": "cloudshell:v1",
"documentationLink": "https://cloud.google.com/shell/docs/",
@@ -241,36 +230,97 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
+ "Empty": {
"type": "object",
"properties": {},
- "id": "CancelOperationRequest"
+ "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 `{}`."
+ },
+ "PublicKey": {
+ "description": "A public SSH key, corresponding to a private SSH key held by the client.",
+ "type": "object",
+ "properties": {
+ "format": {
+ "enum": [
+ "FORMAT_UNSPECIFIED",
+ "SSH_DSS",
+ "SSH_RSA",
+ "ECDSA_SHA2_NISTP256",
+ "ECDSA_SHA2_NISTP384",
+ "ECDSA_SHA2_NISTP521"
+ ],
+ "description": "Required. Format of this key's content.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown format. Do not use.",
+ "`ssh-dss` key format (see RFC4253).",
+ "`ssh-rsa` key format (see RFC4253).",
+ "`ecdsa-sha2-nistp256` key format (see RFC5656).",
+ "`ecdsa-sha2-nistp384` key format (see RFC5656).",
+ "`ecdsa-sha2-nistp521` key format (see RFC5656)."
+ ]
+ },
+ "name": {
+ "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.\n`{owner_email}` is the email address of the user to whom the key belongs.\n`{environment_id}` is the identifier of the environment to which the key\ngrants access. `{key_id}` is the unique identifier of the key. For example,\n`users/someone@example.com/environments/default/publicKeys/myKey`.",
+ "type": "string"
+ },
+ "key": {
+ "description": "Required. Content of this key.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "PublicKey"
+ },
+ "CancelOperationRequest": {
+ "id": "CancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {}
},
"StartEnvironmentMetadata": {
"description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
"type": "object",
"properties": {
"state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "STARTING",
- "UNARCHIVING_DISK",
- "FINISHED"
- ],
- "description": "Current state of the environment being started.",
"type": "string",
"enumDescriptions": [
"The environment's start state is unknown.",
"The environment is in the process of being started, but no additional\ndetails are available.",
"Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.",
"Startup is complete and the user should be able to establish an SSH\nconnection to their environment."
- ]
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "STARTING",
+ "UNARCHIVING_DISK",
+ "FINISHED"
+ ],
+ "description": "Current state of the environment being started."
}
},
"id": "StartEnvironmentMetadata"
},
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ },
+ "description": "A list of operations that matches the specified filter in the request."
+ }
+ },
+ "id": "ListOperationsResponse"
+ },
"Operation": {
+ "type": "object",
"properties": {
"response": {
"additionalProperties": {
@@ -302,31 +352,20 @@
}
},
"id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
- },
- "ListOperationsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
},
"Environment": {
+ "id": "Environment",
"description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".",
"type": "object",
"properties": {
+ "publicKeys": {
+ "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.",
+ "type": "array",
+ "items": {
+ "$ref": "PublicKey"
+ }
+ },
"dockerImage": {
"description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".",
"type": "string"
@@ -356,9 +395,9 @@
"type": "string"
},
"sshPort": {
+ "type": "integer",
"description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"id": {
"description": "Output only. The environment's identifier, which is always \"default\".",
@@ -367,36 +406,13 @@
"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"
- },
- "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"
+ }
},
"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",
@@ -412,56 +428,40 @@
"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": {
+ "StartEnvironmentResponse": {
"properties": {
- "name": {
- "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.\n`{owner_email}` is the email address of the user to whom the key belongs.\n`{environment_id}` is the identifier of the environment to which the key\ngrants access. `{key_id}` is the unique identifier of the key. For example,\n`users/someone@example.com/environments/default/publicKeys/myKey`.",
- "type": "string"
- },
- "key": {
- "description": "Required. Content of this key.",
- "format": "byte",
- "type": "string"
- },
- "format": {
- "enum": [
- "FORMAT_UNSPECIFIED",
- "SSH_DSS",
- "SSH_RSA",
- "ECDSA_SHA2_NISTP256",
- "ECDSA_SHA2_NISTP384",
- "ECDSA_SHA2_NISTP521"
- ],
- "description": "Required. Format of this key's content.",
- "type": "string",
- "enumDescriptions": [
- "Unknown format. Do not use.",
- "`ssh-dss` key format (see RFC4253).",
- "`ssh-rsa` key format (see RFC4253).",
- "`ecdsa-sha2-nistp256` key format (see RFC5656).",
- "`ecdsa-sha2-nistp384` key format (see RFC5656).",
- "`ecdsa-sha2-nistp521` key format (see RFC5656)."
- ]
+ "environment": {
+ "description": "Environment that was started.",
+ "$ref": "Environment"
}
},
- "id": "PublicKey",
- "description": "A public SSH key, corresponding to a private SSH key held by the client.",
- "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 `{}`.",
+ "id": "StartEnvironmentResponse",
+ "description": "Message included in the response field of operations returned from\nStartEnvironment once the\noperation is complete.",
"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"
+ "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"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://cloudshell.googleapis.com/"
}
diff --git a/cloudshell/v1alpha1/cloudshell-api.json b/cloudshell/v1alpha1/cloudshell-api.json
index a745915..ffc3d66 100644
--- a/cloudshell/v1alpha1/cloudshell-api.json
+++ b/cloudshell/v1alpha1/cloudshell-api.json
@@ -1,4 +1,6 @@
{
+ "fullyEncodeReservedExpansion": true,
+ "title": "Cloud Shell API",
"ownerName": "Google",
"resources": {
"users": {
@@ -6,57 +8,57 @@
"environments": {
"methods": {
"start": {
- "request": {
- "$ref": "StartEnvironmentRequest"
- },
- "description": "Starts an existing environment, allowing clients to connect to it. The\nreturned operation will contain an instance of StartEnvironmentMetadata in\nits metadata field. Users can wait for the environment to start by polling\nthis operation via GetOperation. Once the environment has finished starting\nand is ready to accept connections, the operation will contain a\nStartEnvironmentResponse in its response field.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Operation"
},
- "parameters": {
- "name": {
- "pattern": "^users/[^/]+/environments/[^/]+$",
- "location": "path",
- "description": "Name of the resource that should be started, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}:start",
- "id": "cloudshell.users.environments.start",
- "path": "v1alpha1/{+name}:start"
- },
- "get": {
- "response": {
- "$ref": "Environment"
- },
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
- "pattern": "^users/[^/]+/environments/[^/]+$",
- "location": "path",
- "description": "Name of the requested resource, for example `users/me/environments/default`\nor `users/someone@example.com/environments/default`.",
+ "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"
+ }
+ },
+ "get": {
+ "description": "Gets an environment. Returns NOT_FOUND if the environment does not exist.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Environment"
+ },
+ "parameters": {
+ "name": {
+ "description": "Name of the requested resource, for example `users/me/environments/default`\nor `users/someone@example.com/environments/default`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+/environments/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}",
- "path": "v1alpha1/{+name}",
"id": "cloudshell.users.environments.get",
- "description": "Gets an environment. Returns NOT_FOUND if the environment does not exist."
+ "path": "v1alpha1/{+name}"
},
"patch": {
"response": {
@@ -66,37 +68,68 @@
"name"
],
"httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "description": "Mask specifying which fields in the environment should be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "pattern": "^users/[^/]+/environments/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource to be updated, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.",
+ "required": true,
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Mask specifying which fields in the environment should be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "description": "Name of the resource to be updated, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+/environments/[^/]+$",
- "location": "path"
- }
- },
"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."
}
},
"resources": {
"publicKeys": {
"methods": {
+ "create": {
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys",
+ "path": "v1alpha1/{+parent}/publicKeys",
+ "id": "cloudshell.users.environments.publicKeys.create",
+ "description": "Adds a public SSH key to an environment, allowing clients with the\ncorresponding private key to connect to that environment via SSH. If a key\nwith the same format and content already exists, this will return the\nexisting key.",
+ "request": {
+ "$ref": "CreatePublicKeyRequest"
+ },
+ "response": {
+ "$ref": "PublicKey"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^users/[^/]+/environments/[^/]+$",
+ "location": "path",
+ "description": "Parent resource name, e.g. `users/me/environments/default`.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
"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.",
"response": {
"$ref": "Empty"
},
@@ -116,38 +149,7 @@
"location": "path"
}
},
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys/{publicKeysId}",
- "path": "v1alpha1/{+name}",
- "id": "cloudshell.users.environments.publicKeys.delete",
- "description": "Removes a public SSH key from an environment. Clients will no longer be\nable to connect to the environment using the corresponding private key."
- },
- "create": {
- "response": {
- "$ref": "PublicKey"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^users/[^/]+/environments/[^/]+$",
- "location": "path",
- "description": "Parent resource name, e.g. `users/me/environments/default`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys",
- "path": "v1alpha1/{+parent}/publicKeys",
- "id": "cloudshell.users.environments.publicKeys.create",
- "description": "Adds a public SSH key to an environment, allowing clients with the\ncorresponding private key to connect to that environment via SSH. If a key\nwith the same format and content already exists, this will return the\nexisting key.",
- "request": {
- "$ref": "CreatePublicKeyRequest"
- }
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys/{publicKeysId}"
}
}
}
@@ -157,41 +159,10 @@
}
},
"parameters": {
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "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": {
"description": "Returns response with indentations and line breaks.",
@@ -199,28 +170,28 @@
"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"
},
+ "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"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
},
"callback": {
"description": "JSONP",
@@ -242,13 +213,44 @@
"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": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
}
},
"version": "v1alpha1",
"baseUrl": "https://cloudshell.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n",
"servicePath": "",
+ "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n",
+ "kind": "discovery#restDescription",
"basePath": "",
"revision": "20180118",
"documentationLink": "https://cloud.google.com/shell/docs/",
@@ -256,17 +258,97 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "StartEnvironmentResponse": {
+ "description": "Message included in the response field of operations returned from\nStartEnvironment once the\noperation is complete.",
+ "type": "object",
+ "properties": {
+ "environment": {
+ "description": "Environment that was started.",
+ "$ref": "Environment"
+ }
+ },
+ "id": "StartEnvironmentResponse"
+ },
+ "Status": {
+ "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"
+ },
+ "StartEnvironmentRequest": {
+ "description": "Request message for StartEnvironment.",
+ "type": "object",
+ "properties": {},
+ "id": "StartEnvironmentRequest"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "PublicKey": {
+ "description": "A public SSH key, corresponding to a private SSH key held by the client.",
+ "type": "object",
+ "properties": {
+ "format": {
+ "enumDescriptions": [
+ "Unknown format. Do not use.",
+ "`ssh-dss` key format (see RFC4253).",
+ "`ssh-rsa` key format (see RFC4253).",
+ "`ecdsa-sha2-nistp256` key format (see RFC5656).",
+ "`ecdsa-sha2-nistp384` key format (see RFC5656).",
+ "`ecdsa-sha2-nistp521` key format (see RFC5656)."
+ ],
+ "enum": [
+ "FORMAT_UNSPECIFIED",
+ "SSH_DSS",
+ "SSH_RSA",
+ "ECDSA_SHA2_NISTP256",
+ "ECDSA_SHA2_NISTP384",
+ "ECDSA_SHA2_NISTP521"
+ ],
+ "description": "Required. Format of this key's content.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.\n`{owner_email}` is the email address of the user to whom the key belongs.\n`{environment_id}` is the identifier of the environment to which the key\ngrants access. `{key_id}` is the unique identifier of the key. For example,\n`users/someone@example.com/environments/default/publicKeys/myKey`.",
+ "type": "string"
+ },
+ "key": {
+ "description": "Required. Content of this key.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "PublicKey"
+ },
"StartEnvironmentMetadata": {
"description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
"type": "object",
"properties": {
"state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "STARTING",
- "UNARCHIVING_DISK",
- "FINISHED"
- ],
"description": "Current state of the environment being started.",
"type": "string",
"enumDescriptions": [
@@ -274,6 +356,12 @@
"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"
]
}
},
@@ -302,12 +390,12 @@
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
+ }
}
},
"id": "Operation",
@@ -318,30 +406,6 @@
"description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".",
"type": "object",
"properties": {
- "state": {
- "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",
@@ -365,112 +429,50 @@
"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"
},
"CreatePublicKeyRequest": {
+ "description": "Request message for CreatePublicKey.",
+ "type": "object",
"properties": {
"key": {
"$ref": "PublicKey",
"description": "Key that should be added to the environment."
}
},
- "id": "CreatePublicKeyRequest",
- "description": "Request message for CreatePublicKey.",
- "type": "object"
- },
- "StartEnvironmentResponse": {
- "description": "Message included in the response field of operations returned from\nStartEnvironment once the\noperation is complete.",
- "type": "object",
- "properties": {
- "environment": {
- "$ref": "Environment",
- "description": "Environment that was started."
- }
- },
- "id": "StartEnvironmentResponse"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Status"
- },
- "StartEnvironmentRequest": {
- "properties": {},
- "id": "StartEnvironmentRequest",
- "description": "Request message for StartEnvironment.",
- "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"
- },
- "PublicKey": {
- "properties": {
- "name": {
- "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.\n`{owner_email}` is the email address of the user to whom the key belongs.\n`{environment_id}` is the identifier of the environment to which the key\ngrants access. `{key_id}` is the unique identifier of the key. For example,\n`users/someone@example.com/environments/default/publicKeys/myKey`.",
- "type": "string"
- },
- "key": {
- "description": "Required. Content of this key.",
- "format": "byte",
- "type": "string"
- },
- "format": {
- "enum": [
- "FORMAT_UNSPECIFIED",
- "SSH_DSS",
- "SSH_RSA",
- "ECDSA_SHA2_NISTP256",
- "ECDSA_SHA2_NISTP384",
- "ECDSA_SHA2_NISTP521"
- ],
- "description": "Required. Format of this key's content.",
- "type": "string",
- "enumDescriptions": [
- "Unknown format. Do not use.",
- "`ssh-dss` key format (see RFC4253).",
- "`ssh-rsa` key format (see RFC4253).",
- "`ecdsa-sha2-nistp256` key format (see RFC5656).",
- "`ecdsa-sha2-nistp384` key format (see RFC5656).",
- "`ecdsa-sha2-nistp521` key format (see RFC5656)."
- ]
- }
- },
- "id": "PublicKey",
- "description": "A public SSH key, corresponding to a private SSH key held by the client.",
- "type": "object"
+ "id": "CreatePublicKeyRequest"
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"canonicalName": "Cloud Shell",
"auth": {
@@ -485,7 +487,5 @@
"rootUrl": "https://cloudshell.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudshell",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Cloud Shell API"
+ "batchPath": "batch"
}
diff --git a/cloudtasks/v2beta2/cloudtasks-api.json b/cloudtasks/v2beta2/cloudtasks-api.json
index 501eb1d..e6d05bb 100644
--- a/cloudtasks/v2beta2/cloudtasks-api.json
+++ b/cloudtasks/v2beta2/cloudtasks-api.json
@@ -1,466 +1,814 @@
{
+ "rootUrl": "https://cloudtasks.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudtasks",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Cloud Tasks API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "resources": {
+ "queues": {
+ "methods": {
+ "delete": {
+ "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)\nbefore using this method.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists queues.\n\nQueues are returned in lexicographical order.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListQueuesResponse"
+ },
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "Required.\n\nThe location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `\u003c=, \u003c, \u003e=, \u003e, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs Filters](/logging/docs/view/advanced_filters).\n\nSample filter \"app_engine_http_target: *\".\n\nNote that using filters might cause fewer queues than the\nrequested_page size to be returned.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nnext_page_token returned\nfrom the previous call to ListQueues\nmethod. It is an error to switch the value of the\nfilter while iterating through pages.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size.\n\nThe maximum page size is 9800. If unspecified, the page size will\nbe the maximum. Fewer queues than requested might be returned,\neven if more queues exist; use the\nnext_page_token in the\nresponse to determine if more queues exist.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
+ "id": "cloudtasks.projects.locations.queues.list",
+ "path": "v2beta2/{+parent}/queues"
+ },
+ "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\nListLocations.",
+ "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)\nbefore using this method.",
+ "request": {
+ "$ref": "Queue"
+ }
+ },
+ "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/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:setIamPolicy",
+ "path": "v2beta2/{+resource}:setIamPolicy",
+ "id": "cloudtasks.projects.locations.queues.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy for a Queue. Replaces any existing\npolicy.\n\nNote: The Cloud Console does not check queue-level IAM permissions yet.\nProject-level permissions are required to use the Cloud Console.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.setIamPolicy`"
+ },
+ "resume": {
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path",
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume",
+ "path": "v2beta2/{+name}:resume",
+ "id": "cloudtasks.projects.locations.queues.resume",
+ "description": "Resume a queue.\n\nThis method resumes a queue after it has been\nPAUSED or\nDISABLED. The state of a queue is stored\nin the queue's state; after calling this method it\nwill be set to 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"
+ }
+ },
+ "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`",
+ "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"
+ },
+ "get": {
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required.\n\nThe resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
+ "path": "v2beta2/{+name}",
+ "id": "cloudtasks.projects.locations.queues.get",
+ "description": "Gets a queue."
+ },
+ "patch": {
+ "request": {
+ "$ref": "Queue"
+ },
+ "description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\nbefore using this method.",
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "description": "A mask used to specify which fields of the queue are being updated.\n\nIf empty, then all fields will be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "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 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 CreateQueue,\nafter which it becomes output only.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
+ "path": "v2beta2/{+name}",
+ "id": "cloudtasks.projects.locations.queues.patch"
+ },
+ "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"
+ },
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge",
+ "path": "v2beta2/{+name}:purge",
+ "id": "cloudtasks.projects.locations.queues.purge"
+ },
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on a Queue.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:testIamPermissions",
+ "id": "cloudtasks.projects.locations.queues.testIamPermissions",
+ "path": "v2beta2/{+resource}:testIamPermissions"
+ },
+ "pause": {
+ "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}:pause",
+ "path": "v2beta2/{+name}:pause",
+ "id": "cloudtasks.projects.locations.queues.pause",
+ "description": "Pauses the queue.\n\nIf a queue is paused then the system will stop dispatching tasks\nuntil the queue is resumed via\nResumeQueue. Tasks can still be added\nwhen the queue is paused. A queue is paused if its\nstate is PAUSED.",
+ "request": {
+ "$ref": "PauseQueueRequest"
+ }
+ }
+ },
+ "resources": {
+ "tasks": {
+ "methods": {
+ "list": {
+ "description": "Lists the tasks in a queue.\n\nBy default, only the BASIC view is retrieved\ndue to performance considerations;\nresponse_view controls the\nsubset of information which is returned.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListTasksResponse"
+ },
+ "parameters": {
+ "responseView": {
+ "location": "query",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is 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 FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
+ "type": "string"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sort order used for the query. The only fields supported for sorting\nare `schedule_time` and `pull_message.tag`. All results will be\nreturned in approximately ascending order. The default ordering is by\n`schedule_time`.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nnext_page_token returned\nfrom the previous call to ListTasks\nmethod.\n\nThe page token is valid for only 2 hours.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Requested page size. Fewer tasks than requested might be returned.\n\nThe maximum page size is 1000. If unspecified, the page size will\nbe the maximum. Fewer tasks than requested might be returned,\neven if more tasks exist; use\nnext_page_token in the\nresponse to determine if more tasks exist.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path",
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
+ "id": "cloudtasks.projects.locations.queues.tasks.list",
+ "path": "v2beta2/{+parent}/tasks"
+ },
+ "create": {
+ "response": {
+ "$ref": "Task"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
+ "path": "v2beta2/{+parent}/tasks",
+ "id": "cloudtasks.projects.locations.queues.tasks.create",
+ "description": "Creates a task and adds it to a queue.\n\nTo add multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.\n\nTasks cannot be updated after creation; there is no UpdateTask command.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n the maximum task size is 100KB.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n the maximum task size is 1MB.",
+ "request": {
+ "$ref": "CreateTaskRequest"
+ }
+ },
+ "run": {
+ "request": {
+ "$ref": "RunTaskRequest"
+ },
+ "description": "Forces a task to run now.\n\nThis command is meant to be used for manual debugging. For\nexample, 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 PAUSED.\n\nThe dispatched task is returned. That is, the task that is returned\ncontains the 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\nschedule_time will be reset to the time that\nRunTask was called plus the retry delay specified\nin the queue and task's RetryConfig.\n\nRunTask returns\nNOT_FOUND when it is called on a\ntask that has already succeeded or permanently\nfailed. FAILED_PRECONDITION\nis returned when RunTask is called on task\nthat is dispatched or already running.\n\nRunTask cannot be called on\npull tasks.",
+ "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}:run",
+ "id": "cloudtasks.projects.locations.queues.tasks.run",
+ "path": "v2beta2/{+name}:run"
+ },
+ "cancelLease": {
+ "id": "cloudtasks.projects.locations.queues.tasks.cancelLease",
+ "path": "v2beta2/{+name}:cancelLease",
+ "request": {
+ "$ref": "CancelLeaseRequest"
+ },
+ "description": "Cancel a pull task's lease.\n\nThe worker can use this method to cancel a task's lease by\nsetting its schedule_time to now. This will\nmake the task available to be leased to the next caller of\nLeaseTasks.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Task"
+ },
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease"
+ },
+ "acknowledge": {
+ "request": {
+ "$ref": "AcknowledgeTaskRequest"
+ },
+ "description": "Acknowledges a pull task.\n\nThe worker, that is, the entity that\nleased this task must call this method\nto indicate that the work associated with the task has finished.\n\nThe worker must acknowledge a task within the\nlease_duration or the lease\nwill expire and the task will become available to be leased\nagain. After the task is acknowledged, it will not be returned\nby a later LeaseTasks,\nGetTask, or\nListTasks.\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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:acknowledge",
+ "id": "cloudtasks.projects.locations.queues.tasks.acknowledge",
+ "path": "v2beta2/{+name}:acknowledge"
+ },
+ "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 the task's schedule_time.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Task"
+ },
+ "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"
+ }
+ },
+ "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"
+ },
+ "get": {
+ "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": {
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is 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 FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ]
+ }
+ },
+ "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",
+ "description": "Gets a task."
+ },
+ "lease": {
+ "description": "Leases tasks from a pull queue for\nlease_duration.\n\nThis method is invoked by the worker to obtain a lease. The\nworker must acknowledge the task via\nAcknowledgeTask after they have\nperformed the work associated with the task.\n\nThe payload is intended to store data that\nthe worker needs to perform the work associated with the task. To\nreturn the payloads in the response, set\nresponse_view to\nFULL.\n\nA maximum of 10 qps of LeaseTasks\nrequests are allowed per\nqueue. RESOURCE_EXHAUSTED\nis returned when this limit is\nexceeded. RESOURCE_EXHAUSTED\nis also returned when\nmax_tasks_dispatched_per_second\nis exceeded.",
+ "request": {
+ "$ref": "LeaseTasksRequest"
+ },
+ "response": {
+ "$ref": "LeaseTasksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:lease",
+ "path": "v2beta2/{+parent}/tasks:lease",
+ "id": "cloudtasks.projects.locations.queues.tasks.lease"
+ },
+ "delete": {
+ "description": "Deletes a task.\n\nA task can be deleted if it is scheduled or dispatched. A task\ncannot be deleted if it has completed successfully or permanently\nfailed.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "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"
+ }
+ },
+ "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.delete"
+ }
+ }
+ }
+ }
+ }
+ },
+ "methods": {
+ "list": {
+ "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": "v2beta2/projects/{projectsId}/locations",
+ "path": "v2beta2/{+name}/locations",
+ "id": "cloudtasks.projects.locations.list",
+ "description": "Lists information about the supported locations for this service."
+ },
+ "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}",
+ "path": "v2beta2/{+name}",
+ "id": "cloudtasks.projects.locations.get"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "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": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ },
+ "version": "v2beta2",
+ "baseUrl": "https://cloudtasks.googleapis.com/",
+ "servicePath": "",
+ "description": "Manages the execution of large numbers of distributed requests. Cloud Tasks is in Alpha.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "documentationLink": "https://cloud.google.com/cloud-tasks/",
+ "id": "cloudtasks:v2beta2",
+ "revision": "20180123",
+ "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ListTasksResponse": {
- "description": "Response message for listing tasks using ListTasks.",
- "type": "object",
+ "PullMessage": {
"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\nListTasks with this value as the\npage_token.\n\nIf the next_page_token is empty, there are no more results.",
- "type": "string"
- }
- },
- "id": "ListTasksResponse"
- },
- "CreateTaskRequest": {
- "description": "Request message for CreateTask.",
- "type": "object",
- "properties": {
- "task": {
- "$ref": "Task",
- "description": "Required.\n\nThe task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a task name. If a\nname is not specified then the system will generate a random\nunique task id, which will be set in the task returned in the\nresponse.\n\nIf schedule_time is not set or is in the\npast then Cloud Tasks 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 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 CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently."
- },
- "responseView": {
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is 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 FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask 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 the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
- "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue resource."
- ],
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ]
- }
- },
- "id": "CreateTaskRequest"
- },
- "LeaseTasksResponse": {
- "description": "Response message for leasing tasks using 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": {
- "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 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 unset 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\nhad no activity (method calls or task dispatches) for 30 days,\nthe queue may take a few minutes to re-activate. Some method\ncalls may return NOT_FOUND and\ntasks may not be dispatched for a few minutes until the queue\nhas 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 LeaseTasks calls will return a\nFAILED_PRECONDITION.",
- "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\nLeaseTasks calls return a\n`FAILED_PRECONDITION` error.\n\nTo permanently delete this queue and all of its tasks, call\nDeleteQueue."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "RUNNING",
- "PAUSED",
- "DISABLED"
- ],
- "description": "Output only. The state of the queue.\n\n`state` can only be changed by called\nPauseQueue,\nResumeQueue, or uploading\n[queue.yaml/xml](/appengine/docs/python/config/queueref).\nUpdateQueue 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 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 CreateQueue,\nafter which it becomes output only.",
- "type": "string"
- },
- "rateLimits": {
- "description": "Rate limits for task dispatches.\n\nrate_limits and\nretry_config are related because they both\ncontrol task attempts however they control how tasks are\nattempted in different ways:\n\n* rate_limits controls the total rate of\n dispatches from a queue (i.e. all traffic dispatched from the\n queue, regardless of whether the dispatch is from a first\n attempt or a retry).\n* retry_config controls what happens to\n particular a task after its first attempt fails. That is,\n retry_config controls task retries (the\n second attempt, third attempt, etc).",
- "$ref": "RateLimits"
- },
- "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."
- }
- },
- "id": "Queue"
- },
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- }
- },
- "id": "SetIamPolicyRequest"
- },
- "AppEngineRouting": {
- "description": "App Engine Routing.\n\nFor more information about services, versions, and instances see\n[An Overview of App Engine](/appengine/docs/python/an-overview-of-app-engine),\n[Microservices Architecture on Google App Engine](/appengine/docs/python/microservices-on-app-engine),\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed),\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).",
- "type": "object",
- "properties": {
- "version": {
- "description": "App version.\n\nBy default, the task is sent to the version which is the default\nversion when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine\nTask Queue API, host is not parsable\ninto service,\nversion, and\ninstance. For example, some tasks\nwhich were created using the App Engine SDK use a custom domain\nname; custom domains are not parsed by Cloud Tasks. If\nhost is not parsable, then\nservice,\nversion, and\ninstance are the empty string.",
- "type": "string"
- },
- "host": {
- "description": "Output only. The host that the task is sent to.\n\nFor more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed).\n\nThe host is constructed as:\n\n\n* `host = [application_domain_name]`\u003c/br\u003e\n `| [service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version_dot_service]+ '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`\n\n* `application_domain_name` = The domain name of the app, for\n example \u003capp-id\u003e.appspot.com, which is associated with the\n queue's project ID. Some tasks which were created using the App Engine\n SDK use a custom domain name.\n\n* `service =` service\n\n* `version =` version\n\n* `version_dot_service =`\n version `+ '.' +`\n service\n\n* `instance =` instance\n\n* `instance_dot_service =`\n instance `+ '.' +`\n service\n\n* `instance_dot_version =`\n instance `+ '.' +`\n version\n\n* `instance_dot_version_dot_service =`\n instance `+ '.' +`\n version `+ '.' +`\n service\n\nIf service is empty, then the task will be sent\nto the service which is the default service when the task is attempted.\n\nIf version is empty, then the task will be sent\nto the version which is the default version when the task is attempted.\n\nIf instance is empty, then the task\nwill be sent to an instance which is available when the task is\nattempted.\n\nWhen service is \"default\",\nversion is \"default\", and\ninstance is empty,\nhost is shortened to just the\n`application_domain_name`.\n\nIf service,\nversion, or\ninstance is invalid, then the task\nwill be sent to the default version of the default service when\nthe task is attempted.",
- "type": "string"
- },
- "service": {
- "description": "App service.\n\nBy default, the task is sent to the service which is the default\nservice when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine\nTask Queue API, host is not parsable\ninto service,\nversion, and\ninstance. For example, some tasks\nwhich were created using the App Engine SDK use a custom domain\nname; custom domains are not parsed by Cloud Tasks. If\nhost is not parsable, then\nservice,\nversion, and\ninstance are the empty string.",
- "type": "string"
- },
- "instance": {
- "description": "App instance.\n\nBy default, the task is sent to an instance which is available when\nthe task is attempted.\n\nRequests can only be sent to a specific instance if\n[manual scaling is used in App Engine Standard](/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).\nApp Engine Flex does not support instances. For more information, see\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed)\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).",
- "type": "string"
- }
- },
- "id": "AppEngineRouting"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "AppEngineHttpTarget": {
- "description": "App Engine HTTP target.\n\nThe task will be delivered to the App Engine application hostname\nspecified by its AppEngineHttpTarget and AppEngineHttpRequest.\nThe documentation for AppEngineHttpRequest explains how the\ntask's host URL is constructed.\n\nUsing AppEngineHttpTarget requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`",
- "type": "object",
- "properties": {
- "appEngineRoutingOverride": {
- "$ref": "AppEngineRouting",
- "description": "Overrides for the\ntask-level app_engine_routing.\n\nIf set, `app_engine_routing_override` is used for all tasks in\nthe queue, no matter what the setting is for the\ntask-level app_engine_routing."
- }
- },
- "id": "AppEngineHttpTarget"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "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"
- },
- "LeaseTasksRequest": {
- "description": "Request message for leasing tasks using 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\nresponse will contain only tasks whose\ntag is equal to `\u003cmy-tag\u003e`. `\u003cmy-tag\u003e` must be\nless than 500 characters.\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`\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).\n\nSDK compatibility: Although the SDK allows tags to be either\nstring or\n[bytes](/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),\nonly UTF-8 encoded tags can be used in Cloud Tasks. Tag which\naren't UTF-8 encoded can't be used in the\nfilter and the task's\ntag will be displayed as empty in Cloud Tasks.",
- "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": "\nAfter the worker has successfully finished the work associated\nwith the task, the worker must call via\nAcknowledgeTask before the\nschedule_time. Otherwise the task will be\nreturned to a later LeaseTasks call so\nthat another worker can retry it.\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 the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
- "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue 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 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 FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
- "type": "string"
- }
- },
- "id": "LeaseTasksRequest"
- },
- "AcknowledgeTaskRequest": {
- "description": "Request message for acknowledging a task using\nAcknowledgeTask.",
- "type": "object",
- "properties": {
- "scheduleTime": {
- "description": "Required.\n\nThe task's current schedule time, available in the\nschedule_time returned by\nLeaseTasks response or\nRenewLease response. This restriction is\nto ensure that your worker currently holds the lease.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "AcknowledgeTaskRequest"
- },
- "ListQueuesResponse": {
- "description": "Response message for ListQueues.",
- "type": "object",
- "properties": {
- "queues": {
- "description": "The list of queues.",
- "type": "array",
- "items": {
- "$ref": "Queue"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nListQueues with this value as the\npage_token.\n\nIf the next_page_token is empty, there are no more results.\n\nThe page token is valid for only 2 hours.",
- "type": "string"
- }
- },
- "id": "ListQueuesResponse"
- },
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
- "type": "object",
- "properties": {
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- },
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "payload": {
+ "description": "A data payload consumed by the worker to execute the task.",
"format": "byte",
"type": "string"
},
- "version": {
- "description": "Deprecated.",
- "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"
- },
- "CancelLeaseRequest": {
- "description": "Request message for canceling a lease using\nCancelLease.",
- "type": "object",
- "properties": {
- "scheduleTime": {
- "description": "Required.\n\nThe task's current schedule time, available in the\nschedule_time returned by\nLeaseTasks response or\nRenewLease response. This restriction is\nto ensure that your worker currently holds the lease.",
- "format": "google-datetime",
- "type": "string"
- },
- "responseView": {
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is 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 FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask 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 the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
- "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue resource."
- ],
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ]
- }
- },
- "id": "CancelLeaseRequest"
- },
- "AttemptStatus": {
- "description": "The status of a task attempt.",
- "type": "object",
- "properties": {
- "scheduleTime": {
- "description": "Output only. The time that this attempt was scheduled.\n\n`schedule_time` will be truncated to the nearest microsecond.",
- "format": "google-datetime",
- "type": "string"
- },
- "dispatchTime": {
- "description": "Output only. The time that this attempt was dispatched.\n\n`dispatch_time` will be truncated to the nearest microsecond.",
- "format": "google-datetime",
- "type": "string"
- },
- "responseTime": {
- "description": "Output only. The time that this attempt response was received.\n\n`response_time` will be truncated to the nearest microsecond.",
- "format": "google-datetime",
- "type": "string"
- },
- "responseStatus": {
- "description": "Output only. The response from the target for this attempt.\n\nIf the task has not been attempted or the task is currently running\nthen the response status is unset.",
- "$ref": "Status"
- }
- },
- "id": "AttemptStatus"
- },
- "RateLimits": {
- "description": "Rate limits.\n\nThis message determines the maximum rate that tasks can be dispatched by a\nqueue, regardless of whether the dispatch is a first task attempt or a retry.",
- "type": "object",
- "properties": {
- "maxTasksDispatchedPerSecond": {
- "description": "The maximum rate at which tasks are dispatched from this queue.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\n* For App Engine queues, the maximum allowed value is 500.\n* This field is output only for [pull queues](google.cloud.tasks.v2beta2.PullTarget). In\n addition to the `max_tasks_dispatched_per_second` limit, a\n maximum of 10 QPS of LeaseTasks\n requests are allowed per pull queue.\n\n\nThis field has the same meaning as\n[rate in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#rate).",
- "format": "double",
- "type": "number"
- },
- "maxBurstSize": {
- "description": "Output only. The max burst size.\n\nMax burst size limits how fast tasks in queue are processed when\nmany tasks are in the queue and the rate is high. This field\nallows the queue to have a high rate so processing starts shortly\nafter a task is enqueued, but still limits resource usage when\nmany tasks are enqueued in a short period of time.\n\nThe [token bucket](https://wikipedia.org/wiki/Token_Bucket)\nalgorithm is used to control the rate of task dispatches. Each\nqueue has a token bucket that holds tokens, up to the maximum\nspecified by `max_burst_size`. Each time a task is dispatched, a\ntoken is removed from the bucket. Tasks will be dispatched until\nthe queue's bucket runs out of tokens. The bucket will be\ncontinuously refilled with new tokens based on\nmax_tasks_dispatched_per_second.\n\nCloud Tasks will pick the value of `max_burst_size` based on the\nvalue of\nmax_tasks_dispatched_per_second.\n\nFor App Engine queues that were created or updated using\n`queue.yaml/xml`, `max_burst_size` is equal to\n[bucket_size](/appengine/docs/standard/python/config/queueref#bucket_size).\nSince `max_burst_size` is output only, if\nUpdateQueue is called on a queue\ncreated by `queue.yaml/xml`, `max_burst_size` will be reset based\non the value of\nmax_tasks_dispatched_per_second,\nregardless of whether\nmax_tasks_dispatched_per_second\nis updated.\n",
- "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\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\n\nThe maximum allowed value is 5,000. -1 indicates no limit.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\nThis field has the same meaning as\n[max_concurrent_requests in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#max_concurrent_requests).",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "RateLimits"
- },
- "PurgeQueueRequest": {
- "description": "Request message for PurgeQueue.",
- "type": "object",
- "properties": {},
- "id": "PurgeQueueRequest"
- },
- "PauseQueueRequest": {
- "description": "Request message for PauseQueue.",
- "type": "object",
- "properties": {},
- "id": "PauseQueueRequest"
- },
- "RunTaskRequest": {
- "description": "Request message for forcing a task to run now using\nRunTask.",
- "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 the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
- "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue 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 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 FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
+ "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\nlease tasks with the same tag using\nfilter. For example, if you want to\naggregate the events associated with a specific user once a day,\nyou 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 characters.\n\nSDK compatibility: Although the SDK allows tags to be either\nstring or [bytes](/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),\nonly UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8\nencoded, the tag will be empty when the task is returned by Cloud Tasks.",
"type": "string"
}
},
- "id": "RunTaskRequest"
- },
- "Task": {
- "description": "A unit of scheduled work.",
- "type": "object",
- "properties": {
- "appEngineHttpRequest": {
- "description": "App Engine HTTP request that is sent to the task's target. Can\nbe set only if\napp_engine_http_target is set\non the queue.\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 the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
- "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue resource."
- ],
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "Output only. The view specifies which subset of the Task has\nbeen returned.",
- "type": "string"
- },
- "pullMessage": {
- "description": "LeaseTasks to process the task. Can be\nset only if pull_target is set on the queue.\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 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 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 CreateTask.",
- "type": "string"
- }
- },
- "id": "Task"
+ "id": "PullMessage",
+ "description": "The pull message contains data that can be used by the caller of\nLeaseTasks to process the task.\n\nThis proto can only be used for tasks in a queue which has\npull_target set.",
+ "type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
@@ -479,32 +827,16 @@
"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"
},
- "PullMessage": {
- "description": "The pull message contains data that can be used by the caller of\nLeaseTasks to process the task.\n\nThis proto can only be used for tasks in a queue which has\npull_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\nlease tasks with the same tag using\nfilter. For example, if you want to\naggregate the events associated with a specific user once a day,\nyou 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 characters.\n\nSDK compatibility: Although the SDK allows tags to be either\nstring or [bytes](/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),\nonly UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8\nencoded, the tag will be empty when the task is returned by Cloud Tasks.",
- "type": "string"
- },
- "payload": {
- "description": "A data payload consumed by the worker to execute the task.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "PullMessage"
- },
"Binding": {
"description": "Associates `members` with a `role`.",
"type": "object",
@@ -558,23 +890,23 @@
"description": "Status of the task.",
"type": "object",
"properties": {
- "lastAttemptStatus": {
- "description": "Output only. The status of the task's last attempt.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).",
- "$ref": "AttemptStatus"
- },
"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 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"
+ "$ref": "AttemptStatus",
+ "description": "Output only. The status of the task's first attempt.\n\nOnly dispatch_time will be set.\nThe other AttemptStatus information is not retained by Cloud Tasks.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget)."
},
"attemptResponseCount": {
"description": "Output only. The number of attempts which have received a response.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).",
"format": "int32",
"type": "integer"
+ },
+ "lastAttemptStatus": {
+ "description": "Output only. The status of the task's last attempt.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).",
+ "$ref": "AttemptStatus"
}
},
"id": "TaskStatus"
@@ -584,10 +916,12 @@
"type": "object",
"properties": {
"appEngineRouting": {
- "description": "Task-level setting for App Engine routing.\n\nIf set,\napp_engine_routing_override\nis used for all tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing.",
- "$ref": "AppEngineRouting"
+ "$ref": "AppEngineRouting",
+ "description": "Task-level setting for App Engine routing.\n\nIf set,\napp_engine_routing_override\nis used for all tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing."
},
"httpMethod": {
+ "description": "The HTTP method to use for the request. The default is POST.\n\nThe app's request handler for the task's target URL must be able to handle\nHTTP requests with this http_method, otherwise the task attempt will fail\nwith error code 405 (Method Not Allowed). See\n[Writing a push task request handler](/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)\nand the documentation for the request handlers in the language your app is\nwritten in e.g.\n[Python Request Handler](/appengine/docs/python/tools/webapp/requesthandlerclass).",
+ "type": "string",
"enumDescriptions": [
"HTTP method unspecified",
"HTTP Post",
@@ -603,9 +937,7 @@
"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.",
@@ -626,9 +958,13 @@
},
"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.",
@@ -638,35 +974,19 @@
}
}
},
- "id": "TestIamPermissionsResponse"
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
},
"RetryConfig": {
- "description": "Retry config.\n\nThese settings determine how a failed task attempt is retried.",
- "type": "object",
"properties": {
- "maxBackoff": {
- "description": "A task will be [scheduled](Task.schedule_time) for retry between\nmin_backoff and\nmax_backoff duration after it fails,\nif the queue's RetryConfig specifies that the task should be\nretried.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\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/xml](/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\nretrying a failed task, measured from when the task was first\nattempted. Once `max_retry_duration` time has passed *and* the\ntask has been attempted max_attempts\ntimes, no further attempts will be made and the task will be\ndeleted.\n\nIf zero, then the task age is unlimited.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\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/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
- "format": "google-duration",
- "type": "string"
- },
- "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.",
+ "maxDoublings": {
+ "description": "The time between retries will double `max_doublings` times.\n\nA task's retry interval starts at\nmin_backoff, then doubles\n`max_doublings` times, then increases linearly, and finally\nretries retries at intervals of\nmax_backoff up to\nmax_attempts times.\n\nFor example, if min_backoff is 10s,\nmax_backoff is 300s, and\n`max_doublings` is 3, then the a task will first be retried in\n10s. The retry interval will double three times, and then\nincrease linearly by 2^3 * 10s. Finally, the task will retry at\nintervals of max_backoff until the\ntask has been attempted max_attempts\ntimes. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,\n240s, 300s, 300s, ....\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\nThis field has the same meaning as\n[max_doublings in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
"format": "int32",
"type": "integer"
},
- "maxDoublings": {
- "description": "The time between retries will double `max_doublings` times.\n\nA task's retry interval starts at\nmin_backoff, then doubles\n`max_doublings` times, then increases linearly, and finally\nretries retries at intervals of\nmax_backoff up to\nmax_attempts times.\n\nFor example, if min_backoff is 10s,\nmax_backoff is 300s, and\n`max_doublings` is 3, then the a task will first be retried in\n10s. The retry interval will double three times, and then\nincrease linearly by 2^3 * 10s. Finally, the task will retry at\nintervals of max_backoff until the\ntask has been attempted max_attempts\ntimes. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,\n240s, 300s, 300s, ....\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\nThis field has the same meaning as\n[max_doublings in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
+ "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"
},
@@ -678,9 +998,21 @@
"description": "A task will be [scheduled](Task.schedule_time) for retry between\nmin_backoff and\nmax_backoff duration after it fails,\nif the queue's RetryConfig specifies that the task should be\nretried.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\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/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
"format": "google-duration",
"type": "string"
+ },
+ "maxBackoff": {
+ "description": "A task will be [scheduled](Task.schedule_time) for retry between\nmin_backoff and\nmax_backoff duration after it fails,\nif the queue's RetryConfig specifies that the task should be\nretried.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\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/xml](/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\nretrying a failed task, measured from when the task was first\nattempted. Once `max_retry_duration` time has passed *and* the\ntask has been attempted max_attempts\ntimes, no further attempts will be made and the task will be\ndeleted.\n\nIf zero, then the task age is unlimited.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\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/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
+ "format": "google-duration",
+ "type": "string"
}
},
- "id": "RetryConfig"
+ "id": "RetryConfig",
+ "description": "Retry config.\n\nThese settings determine how a failed task attempt is retried.",
+ "type": "object"
},
"PullTarget": {
"description": "Pull target.",
@@ -689,10 +1021,471 @@
"id": "PullTarget"
},
"ResumeQueueRequest": {
+ "properties": {},
+ "id": "ResumeQueueRequest",
"description": "Request message for ResumeQueue.",
+ "type": "object"
+ },
+ "ListTasksResponse": {
+ "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\nListTasks with this value as the\npage_token.\n\nIf the next_page_token is empty, there are no more results.",
+ "type": "string"
+ }
+ },
+ "id": "ListTasksResponse",
+ "description": "Response message for listing tasks using ListTasks.",
+ "type": "object"
+ },
+ "CreateTaskRequest": {
+ "description": "Request message for CreateTask.",
+ "type": "object",
+ "properties": {
+ "responseView": {
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is 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 FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask 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 the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
+ "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue resource."
+ ],
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ]
+ },
+ "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 task name. If a\nname is not specified then the system will generate a random\nunique task id, which will be set in the task returned in the\nresponse.\n\nIf schedule_time is not set or is in the\npast then Cloud Tasks 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 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 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": {
+ "description": "Response message for leasing tasks using 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": {
+ "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 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 unset if the queue has never been purged.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "state": {
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "RUNNING",
+ "PAUSED",
+ "DISABLED"
+ ],
+ "description": "Output only. The state of the queue.\n\n`state` can only be changed by called\nPauseQueue,\nResumeQueue, or uploading\n[queue.yaml/xml](/appengine/docs/python/config/queueref).\nUpdateQueue cannot be used to change `state`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified state.",
+ "The queue is running. Tasks can be dispatched.\n\nIf the queue was created using Cloud Tasks and the queue has\nhad no activity (method calls or task dispatches) for 30 days,\nthe queue may take a few minutes to re-activate. Some method\ncalls may return NOT_FOUND and\ntasks may not be dispatched for a few minutes until the queue\nhas 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 LeaseTasks calls will return a\nFAILED_PRECONDITION.",
+ "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\nLeaseTasks calls return a\n`FAILED_PRECONDITION` error.\n\nTo permanently delete this queue and all of its tasks, call\nDeleteQueue."
+ ]
+ },
+ "retryConfig": {
+ "$ref": "RetryConfig",
+ "description": "Settings that determine the retry behavior.\n\n* For tasks created using Cloud Tasks: the queue-level retry settings\n apply to all tasks in the queue that were created using Cloud Tasks.\n Retry settings cannot be set on individual tasks.\n* For tasks created using the App Engine SDK: the queue-level retry\n settings apply to all tasks in the queue which do not have retry settings\n explicitly set on the task and were created by the App Engine SDK. See\n [App Engine documentation](/appengine/docs/standard/python/taskqueue/push/retrying-tasks)."
+ },
+ "name": {
+ "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n 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 CreateQueue,\nafter which it becomes output only.",
+ "type": "string"
+ },
+ "rateLimits": {
+ "$ref": "RateLimits",
+ "description": "Rate limits for task dispatches.\n\nrate_limits and\nretry_config are related because they both\ncontrol task attempts however they control how tasks are\nattempted in different ways:\n\n* rate_limits controls the total rate of\n dispatches from a queue (i.e. all traffic dispatched from the\n queue, regardless of whether the dispatch is from a first\n attempt or a retry).\n* retry_config controls what happens to\n particular a task after its first attempt fails. That is,\n retry_config controls task retries (the\n second attempt, third attempt, etc)."
+ },
+ "pullTarget": {
+ "$ref": "PullTarget",
+ "description": "Pull target.\n\nA pull queue is a queue that has a PullTarget."
+ }
+ },
+ "id": "Queue"
+ },
+ "SetIamPolicyRequest": {
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ }
+ },
+ "id": "SetIamPolicyRequest",
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object"
+ },
+ "AppEngineRouting": {
+ "properties": {
+ "version": {
+ "description": "App version.\n\nBy default, the task is sent to the version which is the default\nversion when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine\nTask Queue API, host is not parsable\ninto service,\nversion, and\ninstance. For example, some tasks\nwhich were created using the App Engine SDK use a custom domain\nname; custom domains are not parsed by Cloud Tasks. If\nhost is not parsable, then\nservice,\nversion, and\ninstance are the empty string.",
+ "type": "string"
+ },
+ "host": {
+ "description": "Output only. The host that the task is sent to.\n\nFor more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed).\n\nThe host is constructed as:\n\n\n* `host = [application_domain_name]`\u003c/br\u003e\n `| [service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version_dot_service]+ '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`\n\n* `application_domain_name` = The domain name of the app, for\n example \u003capp-id\u003e.appspot.com, which is associated with the\n queue's project ID. Some tasks which were created using the App Engine\n SDK use a custom domain name.\n\n* `service =` service\n\n* `version =` version\n\n* `version_dot_service =`\n version `+ '.' +`\n service\n\n* `instance =` instance\n\n* `instance_dot_service =`\n instance `+ '.' +`\n service\n\n* `instance_dot_version =`\n instance `+ '.' +`\n version\n\n* `instance_dot_version_dot_service =`\n instance `+ '.' +`\n version `+ '.' +`\n service\n\nIf service is empty, then the task will be sent\nto the service which is the default service when the task is attempted.\n\nIf version is empty, then the task will be sent\nto the version which is the default version when the task is attempted.\n\nIf instance is empty, then the task\nwill be sent to an instance which is available when the task is\nattempted.\n\nWhen service is \"default\",\nversion is \"default\", and\ninstance is empty,\nhost is shortened to just the\n`application_domain_name`.\n\nIf service,\nversion, or\ninstance is invalid, then the task\nwill be sent to the default version of the default service when\nthe task is attempted.",
+ "type": "string"
+ },
+ "service": {
+ "description": "App service.\n\nBy default, the task is sent to the service which is the default\nservice when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine\nTask Queue API, host is not parsable\ninto service,\nversion, and\ninstance. For example, some tasks\nwhich were created using the App Engine SDK use a custom domain\nname; custom domains are not parsed by Cloud Tasks. If\nhost is not parsable, then\nservice,\nversion, and\ninstance are the empty string.",
+ "type": "string"
+ },
+ "instance": {
+ "description": "App instance.\n\nBy default, the task is sent to an instance which is available when\nthe task is attempted.\n\nRequests can only be sent to a specific instance if\n[manual scaling is used in App Engine Standard](/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).\nApp Engine Flex does not support instances. For more information, see\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed)\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).",
+ "type": "string"
+ }
+ },
+ "id": "AppEngineRouting",
+ "description": "App Engine Routing.\n\nFor more information about services, versions, and instances see\n[An Overview of App Engine](/appengine/docs/python/an-overview-of-app-engine),\n[Microservices Architecture on Google App Engine](/appengine/docs/python/microservices-on-app-engine),\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed),\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).",
+ "type": "object"
+ },
+ "Empty": {
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
+ },
+ "AppEngineHttpTarget": {
+ "description": "App Engine HTTP target.\n\nThe task will be delivered to the App Engine application hostname\nspecified by its AppEngineHttpTarget and AppEngineHttpRequest.\nThe documentation for AppEngineHttpRequest explains how the\ntask's host URL is constructed.\n\nUsing AppEngineHttpTarget requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`",
+ "type": "object",
+ "properties": {
+ "appEngineRoutingOverride": {
+ "description": "Overrides for the\ntask-level app_engine_routing.\n\nIf set, `app_engine_routing_override` is used for all tasks in\nthe queue, no matter what the setting is for the\ntask-level app_engine_routing.",
+ "$ref": "AppEngineRouting"
+ }
+ },
+ "id": "AppEngineHttpTarget"
+ },
+ "Location": {
+ "properties": {
+ "locationId": {
+ "description": "The canonical id for this location. For example: `\"us-east1\"`.",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object"
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
+ "type": "string"
+ }
+ },
+ "id": "Location",
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object"
+ },
+ "LeaseTasksRequest": {
+ "properties": {
+ "responseView": {
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is 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 FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask 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 the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
+ "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue resource."
+ ]
+ },
+ "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\nresponse will contain only tasks whose\ntag is equal to `\u003cmy-tag\u003e`. `\u003cmy-tag\u003e` must be\nless than 500 characters.\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`\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).\n\nSDK compatibility: Although the SDK allows tags to be either\nstring or\n[bytes](/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),\nonly UTF-8 encoded tags can be used in Cloud Tasks. Tag which\naren't UTF-8 encoded can't be used in the\nfilter and the task's\ntag will be displayed as empty in Cloud Tasks.",
+ "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": "\nAfter the worker has successfully finished the work associated\nwith the task, the worker must call via\nAcknowledgeTask before the\nschedule_time. Otherwise the task will be\nreturned to a later LeaseTasks call so\nthat another worker can retry it.\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",
+ "description": "Request message for leasing tasks using LeaseTasks.",
+ "type": "object"
+ },
+ "AcknowledgeTaskRequest": {
+ "properties": {
+ "scheduleTime": {
+ "description": "Required.\n\nThe task's current schedule time, available in the\nschedule_time returned by\nLeaseTasks response or\nRenewLease response. This restriction is\nto ensure that your worker currently holds the lease.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "AcknowledgeTaskRequest",
+ "description": "Request message for acknowledging a task using\nAcknowledgeTask.",
+ "type": "object"
+ },
+ "ListQueuesResponse": {
+ "description": "Response message for ListQueues.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nListQueues with this value as the\npage_token.\n\nIf the next_page_token is empty, there are no more results.\n\nThe page token is valid for only 2 hours.",
+ "type": "string"
+ },
+ "queues": {
+ "description": "The list of queues.",
+ "type": "array",
+ "items": {
+ "$ref": "Queue"
+ }
+ }
+ },
+ "id": "ListQueuesResponse"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Location"
+ }
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "type": "object",
+ "properties": {
+ "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": {
+ "properties": {
+ "scheduleTime": {
+ "description": "Required.\n\nThe task's current schedule time, available in the\nschedule_time returned by\nLeaseTasks response or\nRenewLease response. This restriction is\nto ensure that your worker currently holds the lease.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "responseView": {
+ "enumDescriptions": [
+ "Unspecified. Defaults to BASIC.",
+ "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
+ "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue 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 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 FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
+ "type": "string"
+ }
+ },
+ "id": "CancelLeaseRequest",
+ "description": "Request message for canceling a lease using\nCancelLease.",
+ "type": "object"
+ },
+ "AttemptStatus": {
+ "description": "The status of a task attempt.",
+ "type": "object",
+ "properties": {
+ "responseTime": {
+ "description": "Output only. The time that this attempt response was received.\n\n`response_time` will be truncated to the nearest microsecond.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "responseStatus": {
+ "$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 unset."
+ },
+ "scheduleTime": {
+ "description": "Output only. The time that this attempt was scheduled.\n\n`schedule_time` will be truncated to the nearest microsecond.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "dispatchTime": {
+ "description": "Output only. The time that this attempt was dispatched.\n\n`dispatch_time` will be truncated to the nearest microsecond.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "AttemptStatus"
+ },
+ "RateLimits": {
+ "description": "Rate limits.\n\nThis message determines the maximum rate that tasks can be dispatched by a\nqueue, regardless of whether the dispatch is a first task attempt or a retry.",
+ "type": "object",
+ "properties": {
+ "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\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\n\nThe maximum allowed value is 5,000. -1 indicates no limit.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\nThis field has the same meaning as\n[max_concurrent_requests in queue.yaml/xml](/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 queue.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\n* For App Engine queues, the maximum allowed value is 500.\n* This field is output only for [pull queues](google.cloud.tasks.v2beta2.PullTarget). In\n addition to the `max_tasks_dispatched_per_second` limit, a\n maximum of 10 QPS of LeaseTasks\n requests are allowed per pull queue.\n\n\nThis field has the same meaning as\n[rate in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#rate).",
+ "format": "double",
+ "type": "number"
+ },
+ "maxBurstSize": {
+ "description": "Output only. The max burst size.\n\nMax burst size limits how fast tasks in queue are processed when\nmany tasks are in the queue and the rate is high. This field\nallows the queue to have a high rate so processing starts shortly\nafter a task is enqueued, but still limits resource usage when\nmany tasks are enqueued in a short period of time.\n\nThe [token bucket](https://wikipedia.org/wiki/Token_Bucket)\nalgorithm is used to control the rate of task dispatches. Each\nqueue has a token bucket that holds tokens, up to the maximum\nspecified by `max_burst_size`. Each time a task is dispatched, a\ntoken is removed from the bucket. Tasks will be dispatched until\nthe queue's bucket runs out of tokens. The bucket will be\ncontinuously refilled with new tokens based on\nmax_tasks_dispatched_per_second.\n\nCloud Tasks will pick the value of `max_burst_size` based on the\nvalue of\nmax_tasks_dispatched_per_second.\n\nFor App Engine queues that were created or updated using\n`queue.yaml/xml`, `max_burst_size` is equal to\n[bucket_size](/appengine/docs/standard/python/config/queueref#bucket_size).\nSince `max_burst_size` is output only, if\nUpdateQueue is called on a queue\ncreated by `queue.yaml/xml`, `max_burst_size` will be reset based\non the value of\nmax_tasks_dispatched_per_second,\nregardless of whether\nmax_tasks_dispatched_per_second\nis updated.\n",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "RateLimits"
+ },
+ "PauseQueueRequest": {
+ "description": "Request message for PauseQueue.",
"type": "object",
"properties": {},
- "id": "ResumeQueueRequest"
+ "id": "PauseQueueRequest"
+ },
+ "PurgeQueueRequest": {
+ "description": "Request message for PurgeQueue.",
+ "type": "object",
+ "properties": {},
+ "id": "PurgeQueueRequest"
+ },
+ "Task": {
+ "description": "A unit of scheduled work.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "pullMessage": {
+ "description": "LeaseTasks to process the task. Can be\nset only if pull_target is set on the queue.\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 lease_duration.\n\n`schedule_time` will be truncated to the nearest microsecond.",
+ "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 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 CreateTask.",
+ "type": "string"
+ },
+ "appEngineHttpRequest": {
+ "description": "App Engine HTTP request that is sent to the task's target. Can\nbe set only if\napp_engine_http_target is set\non the queue.\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 the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
+ "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue resource."
+ ],
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ]
+ }
+ },
+ "id": "Task"
+ },
+ "RunTaskRequest": {
+ "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 the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
+ "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue 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 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 FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
+ "type": "string"
+ }
+ },
+ "id": "RunTaskRequest",
+ "description": "Request message for forcing a task to run now using\nRunTask.",
+ "type": "object"
}
},
"protocol": "rest",
@@ -709,798 +1502,5 @@
}
}
}
- },
- "rootUrl": "https://cloudtasks.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudtasks",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Cloud Tasks API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The 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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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": {
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}",
- "path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.get",
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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"
- ]
- }
- },
- "resources": {
- "queues": {
- "methods": {
- "resume": {
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume",
- "path": "v2beta2/{+name}:resume",
- "id": "cloudtasks.projects.locations.queues.resume",
- "request": {
- "$ref": "ResumeQueueRequest"
- },
- "description": "Resume a queue.\n\nThis method resumes a queue after it has been\nPAUSED or\nDISABLED. The state of a queue is stored\nin the queue's state; after calling this method it\nwill be set to RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf).",
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "getIamPolicy": {
- "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": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
- }
- },
- "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": {
- "request": {
- "$ref": "Queue"
- },
- "description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\nbefore using this method.",
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "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 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 CreateQueue,\nafter which it becomes output only.",
- "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.patch"
- },
- "get": {
- "description": "Gets a queue.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Queue"
- },
- "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}",
- "id": "cloudtasks.projects.locations.queues.get",
- "path": "v2beta2/{+name}"
- },
- "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": {
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge",
- "id": "cloudtasks.projects.locations.queues.purge",
- "path": "v2beta2/{+name}:purge"
- },
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on a Queue.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:testIamPermissions",
- "id": "cloudtasks.projects.locations.queues.testIamPermissions",
- "path": "v2beta2/{+resource}:testIamPermissions"
- },
- "pause": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Queue"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "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 dispatching tasks\nuntil the queue is resumed via\nResumeQueue. Tasks can still be added\nwhen the queue is paused. A queue is paused if its\nstate is PAUSED."
- },
- "delete": {
- "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)\nbefore using this method.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
- "path": "v2beta2/{+parent}/queues",
- "id": "cloudtasks.projects.locations.queues.list",
- "description": "Lists queues.\n\nQueues are returned in lexicographical order.",
- "response": {
- "$ref": "ListQueuesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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 the\nnext_page_token in the\nresponse to determine if more queues exist.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "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": {
- "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",
- "location": "query"
- },
- "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\nnext_page_token returned\nfrom the previous call to ListQueues\nmethod. It is an error to switch the value of the\nfilter while iterating through pages.",
- "type": "string"
- }
- }
- },
- "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",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "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"
- }
- },
- "create": {
- "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)\nbefore using this method.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Queue"
- },
- "parameters": {
- "parent": {
- "description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\nListLocations.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "tasks": {
- "methods": {
- "list": {
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
- "path": "v2beta2/{+parent}/tasks",
- "id": "cloudtasks.projects.locations.queues.tasks.list",
- "description": "Lists the tasks in a queue.\n\nBy default, only the BASIC view is retrieved\ndue to performance considerations;\nresponse_view controls the\nsubset of information which is returned.",
- "response": {
- "$ref": "ListTasksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "responseView": {
- "location": "query",
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is 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 FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
- "type": "string"
- },
- "orderBy": {
- "location": "query",
- "description": "Sort order used for the query. The only fields supported for sorting\nare `schedule_time` and `pull_message.tag`. All results will be\nreturned in approximately ascending order. The default ordering is by\n`schedule_time`.",
- "type": "string"
- },
- "pageToken": {
- "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\nnext_page_token returned\nfrom the previous call to ListTasks\nmethod.\n\nThe page token is valid for only 2 hours.",
- "type": "string"
- },
- "pageSize": {
- "description": "Requested page size. Fewer tasks than requested might be returned.\n\nThe maximum page size is 1000. If unspecified, the page size will\nbe the maximum. Fewer tasks than requested might be returned,\neven if more tasks exist; use\nnext_page_token in the\nresponse to determine if more tasks exist.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "create": {
- "response": {
- "$ref": "Task"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
- "path": "v2beta2/{+parent}/tasks",
- "id": "cloudtasks.projects.locations.queues.tasks.create",
- "request": {
- "$ref": "CreateTaskRequest"
- },
- "description": "Creates a task and adds it to a queue.\n\nTo add multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.\n\nTasks cannot be updated after creation; there is no UpdateTask command.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n the maximum task size is 100KB.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n the maximum task size is 1MB."
- },
- "run": {
- "response": {
- "$ref": "Task"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:run",
- "path": "v2beta2/{+name}:run",
- "id": "cloudtasks.projects.locations.queues.tasks.run",
- "description": "Forces a task to run now.\n\nThis command is meant to be used for manual debugging. For\nexample, 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 PAUSED.\n\nThe dispatched task is returned. That is, the task that is returned\ncontains the 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\nschedule_time will be reset to the time that\nRunTask was called plus the retry delay specified\nin the queue and task's RetryConfig.\n\nRunTask returns\nNOT_FOUND when it is called on a\ntask that has already succeeded or permanently\nfailed. FAILED_PRECONDITION\nis returned when RunTask is called on task\nthat is dispatched or already running.\n\nRunTask cannot be called on\npull tasks.",
- "request": {
- "$ref": "RunTaskRequest"
- }
- },
- "cancelLease": {
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease",
- "path": "v2beta2/{+name}:cancelLease",
- "id": "cloudtasks.projects.locations.queues.tasks.cancelLease",
- "request": {
- "$ref": "CancelLeaseRequest"
- },
- "description": "Cancel a pull task's lease.\n\nThe worker can use this method to cancel a task's lease by\nsetting its schedule_time to now. This will\nmake the task available to be leased to the next caller of\nLeaseTasks.",
- "response": {
- "$ref": "Task"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "acknowledge": {
- "request": {
- "$ref": "AcknowledgeTaskRequest"
- },
- "description": "Acknowledges a pull task.\n\nThe worker, that is, the entity that\nleased this task must call this method\nto indicate that the work associated with the task has finished.\n\nThe worker must acknowledge a task within the\nlease_duration or the lease\nwill expire and the task will become available to be leased\nagain. After the task is acknowledged, it will not be returned\nby a later LeaseTasks,\nGetTask, or\nListTasks.\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": {
- "response": {
- "$ref": "Task"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$"
- }
- },
- "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",
- "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 the task's 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": {
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is 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 FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
- "type": "string",
- "location": "query",
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ]
- }
- },
- "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": {
- "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": "Leases tasks from a pull queue for\nlease_duration.\n\nThis method is invoked by the worker to obtain a lease. The\nworker must acknowledge the task via\nAcknowledgeTask after they have\nperformed the work associated with the task.\n\nThe payload is intended to store data that\nthe worker needs to perform the work associated with the task. To\nreturn the payloads in the response, set\nresponse_view to\nFULL.\n\nA maximum of 10 qps of LeaseTasks\nrequests are allowed per\nqueue. RESOURCE_EXHAUSTED\nis returned when this limit is\nexceeded. RESOURCE_EXHAUSTED\nis also returned when\nmax_tasks_dispatched_per_second\nis exceeded."
- },
- "delete": {
- "description": "Deletes a task.\n\nA task can be deleted if it is scheduled or dispatched. A task\ncannot be deleted if it has completed successfully or permanently\nfailed.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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}",
- "id": "cloudtasks.projects.locations.queues.tasks.delete",
- "path": "v2beta2/{+name}"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "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": {
- "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": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v2beta2",
- "baseUrl": "https://cloudtasks.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Manages the execution of large numbers of distributed requests. Cloud Tasks is in Alpha.",
- "servicePath": "",
- "basePath": "",
- "revision": "20180123",
- "documentationLink": "https://cloud.google.com/cloud-tasks/",
- "id": "cloudtasks:v2beta2",
- "discoveryVersion": "v1"
+ }
}
diff --git a/cloudtrace/v1/cloudtrace-api.json b/cloudtrace/v1/cloudtrace-api.json
index 005b701..a045bb0 100644
--- a/cloudtrace/v1/cloudtrace-api.json
+++ b/cloudtrace/v1/cloudtrace-api.json
@@ -1,250 +1,27 @@
{
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "patchTraces": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "projectId": {
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.append"
- ],
- "flatPath": "v1/projects/{projectId}/traces",
- "id": "cloudtrace.projects.patchTraces",
- "path": "v1/projects/{projectId}/traces",
- "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."
- }
- },
- "resources": {
- "traces": {
- "methods": {
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.readonly"
- ],
- "parameters": {
- "filter": {
- "description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
- "type": "string",
- "location": "query"
- },
- "endTime": {
- "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "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": {
- "location": "query",
- "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
- "format": "google-datetime",
- "type": "string"
- },
- "pageSize": {
- "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"
- },
- "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"
- }
- },
- "flatPath": "v1/projects/{projectId}/traces",
- "path": "v1/projects/{projectId}/traces",
- "id": "cloudtrace.projects.traces.list",
- "description": "Returns of a list of traces that match the specified filter conditions.",
- "response": {
- "$ref": "ListTracesResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET"
- },
- "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": {
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "traceId": {
- "location": "path",
- "description": "ID of the trace to return.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/traces/{traceId}",
- "path": "v1/projects/{projectId}/traces/{traceId}",
- "id": "cloudtrace.projects.traces.get"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://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": "20180118",
"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",
+ "Traces": {
"properties": {
+ "traces": {
+ "description": "List of traces.",
+ "type": "array",
+ "items": {
+ "$ref": "Trace"
+ }
+ }
+ },
+ "id": "Traces",
+ "description": "List of new or updated traces.",
+ "type": "object"
+ },
+ "TraceSpan": {
+ "properties": {
+ "name": {
+ "description": "Name of the span. Must be less than 128 bytes. The span name is sanitized\nand displayed in the Stackdriver Trace tool in the\n{% dynamic print site_values.console_name %}.\nThe name may be a method name or some other per-call site name.\nFor the same executable and the same call point, a best practice is\nto use a consistent name, which makes it easier to correlate\ncross-trace spans.",
+ "type": "string"
+ },
"spanId": {
"description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace.",
"format": "uint64",
@@ -285,18 +62,13 @@
},
"description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes (10MB for\n`/stacktrace` values).\n\nSome predefined label keys exist, or you may create your own. When creating\nyour own, we recommend the following formats:\n\n* `/category/product/key` for agents of well-known products (e.g.\n `/db/mongodb/read_size`).\n* `short_host/path/key` for domain-specific keys (e.g.\n `foo.com/myproduct/bar`)\n\nPredefined labels include:\n\n* `/agent`\n* `/component`\n* `/error/message`\n* `/error/name`\n* `/http/client_city`\n* `/http/client_country`\n* `/http/client_protocol`\n* `/http/client_region`\n* `/http/host`\n* `/http/method`\n* `/http/redirected_url`\n* `/http/request/size`\n* `/http/response/size`\n* `/http/status_code`\n* `/http/url`\n* `/http/user_agent`\n* `/pid`\n* `/stacktrace`\n* `/tid`",
"type": "object"
- },
- "name": {
- "description": "Name of the span. Must be less than 128 bytes. The span name is sanitized\nand displayed in the Stackdriver Trace tool in the\n{% dynamic print site_values.console_name %}.\nThe name may be a method name or some other per-call site name.\nFor the same executable and the same call point, a best practice is\nto use a consistent name, which makes it easier to correlate\ncross-trace spans.",
- "type": "string"
}
},
- "id": "TraceSpan"
+ "id": "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"
},
"ListTracesResponse": {
- "id": "ListTracesResponse",
- "description": "The response message for the `ListTraces` method.",
- "type": "object",
"properties": {
"traces": {
"description": "List of trace records returned.",
@@ -309,19 +81,23 @@
"description": "If defined, indicates that there are more traces that match the request\nand that this value should be passed to the next request to continue\nretrieving additional traces.",
"type": "string"
}
- }
+ },
+ "id": "ListTracesResponse",
+ "description": "The response message for the `ListTraces` method.",
+ "type": "object"
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
"properties": {},
- "id": "Empty"
+ "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"
},
"Trace": {
- "id": "Trace",
- "description": "A trace describes how long it takes for an application to perform an\noperation. It consists of a set of spans, each of which represent a single\ntimed event within the operation.",
- "type": "object",
"properties": {
+ "traceId": {
+ "description": "Globally unique identifier for the trace. This identifier is a 128-bit\nnumeric value formatted as a 32-byte hex string.",
+ "type": "string"
+ },
"projectId": {
"description": "Project ID of the Cloud project where the trace data is stored.",
"type": "string"
@@ -332,45 +108,30 @@
"items": {
"$ref": "TraceSpan"
}
- },
- "traceId": {
- "description": "Globally unique identifier for the trace. This identifier is a 128-bit\nnumeric value formatted as a 32-byte hex string.",
- "type": "string"
}
- }
- },
- "Traces": {
- "id": "Traces",
- "description": "List of new or updated traces.",
- "type": "object",
- "properties": {
- "traces": {
- "description": "List of traces.",
- "type": "array",
- "items": {
- "$ref": "Trace"
- }
- }
- }
+ },
+ "id": "Trace",
+ "description": "A trace describes how long it takes for an application to perform an\noperation. It consists of a set of spans, each of which represent a single\ntimed event within the operation.",
+ "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 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"
}
}
}
@@ -380,5 +141,244 @@
"name": "cloudtrace",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Trace API"
+ "title": "Stackdriver Trace API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ],
+ "parameters": {
+ "orderBy": {
+ "description": "Field used to sort the returned traces. Optional.\nCan be one of the following:\n\n* `trace_id`\n* `name` (`name` field of root span in the trace)\n* `duration` (difference between `end_time` and `start_time` fields of\n the root span)\n* `start` (`start_time` field of the root span)\n\nDescending order can be specified by appending `desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is permitted.",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the Cloud project where the trace data is stored.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/traces"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Trace"
+ },
+ "parameterOrder": [
+ "projectId",
+ "traceId"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "ID of the Cloud project where the trace data is stored.",
+ "required": true,
+ "type": "string"
+ },
+ "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}",
+ "id": "cloudtrace.projects.traces.get",
+ "path": "v1/projects/{projectId}/traces/{traceId}",
+ "description": "Gets a single trace by its ID."
+ }
+ }
+ }
+ },
+ "methods": {
+ "patchTraces": {
+ "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",
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "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"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://cloudtrace.googleapis.com/",
+ "servicePath": "",
+ "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API.\n",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "cloudtrace:v1",
+ "documentationLink": "https://cloud.google.com/trace",
+ "revision": "20180118"
}
diff --git a/cloudtrace/v2/cloudtrace-api.json b/cloudtrace/v2/cloudtrace-api.json
index 951ac6a..7e6d439 100644
--- a/cloudtrace/v2/cloudtrace-api.json
+++ b/cloudtrace/v2/cloudtrace-api.json
@@ -1,9 +1,4 @@
{
- "protocol": "rest",
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
"canonicalName": "Cloud Trace",
"auth": {
"oauth2": {
@@ -30,9 +25,6 @@
"traces": {
"methods": {
"batchWrite": {
- "flatPath": "v2/projects/{projectsId}/traces:batchWrite",
- "path": "v2/{+name}/traces:batchWrite",
- "id": "cloudtrace.projects.traces.batchWrite",
"request": {
"$ref": "BatchWriteSpansRequest"
},
@@ -56,31 +48,30 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append"
- ]
+ ],
+ "flatPath": "v2/projects/{projectsId}/traces:batchWrite",
+ "path": "v2/{+name}/traces:batchWrite",
+ "id": "cloudtrace.projects.traces.batchWrite"
}
},
"resources": {
"spans": {
"methods": {
"createSpan": {
- "request": {
- "$ref": "Span"
- },
- "description": "Creates a new span.",
- "response": {
- "$ref": "Span"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Span"
+ },
"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/[^/]+$",
- "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."
+ "pattern": "^projects/[^/]+/traces/[^/]+/spans/[^/]+$"
}
},
"scopes": [
@@ -88,8 +79,12 @@
"https://www.googleapis.com/auth/trace.append"
],
"flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}",
+ "id": "cloudtrace.projects.traces.spans.createSpan",
"path": "v2/{+name}",
- "id": "cloudtrace.projects.traces.spans.createSpan"
+ "request": {
+ "$ref": "Span"
+ },
+ "description": "Creates a new span."
}
}
}
@@ -99,78 +94,7 @@
}
},
"parameters": {
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "quotaUser": {
- "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": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "upload_protocol": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.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",
@@ -183,38 +107,392 @@
"json",
"media",
"proto"
+ ],
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
]
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
}
},
"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": "",
+ "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API.\n",
+ "kind": "discovery#restDescription",
"basePath": "",
- "revision": "20180118",
"documentationLink": "https://cloud.google.com/trace",
"id": "cloudtrace:v2",
+ "revision": "20180118",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Annotation": {
- "type": "object",
+ "Span": {
"properties": {
- "description": {
- "$ref": "TruncatableString",
- "description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes."
+ "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": {
+ "description": "An optional final status for this span.",
+ "$ref": "Status"
+ },
+ "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": {
+ "$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.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "The end time of the span. On the client side, this is the time kept by\nthe local machine where the span execution ends. On the server side, this\nis the time when the server application handler stops running.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The start time of the span. On the client side, this is the time kept by\nthe local machine where the span execution starts. On the server side, this\nis the time when the server's application handler starts running.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\n{% dynamic print site_values.console_name %}.\nFor example, the display name can be a qualified method name or a file name\nand a line number where the operation is called. A best practice is to use\nthe same display name within an application and at the same call point.\nThis makes it easier to correlate spans in different traces.",
+ "$ref": "TruncatableString"
+ },
+ "timeEvents": {
+ "$ref": "TimeEvents",
+ "description": "A set of time events. You can have up to 32 annotations and 128 message\nevents per span."
+ },
+ "links": {
+ "description": "Links associated with the span. You can have up to 128 links per Span.",
+ "$ref": "Links"
},
"attributes": {
"$ref": "Attributes",
- "description": "A set of attributes on the annotation. You can have up to 4 attributes\nper Annotation."
+ "description": "A set of attributes on the span. You can have up to 32 attributes per\nspan."
+ },
+ "spanId": {
+ "description": "The [SPAN_ID] portion of the span's resource name.",
+ "type": "string"
}
},
- "id": "Annotation",
- "description": "Text annotation with a set of attributes."
+ "id": "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"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "AttributeValue": {
+ "properties": {
+ "intValue": {
+ "description": "A 64-bit signed integer.",
+ "format": "int64",
+ "type": "string"
+ },
+ "stringValue": {
+ "description": "A string up to 256 bytes long.",
+ "$ref": "TruncatableString"
+ },
+ "boolValue": {
+ "description": "A Boolean value represented by `true` or `false`.",
+ "type": "boolean"
+ }
+ },
+ "id": "AttributeValue",
+ "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.",
+ "type": "object"
+ },
+ "Attributes": {
+ "description": "A set of attributes, each in the format `[KEY]:[VALUE]`.",
+ "type": "object",
+ "properties": {
+ "attributeMap": {
+ "additionalProperties": {
+ "$ref": "AttributeValue"
+ },
+ "description": "The set of attributes. Each attribute's key can be up to 128 bytes\nlong. The value can be a string up to 256 bytes, an integer, or the\nBoolean values `true` and `false`. For example:\n\n \"/instance_id\": \"my-instance\"\n \"/http/user_agent\": \"\"\n \"/http/request_bytes\": 300\n \"abc.com/myattribute\": true",
+ "type": "object"
+ },
+ "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.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Attributes"
+ },
+ "Links": {
+ "description": "A collection of links, which are references from this span to a span\nin the same or different trace.",
+ "type": "object",
+ "properties": {
+ "droppedLinksCount": {
+ "description": "The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "link": {
+ "description": "A collection of links.",
+ "type": "array",
+ "items": {
+ "$ref": "Link"
+ }
+ }
+ },
+ "id": "Links"
+ },
+ "StackTrace": {
+ "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",
+ "description": "A call stack appearing in a trace.",
+ "type": "object"
+ },
+ "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": {
+ "properties": {
+ "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"
+ },
+ "messageEvent": {
+ "description": "An event describing a message sent/received between Spans.",
+ "$ref": "MessageEvent"
+ }
+ },
+ "id": "TimeEvent",
+ "description": "A time-stamped annotation or message event in the Span.",
+ "type": "object"
+ },
+ "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": {
+ "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."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "SENT",
+ "RECEIVED"
+ ]
+ }
+ },
+ "id": "MessageEvent"
+ },
+ "StackFrame": {
+ "description": "Represents a single stack frame in a stack trace.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "The version of the deployed source code (up to 128 bytes).",
+ "$ref": "TruncatableString"
+ },
+ "originalFunctionName": {
+ "$ref": "TruncatableString",
+ "description": "An un-mangled function name, if `function_name` is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can\nbe fully-qualified (up to 1024 bytes)."
+ },
+ "functionName": {
+ "description": "The fully-qualified name that uniquely identifies the function or\nmethod that is active in this frame (up to 1024 bytes).",
+ "$ref": "TruncatableString"
+ },
+ "lineNumber": {
+ "description": "The line number in `file_name` where the function call appears.",
+ "format": "int64",
+ "type": "string"
+ },
+ "loadModule": {
+ "description": "The binary module from where the code was loaded.",
+ "$ref": "Module"
+ }
+ },
+ "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"
+ },
+ "attributes": {
+ "$ref": "Attributes",
+ "description": "A set of attributes on the link. You have have up to 32 attributes per\nlink."
+ },
+ "spanId": {
+ "description": "The [SPAN_ID] for a span within a trace.",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "The relationship of the two spans is unknown.",
+ "The linked span is a child of the current span.",
+ "The linked span is a parent of the current span."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "CHILD_LINKED_SPAN",
+ "PARENT_LINKED_SPAN"
+ ],
+ "description": "The relationship of the current span relative to the linked span.",
+ "type": "string"
+ }
+ },
+ "id": "Link"
+ },
+ "Annotation": {
+ "description": "Text annotation with a set of attributes.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes.",
+ "$ref": "TruncatableString"
+ },
+ "attributes": {
+ "description": "A set of attributes on the annotation. You can have up to 4 attributes\nper Annotation.",
+ "$ref": "Attributes"
+ }
+ },
+ "id": "Annotation"
},
"StackFrames": {
- "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.",
@@ -230,10 +508,10 @@
}
},
"id": "StackFrames",
- "description": "A collection of stack frames, which can be truncated."
+ "description": "A collection of stack frames, which can be truncated.",
+ "type": "object"
},
"TimeEvents": {
- "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.",
@@ -241,24 +519,23 @@
"type": "integer"
},
"droppedMessageEventsCount": {
- "type": "integer",
"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"
+ "format": "int32",
+ "type": "integer"
},
"timeEvent": {
+ "description": "A collection of `TimeEvent`s.",
"type": "array",
"items": {
"$ref": "TimeEvent"
- },
- "description": "A collection of `TimeEvent`s."
+ }
}
},
"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."
+ "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": {
- "description": "Binary module.",
- "type": "object",
"properties": {
"module": {
"$ref": "TruncatableString",
@@ -269,22 +546,14 @@
"description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes)."
}
},
- "id": "Module"
+ "id": "Module",
+ "description": "Binary module.",
+ "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",
@@ -293,308 +562,39 @@
"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."
+ "id": "Status"
},
"BatchWriteSpansRequest": {
"description": "The request message for the `BatchWriteSpans` method.",
"type": "object",
"properties": {
"spans": {
+ "description": "A list of new spans. The span names must not match existing\nspans, or the results are undefined.",
"type": "array",
"items": {
"$ref": "Span"
- },
- "description": "A list of new spans. The span names must not match existing\nspans, or the results are undefined."
+ }
}
},
"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": {
- "parentSpanId": {
- "description": "The [SPAN_ID] of this span's parent span. If this is a root span,\nthen this field must be empty.",
- "type": "string"
- },
- "endTime": {
- "type": "string",
- "description": "The end time of the span. On the client side, this is the time kept by\nthe local machine where the span execution ends. On the server side, this\nis the time when the server application handler stops running.",
- "format": "google-datetime"
- },
- "startTime": {
- "type": "string",
- "description": "The start time of the span. On the client side, this is the time kept by\nthe local machine where the span execution starts. On the server side, this\nis the time when the server's application handler starts running.",
- "format": "google-datetime"
- },
- "displayName": {
- "$ref": "TruncatableString",
- "description": "A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\n{% dynamic print site_values.console_name %}.\nFor example, the display name can be a qualified method name or a file name\nand a line number where the operation is called. A best practice is to use\nthe same display name within an application and at the same call point.\nThis makes it easier to correlate spans in different traces."
- },
- "timeEvents": {
- "$ref": "TimeEvents",
- "description": "A set of time events. You can have up to 32 annotations and 128 message\nevents per span."
- },
- "links": {
- "$ref": "Links",
- "description": "Links associated with the span. You can have up to 128 links per Span."
- },
- "attributes": {
- "$ref": "Attributes",
- "description": "A set of attributes on the span. You can have up to 32 attributes per\nspan."
- },
- "spanId": {
- "type": "string",
- "description": "The [SPAN_ID] portion of the span's resource name."
- },
- "childSpanCount": {
- "type": "integer",
- "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"
- },
- "sameProcessAsParentSpan": {
- "type": "boolean",
- "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."
- },
- "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": {
- "$ref": "StackTrace",
- "description": "Stack trace captured at the start of the span."
- }
- },
- "id": "Span"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "AttributeValue": {
- "type": "object",
- "properties": {
- "intValue": {
- "type": "string",
- "description": "A 64-bit signed integer.",
- "format": "int64"
- },
- "stringValue": {
- "$ref": "TruncatableString",
- "description": "A string up to 256 bytes long."
- },
- "boolValue": {
- "type": "boolean",
- "description": "A Boolean value represented by `true` or `false`."
- }
- },
- "id": "AttributeValue",
- "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute."
- },
- "Attributes": {
- "description": "A set of attributes, each in the format `[KEY]:[VALUE]`.",
- "type": "object",
- "properties": {
- "droppedAttributesCount": {
- "type": "integer",
- "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.",
- "format": "int32"
- },
- "attributeMap": {
- "type": "object",
- "additionalProperties": {
- "$ref": "AttributeValue"
- },
- "description": "The set of attributes. Each attribute's key can be up to 128 bytes\nlong. The value can be a string up to 256 bytes, an integer, or the\nBoolean values `true` and `false`. For example:\n\n \"/instance_id\": \"my-instance\"\n \"/http/user_agent\": \"\"\n \"/http/request_bytes\": 300\n \"abc.com/myattribute\": true"
- }
- },
- "id": "Attributes"
- },
- "Links": {
- "type": "object",
- "properties": {
- "link": {
- "description": "A collection of links.",
- "type": "array",
- "items": {
- "$ref": "Link"
- }
- },
- "droppedLinksCount": {
- "type": "integer",
- "description": "The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped.",
- "format": "int32"
- }
- },
- "id": "Links",
- "description": "A collection of links, which are references from this span to a span\nin the same or different trace."
- },
- "StackTrace": {
- "type": "object",
- "properties": {
- "stackTraceHashId": {
- "type": "string",
- "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"
- },
- "stackFrames": {
- "$ref": "StackFrames",
- "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed."
- }
- },
- "id": "StackTrace",
- "description": "A call stack appearing in a trace."
- },
- "TruncatableString": {
- "description": "Represents a string that might be shortened to a specified length.",
- "type": "object",
- "properties": {
- "truncatedByteCount": {
- "type": "integer",
- "description": "The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened.",
- "format": "int32"
- },
- "value": {
- "type": "string",
- "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."
- }
- },
- "id": "TruncatableString"
- },
- "TimeEvent": {
- "type": "object",
- "properties": {
- "annotation": {
- "$ref": "Annotation",
- "description": "Text annotation with a set of attributes."
- },
- "messageEvent": {
- "$ref": "MessageEvent",
- "description": "An event describing a message sent/received between Spans."
- },
- "time": {
- "type": "string",
- "description": "The timestamp indicating the time the event occurred.",
- "format": "google-datetime"
- }
- },
- "id": "TimeEvent",
- "description": "A time-stamped annotation or message event in the Span."
- },
- "MessageEvent": {
- "description": "An event describing a message sent/received between Spans.",
- "type": "object",
- "properties": {
- "compressedSizeBytes": {
- "type": "string",
- "description": "The number of compressed bytes sent or received. If missing assumed to\nbe the same size as uncompressed.",
- "format": "int64"
- },
- "uncompressedSizeBytes": {
- "type": "string",
- "description": "The number of uncompressed bytes sent or received.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "enumDescriptions": [
- "Unknown event type.",
- "Indicates a sent message.",
- "Indicates a received message."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "SENT",
- "RECEIVED"
- ],
- "description": "Type of MessageEvent. Indicates whether the message was sent or\nreceived."
- },
- "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"
- }
- },
- "id": "MessageEvent"
- },
- "StackFrame": {
- "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": {
- "$ref": "Module",
- "description": "The binary module from where the code was loaded."
- },
- "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": {
- "$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",
- "description": "Represents a single stack frame in a stack trace."
- },
- "Link": {
- "type": "object",
- "properties": {
- "type": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "CHILD_LINKED_SPAN",
- "PARENT_LINKED_SPAN"
- ],
- "description": "The relationship of the current span relative to the linked span.",
- "type": "string",
- "enumDescriptions": [
- "The relationship of the two spans is unknown.",
- "The linked span is a child of the current span.",
- "The linked span is a parent of the current span."
- ]
- },
- "traceId": {
- "description": "The [TRACE_ID] for a trace within a project.",
- "type": "string"
- },
- "attributes": {
- "$ref": "Attributes",
- "description": "A set of attributes on the link. You have have up to 32 attributes per\nlink."
- },
- "spanId": {
- "type": "string",
- "description": "The [SPAN_ID] for a span within a trace."
- }
- },
- "id": "Link",
- "description": "A pointer from the current span to another span in the same trace or in a\ndifferent trace. For example, this can be used in batching operations,\nwhere a single batch handler processes multiple requests from different\ntraces or when the handler receives a request from a different project."
}
+ },
+ "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/container/v1/container-api.json b/container/v1/container-api.json
index 2832814..92845d2 100644
--- a/container/v1/container-api.json
+++ b/container/v1/container-api.json
@@ -1,6 +1,1491 @@
{
+ "canonicalName": "Container",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://container.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "container",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Kubernetes Engine API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "zones": {
+ "resources": {
+ "clusters": {
+ "resources": {
+ "nodePools": {
+ "methods": {
+ "delete": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "id": "container.projects.zones.clusters.nodePools.delete",
+ "description": "Deletes a node pool from a cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.",
+ "required": true,
+ "type": "string"
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to delete.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "setSize": {
+ "request": {
+ "$ref": "SetNodePoolSizeRequest"
+ },
+ "description": "Sets the size 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": {
+ "description": "The name of the cluster to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
+ "id": "container.projects.zones.clusters.nodePools.setSize",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize"
+ },
+ "setManagement": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to update.",
+ "required": true,
+ "type": "string"
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool to update.",
+ "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"
+ }
+ },
+ "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"
+ }
+ },
+ "list": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "id": "container.projects.zones.clusters.nodePools.list",
+ "description": "Lists the node pools for a cluster.",
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "rollback": {
+ "id": "container.projects.zones.clusters.nodePools.rollback",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
+ "request": {
+ "$ref": "RollbackNodePoolUpgradeRequest"
+ },
+ "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to rollback.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to rollback.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback"
+ },
+ "create": {
+ "request": {
+ "$ref": "CreateNodePoolRequest"
+ },
+ "description": "Creates a node pool for a cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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.create"
+ },
+ "autoscaling": {
+ "description": "Sets the autoscaling settings of a specific node pool.",
+ "request": {
+ "$ref": "SetNodePoolAutoscalingRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
+ "id": "container.projects.zones.clusters.nodePools.autoscaling"
+ },
+ "get": {
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "id": "container.projects.zones.clusters.nodePools.get",
+ "description": "Retrieves the node pool requested.",
+ "response": {
+ "$ref": "NodePool"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "GET",
+ "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.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "flatPath": "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",
+ "id": "container.projects.zones.clusters.nodePools.update",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update"
+ }
+ }
+ }
+ },
+ "methods": {
+ "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": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "id": "container.projects.zones.clusters.completeIpRotation"
+ },
+ "get": {
+ "description": "Gets the details of a specific cluster.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to retrieve.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.get",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"
+ },
+ "legacyAbac": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
+ "id": "container.projects.zones.clusters.legacyAbac",
+ "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
+ "request": {
+ "$ref": "SetLegacyAbacRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to update.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "setNetworkPolicy": {
+ "id": "container.projects.zones.clusters.setNetworkPolicy",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ },
+ "description": "Enables/Disables Network Policy for a cluster.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy"
+ },
+ "startIpRotation": {
+ "description": "Start master IP rotation.",
+ "request": {
+ "$ref": "StartIPRotationRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "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}:startIpRotation",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
+ "id": "container.projects.zones.clusters.startIpRotation"
+ },
+ "addons": {
+ "description": "Sets the addons of a specific cluster.",
+ "request": {
+ "$ref": "SetAddonsConfigRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
+ "id": "container.projects.zones.clusters.addons"
+ },
+ "setMaintenancePolicy": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
+ "id": "container.projects.zones.clusters.setMaintenancePolicy",
+ "request": {
+ "$ref": "SetMaintenancePolicyRequest"
+ },
+ "description": "Sets the maintenance policy for a cluster."
+ },
+ "delete": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.delete",
+ "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "DELETE",
+ "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 delete.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "locations": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
+ "id": "container.projects.zones.clusters.locations",
+ "request": {
+ "$ref": "SetLocationsRequest"
+ },
+ "description": "Sets the locations of a specific cluster."
+ },
+ "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": {
+ "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}",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.update"
+ },
+ "monitoring": {
+ "id": "container.projects.zones.clusters.monitoring",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
+ "request": {
+ "$ref": "SetMonitoringServiceRequest"
+ },
+ "description": "Sets the monitoring service of a specific cluster.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring"
+ },
+ "master": {
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to 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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth"
+ },
+ "logging": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/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."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "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, or \"-\" for all zones.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.list",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters",
+ "description": "Lists all clusters owned by a project in either the specified zone or all\nzones."
+ },
+ "resourceLabels": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "id": "container.projects.zones.clusters.resourceLabels",
+ "description": "Sets labels on a cluster.",
+ "request": {
+ "$ref": "SetLabelsRequest"
+ }
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.create",
+ "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"
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "description": "Cancels the specified operation.",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "id": "container.projects.zones.operations.cancel"
+ },
+ "list": {
+ "description": "Lists all operations in a project in a specific zone or all zones.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations",
+ "id": "container.projects.zones.operations.list"
+ },
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "id": "container.projects.zones.operations.get",
+ "description": "Gets the specified operation."
+ }
+ }
+ }
+ },
+ "methods": {
+ "getServerconfig": {
+ "description": "Returns configuration info about the Kubernetes Engine service.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ServerConfig"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig",
+ "id": "container.projects.zones.getServerconfig",
+ "path": "v1/projects/{projectId}/zones/{zone}/serverconfig"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "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"
+ }
+ },
+ "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": "20180108",
+ "documentationLink": "https://cloud.google.com/container-engine/",
+ "id": "container:v1",
"discoveryVersion": "v1",
"schemas": {
+ "KubernetesDashboard": {
+ "description": "Configuration for the Kubernetes Dashboard.",
+ "type": "object",
+ "properties": {
+ "disabled": {
+ "description": "Whether the Kubernetes Dashboard is enabled for this cluster.",
+ "type": "boolean"
+ }
+ },
+ "id": "KubernetesDashboard"
+ },
+ "Operation": {
+ "description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.",
+ "type": "object",
+ "properties": {
+ "detail": {
+ "description": "Detailed operation progress, if available.",
+ "type": "string"
+ },
+ "targetLink": {
+ "description": "Server-defined URL for the target of the operation.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
+ },
+ "operationType": {
+ "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."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "CREATE_CLUSTER",
+ "DELETE_CLUSTER",
+ "UPGRADE_MASTER",
+ "UPGRADE_NODES",
+ "REPAIR_CLUSTER",
+ "UPDATE_CLUSTER",
+ "CREATE_NODE_POOL",
+ "DELETE_NODE_POOL",
+ "SET_NODE_POOL_MANAGEMENT",
+ "AUTO_REPAIR_NODES",
+ "AUTO_UPGRADE_NODES",
+ "SET_LABELS",
+ "SET_MASTER_AUTH",
+ "SET_NODE_POOL_SIZE",
+ "SET_NETWORK_POLICY",
+ "SET_MAINTENANCE_POLICY"
+ ]
+ },
+ "startTime": {
+ "description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The current status of the operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not set.",
+ "The operation has been created.",
+ "The operation is currently running.",
+ "The operation is done, either cancelled or completed.",
+ "The operation is aborting."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "DONE",
+ "ABORTING"
+ ]
+ },
+ "name": {
+ "description": "The server-assigned ID for the operation.",
+ "type": "string"
+ },
+ "statusMessage": {
+ "description": "If an error has occurred, a textual description of the error.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Server-defined URL for the resource.",
+ "type": "string"
+ }
+ },
+ "id": "Operation"
+ },
+ "MaintenanceWindow": {
+ "description": "MaintenanceWindow defines the maintenance window to be used for the cluster.",
+ "type": "object",
+ "properties": {
+ "dailyMaintenanceWindow": {
+ "$ref": "DailyMaintenanceWindow",
+ "description": "DailyMaintenanceWindow specifies a daily maintenance operation window."
+ }
+ },
+ "id": "MaintenanceWindow"
+ },
"RollbackNodePoolUpgradeRequest": {
"properties": {},
"id": "RollbackNodePoolUpgradeRequest",
@@ -8,8 +1493,6 @@
"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.",
@@ -28,7 +1511,9 @@
"type": "string"
}
},
- "id": "NetworkPolicy"
+ "id": "NetworkPolicy",
+ "description": "Configuration options for the NetworkPolicy feature.\nhttps://kubernetes.io/docs/concepts/services-networking/networkpolicies/",
+ "type": "object"
},
"UpdateMasterRequest": {
"properties": {
@@ -42,25 +1527,25 @@
"type": "object"
},
"ListOperationsResponse": {
+ "description": "ListOperationsResponse is the result of ListOperationsRequest.",
+ "type": "object",
"properties": {
- "missingZones": {
- "description": "If any zones are listed here, the list of operations returned\nmay be missing the operations from those zones.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"operations": {
"description": "A list of operations in the project in the specified zone.",
"type": "array",
"items": {
"$ref": "Operation"
}
+ },
+ "missingZones": {
+ "description": "If any zones are listed here, the list of operations returned\nmay be missing the operations from those zones.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
- "id": "ListOperationsResponse",
- "description": "ListOperationsResponse is the result of ListOperationsRequest.",
- "type": "object"
+ "id": "ListOperationsResponse"
},
"SetMonitoringServiceRequest": {
"properties": {
@@ -89,7 +1574,16 @@
"id": "CidrBlock"
},
"ServerConfig": {
+ "description": "Kubernetes Engine service configuration.",
+ "type": "object",
"properties": {
+ "validMasterVersions": {
+ "description": "List of valid master versions.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"defaultClusterVersion": {
"description": "Version of Kubernetes the service deploys by default.",
"type": "string"
@@ -111,18 +1605,9 @@
"items": {
"type": "string"
}
- },
- "validMasterVersions": {
- "description": "List of valid master versions.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
},
- "id": "ServerConfig",
- "description": "Kubernetes Engine service configuration.",
- "type": "object"
+ "id": "ServerConfig"
},
"NodeConfig": {
"description": "Parameters that describe the nodes in a cluster.",
@@ -200,13 +1685,13 @@
"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"
+ },
+ "autoUpgradeStartTime": {
+ "description": "[Output only] This field is set when upgrades are about to commence\nwith the approximate start time for the upgrades, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
}
},
"id": "AutoUpgradeOptions"
@@ -215,19 +1700,19 @@
"description": "ListClustersResponse is the result of ListClustersRequest.",
"type": "object",
"properties": {
- "missingZones": {
- "description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"clusters": {
"description": "A list of clusters in the project in the specified zone, or\nacross all ones.",
"type": "array",
"items": {
"$ref": "Cluster"
}
+ },
+ "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"
@@ -243,34 +1728,20 @@
},
"id": "HttpLoadBalancing"
},
- "SetMasterAuthRequest": {
+ "SetNetworkPolicyRequest": {
"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."
- ]
+ "networkPolicy": {
+ "$ref": "NetworkPolicy",
+ "description": "Configuration options for the NetworkPolicy feature."
}
},
- "id": "SetMasterAuthRequest",
- "description": "SetMasterAuthRequest updates the admin password of a cluster.",
+ "id": "SetNetworkPolicyRequest",
+ "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
"type": "object"
},
"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.",
@@ -287,83 +1758,39 @@
"type": "boolean"
}
},
- "id": "NodePoolAutoscaling",
- "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.",
- "type": "object"
+ "id": "NodePoolAutoscaling"
},
- "SetNetworkPolicyRequest": {
+ "SetMasterAuthRequest": {
"properties": {
- "networkPolicy": {
- "description": "Configuration options for the NetworkPolicy feature.",
- "$ref": "NetworkPolicy"
+ "update": {
+ "description": "A description of the update.",
+ "$ref": "MasterAuth"
+ },
+ "action": {
+ "description": "The exact form of action to be taken on the master auth.",
+ "type": "string",
+ "enumDescriptions": [
+ "Operation is unknown and will error out.",
+ "Set the password to a user generated value.",
+ "Generate a new password and set it to that.",
+ "Set the username. If an empty username is provided, basic authentication\nis disabled for the cluster. If a non-empty username is provided, basic\nauthentication is enabled, with either a provided password or a generated\none."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "SET_PASSWORD",
+ "GENERATE_PASSWORD",
+ "SET_USERNAME"
+ ]
}
},
- "id": "SetNetworkPolicyRequest",
- "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
+ "id": "SetMasterAuthRequest",
+ "description": "SetMasterAuthRequest updates the admin password of a cluster.",
"type": "object"
},
- "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": {
- "desiredNodeVersion": {
- "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.",
- "type": "string"
- },
- "desiredMasterVersion": {
- "description": "The Kubernetes version to change the master to. The only valid value is the\nlatest supported version. Use \"-\" to have the server automatically select\nthe latest version.",
- "type": "string"
- },
- "desiredMasterAuthorizedNetworksConfig": {
- "description": "Master authorized networks is a Beta feature.\nThe desired configuration options for master authorized networks feature.",
- "$ref": "MasterAuthorizedNetworksConfig"
- },
- "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"
- },
- "desiredImageType": {
- "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.",
- "type": "string"
- },
- "desiredAddonsConfig": {
- "description": "Configurations for the various addons available to run in the cluster.",
- "$ref": "AddonsConfig"
- },
- "desiredNodePoolId": {
- "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"
- }
- },
- "id": "ClusterUpdate"
- },
"IPAllocationPolicy": {
"description": "Configuration for controlling how IPs are allocated in the cluster.",
"type": "object",
"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"
- },
- "servicesIpv4CidrBlock": {
- "description": "The IP address range of the services IPs in this cluster. If blank, a range\nwill be automatically chosen with the default size.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
- "type": "string"
- },
- "clusterIpv4Cidr": {
- "description": "This field is deprecated, use cluster_ipv4_cidr_block.",
- "type": "string"
- },
"nodeIpv4Cidr": {
"description": "This field is deprecated, use node_ipv4_cidr_block.",
"type": "string"
@@ -395,10 +1822,68 @@
"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"
}
},
"id": "IPAllocationPolicy"
},
+ "ClusterUpdate": {
+ "description": "ClusterUpdate describes an update to the cluster. Exactly one update can\nbe applied to a cluster with each request, so at most one field can be\nprovided.",
+ "type": "object",
+ "properties": {
+ "desiredImageType": {
+ "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.",
+ "type": "string"
+ },
+ "desiredAddonsConfig": {
+ "$ref": "AddonsConfig",
+ "description": "Configurations for the various addons available to run in the cluster."
+ },
+ "desiredNodePoolId": {
+ "description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.",
+ "type": "string"
+ },
+ "desiredNodeVersion": {
+ "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.",
+ "type": "string"
+ },
+ "desiredMasterVersion": {
+ "description": "The Kubernetes version to change the master to. The only valid value is the\nlatest supported version. Use \"-\" to have the server automatically select\nthe latest version.",
+ "type": "string"
+ },
+ "desiredMasterAuthorizedNetworksConfig": {
+ "description": "Master authorized networks is a Beta feature.\nThe desired configuration options for master authorized networks feature.",
+ "$ref": "MasterAuthorizedNetworksConfig"
+ },
+ "desiredLocations": {
+ "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "desiredNodePoolAutoscaling": {
+ "description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool.",
+ "$ref": "NodePoolAutoscaling"
+ },
+ "desiredMonitoringService": {
+ "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
+ "type": "string"
+ }
+ },
+ "id": "ClusterUpdate"
+ },
"HorizontalPodAutoscaling": {
"description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
"type": "object",
@@ -410,6 +1895,24 @@
},
"id": "HorizontalPodAutoscaling"
},
+ "MasterAuthorizedNetworksConfig": {
+ "description": "Master authorized networks is a Beta feature.\nConfiguration options for the master authorized networks feature. Enabled\nmaster authorized networks will disallow all external traffic to access\nKubernetes master through HTTPS except traffic from the given CIDR blocks,\nGoogle Compute Engine Public IPs and Google Prod IPs.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Whether or not master authorized networks is enabled.",
+ "type": "boolean"
+ },
+ "cidrBlocks": {
+ "description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS.",
+ "type": "array",
+ "items": {
+ "$ref": "CidrBlock"
+ }
+ }
+ },
+ "id": "MasterAuthorizedNetworksConfig"
+ },
"SetNodePoolManagementRequest": {
"properties": {
"management": {
@@ -421,60 +1924,38 @@
"description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
"type": "object"
},
- "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": {
- "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"
- },
"SetNodePoolAutoscalingRequest": {
"description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.",
"type": "object",
"properties": {
"autoscaling": {
- "description": "Autoscaling configuration for the node pool.",
- "$ref": "NodePoolAutoscaling"
+ "$ref": "NodePoolAutoscaling",
+ "description": "Autoscaling configuration for the node pool."
}
},
"id": "SetNodePoolAutoscalingRequest"
},
"CreateClusterRequest": {
- "properties": {
- "cluster": {
- "description": "A [cluster\nresource](/container-engine/reference/rest/v1/projects.zones.clusters)",
- "$ref": "Cluster"
- }
- },
- "id": "CreateClusterRequest",
"description": "CreateClusterRequest creates a cluster.",
- "type": "object"
- },
- "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"
+ "cluster": {
+ "$ref": "Cluster",
+ "description": "A [cluster\nresource](/container-engine/reference/rest/v1/projects.zones.clusters)"
}
},
- "id": "UpdateNodePoolRequest"
+ "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.",
@@ -492,16 +1973,20 @@
},
"id": "AcceleratorConfig"
},
- "LegacyAbac": {
- "description": "Configuration for the legacy Attribute Based Access Control authorization\nmode.",
+ "UpdateNodePoolRequest": {
+ "description": "UpdateNodePoolRequests update a node pool's image and/or version.",
"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"
+ "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": "LegacyAbac"
+ "id": "UpdateNodePoolRequest"
},
"SetAddonsConfigRequest": {
"description": "SetAddonsConfigRequest sets the addons associated with the cluster.",
@@ -515,24 +2000,20 @@
"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"
+ "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": {
- "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": {
"description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
"$ref": "HorizontalPodAutoscaling"
@@ -544,11 +2025,17 @@
"kubernetesDashboard": {
"description": "Configuration for the Kubernetes Dashboard.",
"$ref": "KubernetesDashboard"
+ },
+ "networkPolicyConfig": {
+ "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes.",
+ "$ref": "NetworkPolicyConfig"
}
},
"id": "AddonsConfig"
},
"SetLocationsRequest": {
+ "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.",
@@ -558,11 +2045,11 @@
}
}
},
- "id": "SetLocationsRequest",
- "description": "SetLocationsRequest sets the locations of the cluster.",
- "type": "object"
+ "id": "SetLocationsRequest"
},
"SetNodePoolSizeRequest": {
+ "description": "SetNodePoolSizeRequest sets the size a node\npool.",
+ "type": "object",
"properties": {
"nodeCount": {
"description": "The desired node count for the pool.",
@@ -570,26 +2057,24 @@
"type": "integer"
}
},
- "id": "SetNodePoolSizeRequest",
- "description": "SetNodePoolSizeRequest sets the size a node\npool.",
- "type": "object"
+ "id": "SetNodePoolSizeRequest"
},
"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",
- "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"
+ "id": "NetworkPolicyConfig"
},
"UpdateClusterRequest": {
"properties": {
"update": {
- "$ref": "ClusterUpdate",
- "description": "A description of the update."
+ "description": "A description of the update.",
+ "$ref": "ClusterUpdate"
}
},
"id": "UpdateClusterRequest",
@@ -597,19 +2082,126 @@
"type": "object"
},
"Cluster": {
+ "description": "A Google Kubernetes Engine cluster.",
+ "type": "object",
"properties": {
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "maintenancePolicy": {
+ "description": "Configure the maintenance policy for this cluster.",
+ "$ref": "MaintenancePolicy"
+ },
+ "name": {
+ "description": "The name of this cluster. The name must be unique within this project\nand zone, and can be up to 40 characters with the following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.",
+ "type": "string"
+ },
+ "resourceLabels": {
+ "description": "The resource labels for the cluster to use to annotate any related\nGoogle Compute Engine resources.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "initialClusterVersion": {
+ "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.",
+ "type": "string"
+ },
"ipAllocationPolicy": {
- "description": "Configuration for cluster IP allocation.",
- "$ref": "IPAllocationPolicy"
+ "$ref": "IPAllocationPolicy",
+ "description": "Configuration for cluster IP allocation."
+ },
+ "legacyAbac": {
+ "$ref": "LegacyAbac",
+ "description": "Configuration for the legacy ABAC authorization mode."
},
"endpoint": {
"description": "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information.",
"type": "string"
},
- "legacyAbac": {
- "description": "Configuration for the legacy ABAC authorization mode.",
- "$ref": "LegacyAbac"
- },
"createTime": {
"description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
@@ -648,14 +2240,14 @@
"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"
},
+ "networkPolicy": {
+ "description": "Configuration options for the NetworkPolicy feature.",
+ "$ref": "NetworkPolicy"
+ },
"enableKubernetesAlpha": {
"description": "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. v1alpha1) and features that may not be production ready in\nthe kubernetes version of the master and nodes.\nThe cluster has no SLA for uptime and master/node upgrades are disabled.\nAlpha enabled clusters are automatically deleted thirty days after\ncreation.",
"type": "boolean"
@@ -663,116 +2255,9 @@
"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"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "masterAuthorizedNetworksConfig": {
- "$ref": "MasterAuthorizedNetworksConfig",
- "description": "Master authorized networks is a Beta feature.\nThe configuration options for master authorized networks feature."
- },
- "statusMessage": {
- "description": "[Output only] Additional information about the current status of this\ncluster, if available.",
- "type": "string"
- },
- "masterAuth": {
- "description": "The authentication information for accessing the master endpoint.",
- "$ref": "MasterAuth"
- },
- "currentMasterVersion": {
- "description": "[Output only] The current software version of the master endpoint.",
- "type": "string"
- },
- "nodeConfig": {
- "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": {
- "description": "Configurations for the various addons available to run in the cluster.",
- "$ref": "AddonsConfig"
- },
- "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"
- },
- "resourceLabels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The resource labels for the cluster to use to annotate any related\nGoogle Compute Engine resources.",
- "type": "object"
- },
- "maintenancePolicy": {
- "description": "Configure the maintenance policy for this cluster.",
- "$ref": "MaintenancePolicy"
- },
- "initialClusterVersion": {
- "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.",
- "type": "string"
}
},
- "id": "Cluster",
- "description": "A Google Kubernetes Engine cluster.",
- "type": "object"
+ "id": "Cluster"
},
"CreateNodePoolRequest": {
"properties": {
@@ -787,14 +2272,6 @@
},
"MasterAuth": {
"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"
@@ -810,6 +2287,14 @@
"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",
@@ -817,19 +2302,30 @@
"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"
+ },
+ "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",
- "description": "Time window specified for daily maintenance operations.",
- "type": "object"
+ "id": "DailyMaintenanceWindow"
+ },
+ "ClientCertificateConfig": {
+ "description": "Configuration for client certificates on the cluster.",
+ "type": "object",
+ "properties": {
+ "issueClientCertificate": {
+ "description": "Issue a client certificate.",
+ "type": "boolean"
+ }
+ },
+ "id": "ClientCertificateConfig"
},
"MaintenancePolicy": {
"description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
@@ -842,38 +2338,27 @@
},
"id": "MaintenancePolicy"
},
- "ClientCertificateConfig": {
- "properties": {
- "issueClientCertificate": {
- "description": "Issue a client certificate.",
- "type": "boolean"
- }
- },
- "id": "ClientCertificateConfig",
- "description": "Configuration for client certificates on the cluster.",
- "type": "object"
- },
"SetLoggingServiceRequest": {
+ "description": "SetLoggingServiceRequest sets the logging service of a cluster.",
+ "type": "object",
"properties": {
"loggingService": {
"description": "The logging service the cluster should use to write metrics.\nCurrently available options:\n\n* \"logging.googleapis.com\" - the Google Cloud Logging service\n* \"none\" - no metrics will be exported from the cluster",
"type": "string"
}
},
- "id": "SetLoggingServiceRequest",
- "description": "SetLoggingServiceRequest sets the logging service of a cluster.",
- "type": "object"
+ "id": "SetLoggingServiceRequest"
},
"SetMaintenancePolicyRequest": {
+ "description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.",
+ "type": "object",
"properties": {
"maintenancePolicy": {
"$ref": "MaintenancePolicy",
"description": "The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy."
}
},
- "id": "SetMaintenancePolicyRequest",
- "description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.",
- "type": "object"
+ "id": "SetMaintenancePolicyRequest"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
@@ -882,8 +2367,6 @@
"id": "Empty"
},
"ListNodePoolsResponse": {
- "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
- "type": "object",
"properties": {
"nodePools": {
"description": "A list of node pools for a cluster.",
@@ -893,7 +2376,9 @@
}
}
},
- "id": "ListNodePoolsResponse"
+ "id": "ListNodePoolsResponse",
+ "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
+ "type": "object"
},
"CompleteIPRotationRequest": {
"properties": {},
@@ -902,52 +2387,16 @@
"type": "object"
},
"StartIPRotationRequest": {
- "properties": {},
- "id": "StartIPRotationRequest",
"description": "StartIPRotationRequest creates a new IP for the cluster and then performs\na node upgrade on each node pool to point to the new IP.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "StartIPRotationRequest"
},
"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.",
- "The PROVISIONING state indicates the node pool is being created.",
- "The RUNNING state indicates the node pool has been created\nand is fully usable.",
- "The RUNNING_WITH_ERROR state indicates the node pool has been created\nand is partially usable. Some error state has occurred and some\nfunctionality may be impaired. Customer may need to reissue a request\nor trigger a new update.",
- "The RECONCILING state indicates that some work is actively being done on\nthe node pool, such as upgrading node software. Details can\nbe found in the `statusMessage` field.",
- "The STOPPING state indicates the node pool is being deleted.",
- "The ERROR state indicates the node pool may be unusable. Details\ncan be found in the `statusMessage` field."
- ]
- },
- "config": {
- "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"
- },
"autoscaling": {
- "$ref": "NodePoolAutoscaling",
- "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present."
+ "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present.",
+ "$ref": "NodePoolAutoscaling"
},
"initialNodeCount": {
"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.",
@@ -972,24 +2421,60 @@
"version": {
"description": "The version of the Kubernetes of this node.",
"type": "string"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Not set.",
+ "The PROVISIONING state indicates the node pool is being created.",
+ "The RUNNING state indicates the node pool has been created\nand is fully usable.",
+ "The RUNNING_WITH_ERROR state indicates the node pool has been created\nand is partially usable. Some error state has occurred and some\nfunctionality may be impaired. Customer may need to reissue a request\nor trigger a new update.",
+ "The RECONCILING state indicates that some work is actively being done on\nthe node pool, such as upgrading node software. Details can\nbe found in the `statusMessage` field.",
+ "The STOPPING state indicates the node pool is being deleted.",
+ "The ERROR state indicates the node pool may be unusable. Details\ncan be found in the `statusMessage` field."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PROVISIONING",
+ "RUNNING",
+ "RUNNING_WITH_ERROR",
+ "RECONCILING",
+ "STOPPING",
+ "ERROR"
+ ],
+ "description": "[Output only] The status of the nodes in this pool instance.",
+ "type": "string"
+ },
+ "config": {
+ "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"
}
},
- "id": "NodePool"
+ "id": "NodePool",
+ "description": "NodePool contains the name and configuration for a cluster's node pool.\nNode pools are a set of nodes (i.e. VM's), with a common configuration and\nspecification, under the control of the cluster master. They may have a set\nof Kubernetes labels applied to them, which may be used to reference them\nduring pod scheduling. They may also be resized up or down, to accommodate\nthe workload.",
+ "type": "object"
},
"SetLabelsRequest": {
"description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container\nEngine cluster, which will in turn set them for Google Compute Engine\nresources used by that cluster",
"type": "object",
"properties": {
+ "labelFingerprint": {
+ "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nKubernetes Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.",
+ "type": "string"
+ },
"resourceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "The labels to set for that cluster.",
"type": "object"
- },
- "labelFingerprint": {
- "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nKubernetes Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.",
- "type": "string"
}
},
"id": "SetLabelsRequest"
@@ -1018,1496 +2503,11 @@
"type": "object",
"properties": {},
"id": "CancelOperationRequest"
- },
- "KubernetesDashboard": {
- "properties": {
- "disabled": {
- "description": "Whether the Kubernetes Dashboard is enabled for this cluster.",
- "type": "boolean"
- }
- },
- "id": "KubernetesDashboard",
- "description": "Configuration for the Kubernetes Dashboard.",
- "type": "object"
- },
- "Operation": {
- "properties": {
- "selfLink": {
- "description": "Server-defined URL for the resource.",
- "type": "string"
- },
- "detail": {
- "description": "Detailed operation progress, if available.",
- "type": "string"
- },
- "targetLink": {
- "description": "Server-defined URL for the target of the operation.",
- "type": "string"
- },
- "endTime": {
- "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
- "type": "string"
- },
- "operationType": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "CREATE_CLUSTER",
- "DELETE_CLUSTER",
- "UPGRADE_MASTER",
- "UPGRADE_NODES",
- "REPAIR_CLUSTER",
- "UPDATE_CLUSTER",
- "CREATE_NODE_POOL",
- "DELETE_NODE_POOL",
- "SET_NODE_POOL_MANAGEMENT",
- "AUTO_REPAIR_NODES",
- "AUTO_UPGRADE_NODES",
- "SET_LABELS",
- "SET_MASTER_AUTH",
- "SET_NODE_POOL_SIZE",
- "SET_NETWORK_POLICY",
- "SET_MAINTENANCE_POLICY"
- ],
- "description": "The operation type.",
- "type": "string",
- "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": {
- "description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place.",
- "type": "string"
- },
- "status": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "PENDING",
- "RUNNING",
- "DONE",
- "ABORTING"
- ],
- "description": "The current status of the operation.",
- "type": "string",
- "enumDescriptions": [
- "Not set.",
- "The operation has been created.",
- "The operation is currently running.",
- "The operation is done, either cancelled or completed.",
- "The operation is aborting."
- ]
- },
- "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",
- "description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.",
- "type": "object"
- },
- "MaintenanceWindow": {
- "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"
}
},
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
- "canonicalName": "Container",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://container.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "container",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Kubernetes Engine API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "zones": {
- "methods": {
- "getServerconfig": {
- "response": {
- "$ref": "ServerConfig"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "zone": {
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.",
- "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"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig",
- "path": "v1/projects/{projectId}/zones/{zone}/serverconfig",
- "id": "container.projects.zones.getServerconfig",
- "description": "Returns configuration info about the Kubernetes Engine service."
- }
- },
- "resources": {
- "clusters": {
- "resources": {
- "nodePools": {
- "methods": {
- "rollback": {
- "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": {
- "description": "The name of the cluster to rollback.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to rollback.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
- "id": "container.projects.zones.clusters.nodePools.rollback",
- "path": "v1/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"
- }
- },
- "create": {
- "request": {
- "$ref": "CreateNodePoolRequest"
- },
- "description": "Creates a node pool for a cluster.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "id": "container.projects.zones.clusters.nodePools.create",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools"
- },
- "autoscaling": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "nodePoolId": {
- "description": "The name of the node pool to upgrade.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
- "id": "container.projects.zones.clusters.nodePools.autoscaling",
- "description": "Sets the autoscaling settings of a specific node pool.",
- "request": {
- "$ref": "SetNodePoolAutoscalingRequest"
- }
- },
- "get": {
- "id": "container.projects.zones.clusters.nodePools.get",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "description": "Retrieves the node pool requested.",
- "httpMethod": "GET",
- "response": {
- "$ref": "NodePool"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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}"
- },
- "update": {
- "description": "Updates the version and/or image type of a specific node pool.",
- "request": {
- "$ref": "UpdateNodePoolRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "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"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
- "id": "container.projects.zones.clusters.nodePools.update"
- },
- "setSize": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster to update.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to update.",
- "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"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
- "id": "container.projects.zones.clusters.nodePools.setSize",
- "description": "Sets the size of a specific node pool.",
- "request": {
- "$ref": "SetNodePoolSizeRequest"
- }
- },
- "setManagement": {
- "request": {
- "$ref": "SetNodePoolManagementRequest"
- },
- "description": "Sets the NodeManagement options for a node pool.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster to update.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "nodePoolId": {
- "description": "The name of the node pool to update.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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": {
- "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": {
- "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"
- },
- "nodePoolId": {
- "description": "The name of the node pool to delete.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}"
- },
- "list": {
- "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": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "type": "string"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "id": "container.projects.zones.clusters.nodePools.list",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools"
- }
- }
- }
- },
- "methods": {
- "addons": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to 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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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."
- },
- "setMaintenancePolicy": {
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
- "id": "container.projects.zones.clusters.setMaintenancePolicy",
- "request": {
- "$ref": "SetMaintenancePolicyRequest"
- },
- "description": "Sets the maintenance policy for a cluster.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to update.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster to delete.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.delete",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time."
- },
- "locations": {
- "request": {
- "$ref": "SetLocationsRequest"
- },
- "description": "Sets the locations of a specific cluster.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
- "id": "container.projects.zones.clusters.locations",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations"
- },
- "update": {
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.update",
- "description": "Updates the settings of a specific cluster.",
- "request": {
- "$ref": "UpdateClusterRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"
- },
- "monitoring": {
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
- "id": "container.projects.zones.clusters.monitoring",
- "request": {
- "$ref": "SetMonitoringServiceRequest"
- },
- "description": "Sets the monitoring service of a specific cluster.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring"
- },
- "master": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.",
- "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"
- }
- },
- "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": {
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
- "id": "container.projects.zones.clusters.setMasterAuth",
- "request": {
- "$ref": "SetMasterAuthRequest"
- },
- "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set the password.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth"
- },
- "logging": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
- "id": "container.projects.zones.clusters.logging",
- "description": "Sets the logging service of a specific cluster.",
- "request": {
- "$ref": "SetLoggingServiceRequest"
- }
- },
- "list": {
- "response": {
- "$ref": "ListClustersResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "GET",
- "parameters": {
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/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."
- },
- "resourceLabels": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "id": "container.projects.zones.clusters.resourceLabels",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "request": {
- "$ref": "SetLabelsRequest"
- },
- "description": "Sets labels on a cluster."
- },
- "create": {
- "path": "v1/projects/{projectId}/zones/{zone}/clusters",
- "id": "container.projects.zones.clusters.create",
- "request": {
- "$ref": "CreateClusterRequest"
- },
- "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters"
- },
- "completeIpRotation": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
- "id": "container.projects.zones.clusters.completeIpRotation",
- "description": "Completes master IP rotation.",
- "request": {
- "$ref": "CompleteIPRotationRequest"
- }
- },
- "get": {
- "id": "container.projects.zones.clusters.get",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "description": "Gets the details of a specific cluster.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster to retrieve.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"
- },
- "setNetworkPolicy": {
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
- "id": "container.projects.zones.clusters.setNetworkPolicy",
- "description": "Enables/Disables Network Policy for a cluster.",
- "request": {
- "$ref": "SetNetworkPolicyRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy"
- },
- "legacyAbac": {
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
- "id": "container.projects.zones.clusters.legacyAbac",
- "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
- "request": {
- "$ref": "SetLegacyAbacRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "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"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac"
- },
- "startIpRotation": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
- "id": "container.projects.zones.clusters.startIpRotation",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
- "description": "Start master IP rotation.",
- "request": {
- "$ref": "StartIPRotationRequest"
- }
- }
- }
- },
- "operations": {
- "methods": {
- "cancel": {
- "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
- "id": "container.projects.zones.operations.cancel",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Cancels the specified operation.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "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"
- },
- "operationId": {
- "location": "path",
- "description": "The server-assigned `name` of the operation.",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel"
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations",
- "path": "v1/projects/{projectId}/zones/{zone}/operations",
- "id": "container.projects.zones.operations.list",
- "description": "Lists all operations in a project in a specific zone or all zones."
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "operationId": {
- "location": "path",
- "description": "The server-assigned `name` of the operation.",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
- "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
- "id": "container.projects.zones.operations.get",
- "description": "Gets the specified operation."
- }
- }
- }
- }
- }
- }
- }
- },
- "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": {
- "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"
- },
- "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"
- },
- "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"
- }
- },
- "version": "v1",
- "baseUrl": "https://container.googleapis.com/",
- "servicePath": "",
- "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",
- "basePath": "",
- "revision": "20180108",
- "documentationLink": "https://cloud.google.com/container-engine/",
- "id": "container:v1"
+ "protocol": "rest"
}
diff --git a/container/v1beta1/container-api.json b/container/v1beta1/container-api.json
index a4fba68..5a6ff13 100644
--- a/container/v1beta1/container-api.json
+++ b/container/v1beta1/container-api.json
@@ -1,26 +1,2280 @@
{
+ "canonicalName": "Container",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://container.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "container",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Kubernetes Engine API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "zones": {
+ "methods": {
+ "getServerconfig": {
+ "description": "Returns configuration info about the Kubernetes Engine service.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "response": {
+ "$ref": "ServerConfig"
+ },
+ "parameters": {
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "name": {
+ "location": "query",
+ "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
+ "id": "container.projects.zones.getServerconfig",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig"
+ }
+ },
+ "resources": {
+ "clusters": {
+ "methods": {
+ "startIpRotation": {
+ "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"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "addons": {
+ "description": "Sets the addons of a specific cluster.",
+ "request": {
+ "$ref": "SetAddonsConfigRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
+ "id": "container.projects.zones.clusters.addons"
+ },
+ "setMaintenancePolicy": {
+ "description": "Sets the maintenance policy for a cluster.",
+ "request": {
+ "$ref": "SetMaintenancePolicyRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
+ "id": "container.projects.zones.clusters.setMaintenancePolicy"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "location": "query",
+ "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.delete",
+ "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time."
+ },
+ "locations": {
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
+ "id": "container.projects.zones.clusters.locations",
+ "request": {
+ "$ref": "SetLocationsRequest"
+ },
+ "description": "Sets the locations of a specific cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "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.",
+ "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"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "update": {
+ "description": "Updates the settings of a specific cluster.",
+ "request": {
+ "$ref": "UpdateClusterRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.update"
+ },
+ "monitoring": {
+ "request": {
+ "$ref": "SetMonitoringServiceRequest"
+ },
+ "description": "Sets the monitoring service of a specific cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "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.",
+ "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"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
+ "id": "container.projects.zones.clusters.monitoring"
+ },
+ "master": {
+ "description": "Updates the master of a specific cluster.",
+ "request": {
+ "$ref": "UpdateMasterRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\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}/master",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
+ "id": "container.projects.zones.clusters.master"
+ },
+ "setMasterAuth": {
+ "request": {
+ "$ref": "SetMasterAuthRequest"
+ },
+ "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
+ "id": "container.projects.zones.clusters.setMasterAuth",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth"
+ },
+ "logging": {
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
+ "id": "container.projects.zones.clusters.logging",
+ "request": {
+ "$ref": "SetLoggingServiceRequest"
+ },
+ "description": "Sets the logging service of a specific cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.",
+ "required": true,
+ "type": "string"
+ },
+ "parent": {
+ "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.list",
+ "description": "Lists all clusters owned by a project in either the specified zone or all\nzones."
+ },
+ "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": {
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "id": "container.projects.zones.clusters.resourceLabels"
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.create",
+ "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"
+ }
+ },
+ "completeIpRotation": {
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "id": "container.projects.zones.clusters.completeIpRotation",
+ "description": "Completes master IP rotation.",
+ "request": {
+ "$ref": "CompleteIPRotationRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Cluster"
+ },
+ "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": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.get",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "description": "Gets the details of a specific cluster."
+ },
+ "legacyAbac": {
+ "request": {
+ "$ref": "SetLegacyAbacRequest"
+ },
+ "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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.",
+ "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"
+ },
+ "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"
+ }
+ },
+ "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"
+ },
+ "setNetworkPolicy": {
+ "description": "Enables/Disables Network Policy for a cluster.",
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "id": "container.projects.zones.clusters.setNetworkPolicy"
+ }
+ },
+ "resources": {
+ "nodePools": {
+ "methods": {
+ "setSize": {
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
+ "id": "container.projects.zones.clusters.nodePools.setSize",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
+ "request": {
+ "$ref": "SetNodePoolSizeRequest"
+ },
+ "description": "Sets the size of a specific node pool.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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.",
+ "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"
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "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": {
+ "nodePoolId": {
+ "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
+ "id": "container.projects.zones.clusters.nodePools.setManagement"
+ },
+ "delete": {
+ "description": "Deletes a node pool from a cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "DELETE",
+ "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": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "name": {
+ "location": "query",
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "id": "container.projects.zones.clusters.nodePools.delete"
+ },
+ "list": {
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "id": "container.projects.zones.clusters.nodePools.list",
+ "description": "Lists the node pools for a cluster.",
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "rollback": {
+ "request": {
+ "$ref": "RollbackNodePoolUpgradeRequest"
+ },
+ "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "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 rollback.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
+ "id": "container.projects.zones.clusters.nodePools.rollback"
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use 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"
+ }
+ },
+ "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": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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"
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "NodePool"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "name": {
+ "location": "query",
+ "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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."
+ },
+ "update": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
+ "id": "container.projects.zones.clusters.nodePools.update",
+ "description": "Updates the version and/or iamge type of a specific node pool.",
+ "request": {
+ "$ref": "UpdateNodePoolRequest"
+ }
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "operationId": {
+ "location": "path",
+ "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "id": "container.projects.zones.operations.cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Cancels the specified operation."
+ },
+ "list": {
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/operations",
+ "id": "container.projects.zones.operations.list",
+ "description": "Lists all operations in a project in a specific zone or all zones.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.",
+ "required": true,
+ "type": "string"
+ },
+ "parent": {
+ "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations"
+ },
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "query",
+ "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "id": "container.projects.zones.operations.get",
+ "description": "Gets the specified operation."
+ }
+ }
+ }
+ }
+ },
+ "locations": {
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: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": {
+ "location": "path",
+ "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$"
+ }
+ }
+ },
+ "list": {
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
+ "path": "v1beta1/{+parent}/operations",
+ "id": "container.projects.locations.operations.list",
+ "description": "Lists all operations in a project in a specific zone or all zones."
+ },
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "zone": {
+ "location": "query",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ "required": true,
+ "type": "string"
+ },
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ "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.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.operations.get",
+ "description": "Gets the specified operation."
+ }
+ }
+ },
+ "clusters": {
+ "resources": {
+ "nodePools": {
+ "methods": {
+ "setSize": {
+ "request": {
+ "$ref": "SetNodePoolSizeRequest"
+ },
+ "description": "Sets the size of a specific node pool.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setSize",
+ "path": "v1beta1/{+name}:setSize",
+ "id": "container.projects.locations.clusters.nodePools.setSize"
+ },
+ "setManagement": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement",
+ "path": "v1beta1/{+name}:setManagement",
+ "id": "container.projects.locations.clusters.nodePools.setManagement",
+ "description": "Sets the NodeManagement options for a node pool.",
+ "request": {
+ "$ref": "SetNodePoolManagementRequest"
+ }
+ },
+ "delete": {
+ "id": "container.projects.locations.clusters.nodePools.delete",
+ "path": "v1beta1/{+name}",
+ "description": "Deletes a node pool from a cluster.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "location": "query",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "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": {
+ "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "query",
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
+ "path": "v1beta1/{+parent}/nodePools",
+ "id": "container.projects.locations.clusters.nodePools.list",
+ "description": "Lists the node pools for a cluster."
+ },
+ "rollback": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback",
+ "id": "container.projects.locations.clusters.nodePools.rollback",
+ "path": "v1beta1/{+name}:rollback",
+ "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": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "parent": {
+ "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
+ "id": "container.projects.locations.clusters.nodePools.create",
+ "path": "v1beta1/{+parent}/nodePools",
+ "request": {
+ "$ref": "CreateNodePoolRequest"
+ },
+ "description": "Creates a node pool for a cluster."
+ },
+ "get": {
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.clusters.nodePools.get",
+ "description": "Retrieves the node pool requested.",
+ "response": {
+ "$ref": "NodePool"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "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.\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"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}"
+ },
+ "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": {
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "setAutoscaling": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling",
+ "path": "v1beta1/{+name}:setAutoscaling",
+ "id": "container.projects.locations.clusters.nodePools.setAutoscaling",
+ "description": "Sets the autoscaling settings of a specific node pool.",
+ "request": {
+ "$ref": "SetNodePoolAutoscalingRequest"
+ }
+ }
+ }
+ }
+ },
+ "methods": {
+ "setLegacyAbac": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac",
+ "id": "container.projects.locations.clusters.setLegacyAbac",
+ "path": "v1beta1/{+name}:setLegacyAbac",
+ "request": {
+ "$ref": "SetLegacyAbacRequest"
+ },
+ "description": "Enables or disables the ABAC authorization mechanism on a cluster."
+ },
+ "setResourceLabels": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels",
+ "path": "v1beta1/{+name}:setResourceLabels",
+ "id": "container.projects.locations.clusters.setResourceLabels",
+ "request": {
+ "$ref": "SetLabelsRequest"
+ },
+ "description": "Sets labels on a cluster."
+ },
+ "setLocations": {
+ "description": "Sets the locations of a specific cluster.",
+ "request": {
+ "$ref": "SetLocationsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations",
+ "path": "v1beta1/{+name}:setLocations",
+ "id": "container.projects.locations.clusters.setLocations"
+ },
+ "updateMaster": {
+ "request": {
+ "$ref": "UpdateMasterRequest"
+ },
+ "description": "Updates the master of a specific cluster.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:updateMaster",
+ "id": "container.projects.locations.clusters.updateMaster",
+ "path": "v1beta1/{+name}:updateMaster"
+ },
+ "update": {
+ "request": {
+ "$ref": "UpdateClusterRequest"
+ },
+ "description": "Updates the settings of a specific cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "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}",
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.clusters.update"
+ },
+ "setMasterAuth": {
+ "path": "v1beta1/{+name}:setMasterAuth",
+ "id": "container.projects.locations.clusters.setMasterAuth",
+ "request": {
+ "$ref": "SetMasterAuthRequest"
+ },
+ "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth"
+ },
+ "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": {
+ "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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",
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
+ "path": "v1beta1/{+parent}/clusters",
+ "id": "container.projects.locations.clusters.list"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "parent": {
+ "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
+ "id": "container.projects.locations.clusters.create",
+ "path": "v1beta1/{+parent}/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": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation",
+ "path": "v1beta1/{+name}:completeIpRotation",
+ "id": "container.projects.locations.clusters.completeIpRotation",
+ "request": {
+ "$ref": "CompleteIPRotationRequest"
+ },
+ "description": "Completes master IP rotation.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the details of a specific cluster.",
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "location": "query",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.clusters.get"
+ },
+ "setNetworkPolicy": {
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ },
+ "description": "Enables/Disables Network Policy for a cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy",
+ "path": "v1beta1/{+name}:setNetworkPolicy",
+ "id": "container.projects.locations.clusters.setNetworkPolicy"
+ },
+ "setAddons": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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",
+ "id": "container.projects.locations.clusters.setAddons",
+ "path": "v1beta1/{+name}:setAddons",
+ "request": {
+ "$ref": "SetAddonsConfigRequest"
+ },
+ "description": "Sets the addons of a specific cluster."
+ },
+ "setMonitoring": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring",
+ "path": "v1beta1/{+name}:setMonitoring",
+ "id": "container.projects.locations.clusters.setMonitoring",
+ "description": "Sets the monitoring service of a specific cluster.",
+ "request": {
+ "$ref": "SetMonitoringServiceRequest"
+ }
+ },
+ "startIpRotation": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation",
+ "id": "container.projects.locations.clusters.startIpRotation",
+ "path": "v1beta1/{+name}:startIpRotation",
+ "request": {
+ "$ref": "StartIPRotationRequest"
+ },
+ "description": "Start master IP rotation."
+ },
+ "setMaintenancePolicy": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy",
+ "path": "v1beta1/{+name}:setMaintenancePolicy",
+ "id": "container.projects.locations.clusters.setMaintenancePolicy",
+ "request": {
+ "$ref": "SetMaintenancePolicyRequest"
+ },
+ "description": "Sets the maintenance 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 maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "location": "query",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "location": "query",
+ "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
+ "id": "container.projects.locations.clusters.delete",
+ "path": "v1beta1/{+name}",
+ "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time."
+ }
+ }
+ }
+ },
+ "methods": {
+ "getServerConfig": {
+ "description": "Returns configuration info about the Kubernetes Engine service.",
+ "response": {
+ "$ref": "ServerConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "location": "path",
+ "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig",
+ "path": "v1beta1/{+name}/serverConfig",
+ "id": "container.projects.locations.getServerConfig"
+ }
+ }
+ }
+ }
+ }
+ },
"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": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -33,15 +2287,20 @@
"location": "query"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
@@ -55,12 +2314,13 @@
"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",
@@ -68,39 +2328,1121 @@
],
"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"
- },
- "access_token": {
- "description": "OAuth access token.",
"type": "string",
"location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
}
},
"version": "v1beta1",
"baseUrl": "https://container.googleapis.com/",
- "servicePath": "",
- "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",
+ "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": "20180108",
- "documentationLink": "https://cloud.google.com/container-engine/",
"id": "container:v1beta1",
+ "documentationLink": "https://cloud.google.com/container-engine/",
+ "revision": "20180108",
"discoveryVersion": "v1",
"version_module": true,
"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"
+ },
+ "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"
+ }
+ },
+ "id": "PodSecurityPolicyConfig"
+ },
+ "HttpLoadBalancing": {
+ "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",
+ "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"
+ },
+ "SetNetworkPolicyRequest": {
+ "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
+ "type": "object",
+ "properties": {
+ "networkPolicy": {
+ "$ref": "NetworkPolicy",
+ "description": "Configuration options for the NetworkPolicy feature."
+ },
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "id": "SetNetworkPolicyRequest"
+ },
+ "NodePoolAutoscaling": {
+ "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.",
+ "type": "object",
+ "properties": {
+ "maxNodeCount": {
+ "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minNodeCount": {
+ "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "enabled": {
+ "description": "Is autoscaling enabled for this node pool.",
+ "type": "boolean"
+ }
+ },
+ "id": "NodePoolAutoscaling"
+ },
+ "SetMasterAuthRequest": {
+ "properties": {
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "update": {
+ "$ref": "MasterAuth",
+ "description": "A description of the update."
+ },
+ "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": {
+ "enumDescriptions": [
+ "Operation is unknown and will error out.",
+ "Set the password to a user generated value.",
+ "Generate a new password and set it to that.",
+ "Set the username. If an empty username is provided, basic authentication\nis disabled for the cluster. If a non-empty username is provided, basic\nauthentication is enabled, with either a provided password or a generated\none."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "SET_PASSWORD",
+ "GENERATE_PASSWORD",
+ "SET_USERNAME"
+ ],
+ "description": "The exact form of action to be taken on the master auth.",
+ "type": "string"
+ },
+ "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": "SetMasterAuthRequest",
+ "description": "SetMasterAuthRequest updates the admin password of a cluster.",
+ "type": "object"
+ },
+ "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"
+ },
+ "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 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",
+ "description": "Configuration for controlling how IPs are allocated in the cluster.",
+ "type": "object"
+ },
+ "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": {
+ "desiredLocations": {
+ "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "desiredNodePoolAutoscaling": {
+ "description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool.",
+ "$ref": "NodePoolAutoscaling"
+ },
+ "desiredMonitoringService": {
+ "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
+ "type": "string"
+ },
+ "desiredImageType": {
+ "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.",
+ "type": "string"
+ },
+ "desiredAddonsConfig": {
+ "description": "Configurations for the various addons available to run in the cluster.",
+ "$ref": "AddonsConfig"
+ },
+ "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"
+ },
+ "desiredPodSecurityPolicyConfig": {
+ "description": "The desired configuration options for the PodSecurityPolicy feature.",
+ "$ref": "PodSecurityPolicyConfig"
+ },
+ "desiredMasterVersion": {
+ "description": "The Kubernetes version to change the master to. The only valid value is the\nlatest supported version. Use \"-\" to have the server automatically select\nthe latest version.",
+ "type": "string"
+ },
+ "desiredMasterAuthorizedNetworksConfig": {
+ "$ref": "MasterAuthorizedNetworksConfig",
+ "description": "The desired configuration options for master authorized networks feature."
+ }
+ },
+ "id": "ClusterUpdate"
+ },
+ "HorizontalPodAutoscaling": {
+ "description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
+ "type": "object",
+ "properties": {
+ "disabled": {
+ "description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.\nWhen enabled, it ensures that a Heapster pod is running in the cluster,\nwhich is also used by the Cloud Monitoring service.",
+ "type": "boolean"
+ }
+ },
+ "id": "HorizontalPodAutoscaling"
+ },
+ "MasterAuthorizedNetworksConfig": {
+ "description": "Configuration options for the master authorized networks feature. Enabled\nmaster authorized networks will disallow all external traffic to access\nKubernetes master through HTTPS except traffic from the given CIDR blocks,\nGoogle Compute Engine Public IPs and Google Prod IPs.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "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"
+ },
+ "SetNodePoolManagementRequest": {
+ "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
+ "type": "object",
+ "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": {
+ "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": "SetNodePoolManagementRequest"
+ },
+ "SetNodePoolAutoscalingRequest": {
+ "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.",
+ "type": "object",
+ "properties": {
+ "autoscaling": {
+ "$ref": "NodePoolAutoscaling",
+ "description": "Autoscaling configuration for the node pool."
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "SetNodePoolAutoscalingRequest"
+ },
+ "CreateClusterRequest": {
+ "description": "CreateClusterRequest creates a cluster.",
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "cluster": {
+ "description": "A [cluster\nresource](/container-engine/reference/rest/v1beta1/projects.zones.clusters)",
+ "$ref": "Cluster"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
+ "type": "string"
+ }
+ },
+ "id": "CreateClusterRequest"
+ },
+ "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": "SetNodePoolVersionRequest updates the version of a node pool.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name (project, location, cluster, node pool) of the node pool to update.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "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": {
+ "description": "The desired image type for the node pool.",
+ "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"
+ },
+ "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": {
+ "properties": {
+ "addonsConfig": {
+ "$ref": "AddonsConfig",
+ "description": "The desired configurations for the various addons available to run in the\ncluster."
+ },
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "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": "SetAddonsConfigRequest",
+ "description": "SetAddonsRequest sets the addons associated with the cluster.",
+ "type": "object"
+ },
+ "NodeTaint": {
+ "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",
+ "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"
+ },
+ "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"
+ },
+ "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 update.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ }
+ },
+ "id": "SetLegacyAbacRequest"
+ },
+ "AddonsConfig": {
+ "description": "Configuration for the addons that can be automatically spun up in the\ncluster, enabling additional functionality.",
+ "type": "object",
+ "properties": {
+ "horizontalPodAutoscaling": {
+ "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
+ "$ref": "HorizontalPodAutoscaling"
+ },
+ "httpLoadBalancing": {
+ "$ref": "HttpLoadBalancing",
+ "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster."
+ },
+ "kubernetesDashboard": {
+ "$ref": "KubernetesDashboard",
+ "description": "Configuration for the Kubernetes Dashboard."
+ },
+ "networkPolicyConfig": {
+ "$ref": "NetworkPolicyConfig",
+ "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes."
+ }
+ },
+ "id": "AddonsConfig"
+ },
+ "SetLocationsRequest": {
+ "properties": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\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"
+ },
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ }
+ },
+ "id": "SetLocationsRequest",
+ "description": "SetLocationsRequest sets the locations of the cluster.",
+ "type": "object"
+ },
+ "SetNodePoolSizeRequest": {
+ "description": "SetNodePoolSizeRequest sets the size a node\npool.",
+ "type": "object",
+ "properties": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "nodeCount": {
+ "description": "The desired node count for the pool.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\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).",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "id": "SetNodePoolSizeRequest"
+ },
+ "UpdateClusterRequest": {
+ "description": "UpdateClusterRequest updates the settings of a cluster.",
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "update": {
+ "$ref": "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"
+ },
+ "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": {
+ "description": "A Google Kubernetes Engine cluster.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "$ref": "MasterAuth",
+ "description": "The authentication information for accessing the master endpoint."
+ },
+ "currentMasterVersion": {
+ "description": "[Output only] The current software version of the master endpoint.",
+ "type": "string"
+ },
+ "nodeConfig": {
+ "$ref": "NodeConfig",
+ "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used."
+ },
+ "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": {
+ "enumDescriptions": [
+ "Not set.",
+ "The PROVISIONING state indicates the cluster is being created.",
+ "The RUNNING state indicates the cluster has been created and is fully\nusable.",
+ "The RECONCILING state indicates that some work is actively being done on\nthe cluster, such as upgrading the master or node software. Details can\nbe found in the `statusMessage` field.",
+ "The STOPPING state indicates the cluster is being deleted.",
+ "The ERROR state indicates the cluster may be unusable. Details\ncan be found in the `statusMessage` field."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PROVISIONING",
+ "RUNNING",
+ "RECONCILING",
+ "STOPPING",
+ "ERROR"
+ ],
+ "description": "[Output only] The current status of this cluster.",
+ "type": "string"
+ },
+ "subnetwork": {
+ "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected.",
+ "type": "string"
+ },
+ "currentNodeVersion": {
+ "description": "[Output only] The current version of the node software components.\nIf they are currently at multiple versions because they're in the process\nof being upgraded, this reflects the minimum version of all nodes.",
+ "type": "string"
+ },
+ "maintenancePolicy": {
+ "$ref": "MaintenancePolicy",
+ "description": "Configure the maintenance policy for this cluster."
+ },
+ "name": {
+ "description": "The name of this cluster. The name must be unique within this project\nand zone, and can be up to 40 characters with the following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.",
+ "type": "string"
+ },
+ "initialClusterVersion": {
+ "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.",
+ "type": "string"
+ },
+ "ipAllocationPolicy": {
+ "description": "Configuration for cluster IP allocation.",
+ "$ref": "IPAllocationPolicy"
+ },
+ "endpoint": {
+ "description": "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information.",
+ "type": "string"
+ },
+ "location": {
+ "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
+ },
+ "clusterIpv4Cidr": {
+ "description": "The IP address range of the container pods in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`). Leave blank to have\none automatically chosen or specify a `/14` block in `10.0.0.0/8`.",
+ "type": "string"
+ },
+ "initialNodeCount": {
+ "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": {
+ "$ref": "NetworkPolicy",
+ "description": "Configuration options for the NetworkPolicy feature."
+ },
+ "servicesIpv4Cidr": {
+ "description": "[Output only] The IP address range of the Kubernetes services in\nthis cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `1.2.3.4/29`). Service addresses are\ntypically put in the last `/16` from the container CIDR.",
+ "type": "string"
+ },
+ "enableKubernetesAlpha": {
+ "description": "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. v1beta1) and features that may not be production ready in\nthe kubernetes version of the master and nodes.\nThe cluster has no SLA for uptime and master/node upgrades are disabled.\nAlpha enabled clusters are automatically deleted thirty days after\ncreation.",
+ "type": "boolean"
+ },
+ "description": {
+ "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"
+ },
+ "network": {
+ "description": "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use location instead.",
+ "type": "string"
+ },
+ "expireTime": {
+ "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"
+ }
+ },
+ "id": "Cluster"
+ },
+ "CreateNodePoolRequest": {
+ "description": "CreateNodePoolRequest creates a node pool for 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"
+ },
+ "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"
+ }
+ },
+ "id": "CreateNodePoolRequest"
+ },
+ "MasterAuth": {
+ "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",
+ "description": "The authentication information for accessing the master endpoint.\nAuthentication can be done using HTTP basic auth or using client\ncertificates.",
+ "type": "object"
+ },
+ "DailyMaintenanceWindow": {
+ "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.",
+ "type": "object"
+ },
+ "MaintenancePolicy": {
+ "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
+ "type": "object",
+ "properties": {
+ "window": {
+ "$ref": "MaintenanceWindow",
+ "description": "Specifies the maintenance window in which maintenance may be performed."
+ }
+ },
+ "id": "MaintenancePolicy"
+ },
+ "ClientCertificateConfig": {
+ "description": "Configuration for client certificates on the cluster.",
+ "type": "object",
+ "properties": {
+ "issueClientCertificate": {
+ "description": "Issue a client certificate.",
+ "type": "boolean"
+ }
+ },
+ "id": "ClientCertificateConfig"
+ },
+ "SetLoggingServiceRequest": {
+ "properties": {
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "SetLoggingServiceRequest",
+ "description": "SetLoggingServiceRequest sets the logging service of a cluster.",
+ "type": "object"
+ },
+ "SetMaintenancePolicyRequest": {
+ "properties": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to update.",
+ "type": "string"
+ },
+ "maintenancePolicy": {
+ "description": "The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy.",
+ "$ref": "MaintenancePolicy"
+ },
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ }
+ },
+ "id": "SetMaintenancePolicyRequest",
+ "description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.",
+ "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"
+ },
+ "WorkloadMetadataConfig": {
+ "properties": {
+ "nodeMetadata": {
+ "enumDescriptions": [
+ "Not set.",
+ "Expose only a secure subset of metadata to pods. Currently, this blocks\nkube-env, but exposes all other metadata.",
+ "Expose all GCE metadata to pods."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "SECURE",
+ "EXPOSE"
+ ],
+ "description": "NodeMetadata is the configuration for if and how to expose the node\nmetadata to the workload running on the node.",
+ "type": "string"
+ }
+ },
+ "id": "WorkloadMetadataConfig",
+ "description": "WorkloadMetadataConfig defines the metadata configuration to expose to\nworkloads on the node pool.",
+ "type": "object"
+ },
+ "ListNodePoolsResponse": {
+ "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
+ "type": "object",
+ "properties": {
+ "nodePools": {
+ "description": "A list of node pools for a cluster.",
+ "type": "array",
+ "items": {
+ "$ref": "NodePool"
+ }
+ }
+ },
+ "id": "ListNodePoolsResponse"
+ },
+ "CompleteIPRotationRequest": {
+ "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.",
+ "type": "object",
+ "properties": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "id": "CompleteIPRotationRequest"
+ },
+ "StartIPRotationRequest": {
+ "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.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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"
+ },
+ "SetLabelsRequest": {
+ "properties": {
+ "labelFingerprint": {
+ "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nKubernetes Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "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": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "id": "SetLabelsRequest",
+ "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"
+ },
"NodePool": {
- "id": "NodePool",
"description": "NodePool contains the name and configuration for a cluster's node pool.\nNode pools are a set of nodes (i.e. VM's), with a common configuration and\nspecification, under the control of the cluster master. They may have a set\nof Kubernetes labels applied to them, which may be used to reference them\nduring pod scheduling. They may also be resized up or down, to accommodate\nthe workload.",
"type": "object",
"properties": {
@@ -142,15 +3484,15 @@
"description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present.",
"$ref": "NodePoolAutoscaling"
},
- "management": {
- "description": "NodeManagement configuration for this NodePool.",
- "$ref": "NodeManagement"
- },
"initialNodeCount": {
"description": "The initial node count for the pool. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.",
"format": "int32",
"type": "integer"
},
+ "management": {
+ "description": "NodeManagement configuration for this NodePool.",
+ "$ref": "NodeManagement"
+ },
"selfLink": {
"description": "[Output only] Server-defined URL for the resource.",
"type": "string"
@@ -166,51 +3508,13 @@
"type": "string"
}
}
- }
- },
- "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": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "resourceLabels": {
- "description": "The labels to set for that cluster.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "labelFingerprint": {
- "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nKubernetes Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.",
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- }
+ },
+ "id": "NodePool"
},
"NodeManagement": {
- "id": "NodeManagement",
"description": "NodeManagement defines the set of node management services turned on for the\nnode pool.",
"type": "object",
"properties": {
- "upgradeOptions": {
- "description": "Specifies the Auto Upgrade knobs for the node pool.",
- "$ref": "AutoUpgradeOptions"
- },
"autoUpgrade": {
"description": "Whether the nodes will be automatically upgraded.",
"type": "boolean"
@@ -218,13 +3522,22 @@
"autoRepair": {
"description": "Whether the nodes will be automatically repaired.",
"type": "boolean"
+ },
+ "upgradeOptions": {
+ "description": "Specifies the Auto Upgrade knobs for the node pool.",
+ "$ref": "AutoUpgradeOptions"
}
- }
+ },
+ "id": "NodeManagement"
},
"CancelOperationRequest": {
"description": "CancelOperationRequest cancels a single operation.",
"type": "object",
"properties": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
"name": {
"description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
"type": "string"
@@ -236,16 +3549,11 @@
"projectId": {
"description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
"type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.",
- "type": "string"
}
},
"id": "CancelOperationRequest"
},
"KubernetesDashboard": {
- "id": "KubernetesDashboard",
"description": "Configuration for the Kubernetes Dashboard.",
"type": "object",
"properties": {
@@ -253,86 +3561,13 @@
"description": "Whether the Kubernetes Dashboard is enabled for this cluster.",
"type": "boolean"
}
- }
+ },
+ "id": "KubernetesDashboard"
},
"Operation": {
"description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.",
"type": "object",
"properties": {
- "statusMessage": {
- "description": "If an error has occurred, a textual description of the error.",
- "type": "string"
- },
- "name": {
- "description": "The server-assigned ID for the operation.",
- "type": "string"
- },
- "selfLink": {
- "description": "Server-defined URL for the resource.",
- "type": "string"
- },
- "detail": {
- "description": "Detailed operation progress, if available.",
- "type": "string"
- },
- "targetLink": {
- "description": "Server-defined URL for the target of the operation.",
- "type": "string"
- },
- "location": {
- "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.",
- "type": "string"
- },
- "endTime": {
- "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
- "type": "string"
- },
- "operationType": {
- "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."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "CREATE_CLUSTER",
- "DELETE_CLUSTER",
- "UPGRADE_MASTER",
- "UPGRADE_NODES",
- "REPAIR_CLUSTER",
- "UPDATE_CLUSTER",
- "CREATE_NODE_POOL",
- "DELETE_NODE_POOL",
- "SET_NODE_POOL_MANAGEMENT",
- "AUTO_REPAIR_NODES",
- "AUTO_UPGRADE_NODES",
- "SET_LABELS",
- "SET_MASTER_AUTH",
- "SET_NODE_POOL_SIZE",
- "SET_NETWORK_POLICY",
- "SET_MAINTENANCE_POLICY"
- ]
- },
- "startTime": {
- "description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
- "type": "string"
- },
"zone": {
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place.\nThis field is deprecated, use location instead.",
"type": "string"
@@ -354,12 +3589,85 @@
"DONE",
"ABORTING"
]
+ },
+ "name": {
+ "description": "The server-assigned ID for the operation.",
+ "type": "string"
+ },
+ "statusMessage": {
+ "description": "If an error has occurred, a textual description of the error.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
+ },
+ "location": {
+ "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.",
+ "type": "string"
+ },
+ "targetLink": {
+ "description": "Server-defined URL for the target of the operation.",
+ "type": "string"
+ },
+ "detail": {
+ "description": "Detailed operation progress, if available.",
+ "type": "string"
+ },
+ "operationType": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "CREATE_CLUSTER",
+ "DELETE_CLUSTER",
+ "UPGRADE_MASTER",
+ "UPGRADE_NODES",
+ "REPAIR_CLUSTER",
+ "UPDATE_CLUSTER",
+ "CREATE_NODE_POOL",
+ "DELETE_NODE_POOL",
+ "SET_NODE_POOL_MANAGEMENT",
+ "AUTO_REPAIR_NODES",
+ "AUTO_UPGRADE_NODES",
+ "SET_LABELS",
+ "SET_MASTER_AUTH",
+ "SET_NODE_POOL_SIZE",
+ "SET_NETWORK_POLICY",
+ "SET_MAINTENANCE_POLICY"
+ ],
+ "description": "The operation type.",
+ "type": "string",
+ "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": {
+ "description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
}
},
"id": "Operation"
},
"MaintenanceWindow": {
- "id": "MaintenanceWindow",
"description": "MaintenanceWindow defines the maintenance window to be used for the cluster.",
"type": "object",
"properties": {
@@ -367,16 +3675,11 @@
"description": "DailyMaintenanceWindow specifies a daily maintenance operation window.",
"$ref": "DailyMaintenanceWindow"
}
- }
+ },
+ "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": {
- "name": {
- "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "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"
@@ -392,9 +3695,15 @@
"nodePoolId": {
"description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead.",
"type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string"
}
},
- "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/",
@@ -405,8 +3714,6 @@
"type": "boolean"
},
"provider": {
- "description": "The selected network policy provider.",
- "type": "string",
"enumDescriptions": [
"Not set",
"Tigera (Calico Felix)."
@@ -414,7 +3721,9 @@
"enum": [
"PROVIDER_UNSPECIFIED",
"CALICO"
- ]
+ ],
+ "description": "The selected network policy provider.",
+ "type": "string"
}
},
"id": "NetworkPolicy"
@@ -423,6 +3732,14 @@
"description": "UpdateMasterRequest updates the master of the cluster.",
"type": "object",
"properties": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "masterVersion": {
+ "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"
@@ -434,44 +3751,54 @@
"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"
- },
- "masterVersion": {
- "description": "The Kubernetes version to change the master to. The only valid value is the\nlatest supported version. Use \"-\" to have the server automatically select\nthe latest version.",
- "type": "string"
}
},
"id": "UpdateMasterRequest"
},
"ListOperationsResponse": {
- "id": "ListOperationsResponse",
- "description": "ListOperationsResponse is the result of ListOperationsRequest.",
- "type": "object",
"properties": {
- "operations": {
- "description": "A list of operations in the project in the specified zone.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- },
"missingZones": {
"description": "If any zones are listed here, the list of operations returned\nmay be missing the operations from those zones.",
"type": "array",
"items": {
"type": "string"
}
+ },
+ "operations": {
+ "description": "A list of operations in the project in the specified zone.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
}
- }
+ },
+ "id": "ListOperationsResponse",
+ "description": "ListOperationsResponse is the result of ListOperationsRequest.",
+ "type": "object"
+ },
+ "CidrBlock": {
+ "description": "CidrBlock contains an optional name and one CIDR block.",
+ "type": "object",
+ "properties": {
+ "cidrBlock": {
+ "description": "cidr_block must be specified in CIDR notation.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "display_name is an optional field for users to identify CIDR blocks.",
+ "type": "string"
+ }
+ },
+ "id": "CidrBlock"
},
"SetMonitoringServiceRequest": {
- "id": "SetMonitoringServiceRequest",
"description": "SetMonitoringServiceRequest sets the monitoring service of 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 name instead.",
+ "type": "string"
+ },
"clusterId": {
"description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
"type": "string"
@@ -487,30 +3814,11 @@
"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"
}
- }
- },
- "CidrBlock": {
- "id": "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"
- },
- "cidrBlock": {
- "description": "cidr_block must be specified in CIDR notation.",
- "type": "string"
- }
- }
+ },
+ "id": "SetMonitoringServiceRequest"
},
"ServerConfig": {
- "id": "ServerConfig",
"description": "Kubernetes Engine service configuration.",
"type": "object",
"properties": {
@@ -543,12 +3851,27 @@
"type": "string"
}
}
- }
+ },
+ "id": "ServerConfig"
},
"NodeConfig": {
- "description": "Parameters that describe the nodes in a cluster.",
- "type": "object",
"properties": {
+ "preemptible": {
+ "description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninforamtion about preemptible VM instances.",
+ "type": "boolean"
+ },
+ "localSsdCount": {
+ "description": "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependant upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits\nfor more information.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "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 reserved keys:\n \"cluster-name\"\n \"cluster-uid\"\n \"configure-sh\"\n \"gci-update-strategy\"\n \"gci-ensure-gke-docker\"\n \"instance-template\"\n \"kube-env\"\n \"startup-script\"\n \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
+ "type": "object"
+ },
"tags": {
"description": "The list of instance tags applied to all nodes. Tags are used to identify\nvalid sources or targets for network firewalls and are specified by\nthe client during cluster or node pool creation. Each tag within the list\nmust comply with RFC1035.",
"type": "array",
@@ -579,11 +3902,11 @@
}
},
"labels": {
- "description": "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/",
+ "type": "object"
},
"diskSizeGb": {
"description": "Size of the disk attached to each node, specified in GB.\nThe smallest allowed disk size is 10GB.\n\nIf unspecified, the default disk size is 100GB.",
@@ -608,3339 +3931,16 @@
"minCpuPlatform": {
"description": "Minimum CPU platform to be used by this instance. The instance may be\nscheduled on the specified or newer CPU platform. Applicable values are the\nfriendly names of CPU platforms, such as\n\u003ccode\u003eminCpuPlatform: "Intel Haswell"\u003c/code\u003e or\n\u003ccode\u003eminCpuPlatform: "Intel Sandy Bridge"\u003c/code\u003e. For more\ninformation, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)",
"type": "string"
- },
- "preemptible": {
- "description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninforamtion about preemptible VM instances.",
- "type": "boolean"
- },
- "localSsdCount": {
- "description": "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependant upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits\nfor more information.",
- "format": "int32",
- "type": "integer"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "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 reserved keys:\n \"cluster-name\"\n \"cluster-uid\"\n \"configure-sh\"\n \"gci-update-strategy\"\n \"gci-ensure-gke-docker\"\n \"instance-template\"\n \"kube-env\"\n \"startup-script\"\n \"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"
}
},
- "id": "NodeConfig"
- },
- "AutoUpgradeOptions": {
- "id": "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"
- }
- }
- },
- "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"
- },
- "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"
- }
- },
- "id": "PodSecurityPolicyConfig"
- },
- "HttpLoadBalancing": {
- "description": "Configuration options for the HTTP (L7) load balancing controller addon,\nwhich makes it easy to set up HTTP load balancers for services in a cluster.",
- "type": "object",
- "properties": {
- "disabled": {
- "description": "Whether the HTTP Load Balancing controller is enabled in the cluster.\nWhen enabled, it runs a small pod in the cluster that manages the load\nbalancers.",
- "type": "boolean"
- }
- },
- "id": "HttpLoadBalancing"
- },
- "SetMasterAuthRequest": {
- "description": "SetMasterAuthRequest updates the admin password of a cluster.",
- "type": "object",
- "properties": {
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "name": {
- "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "action": {
- "description": "The exact form of action to be taken on the master auth.",
- "type": "string",
- "enumDescriptions": [
- "Operation is unknown and will error out.",
- "Set the password to a user generated value.",
- "Generate a new password and set it to that.",
- "Set the username. If an empty username is provided, basic authentication\nis disabled for the cluster. If a non-empty username is provided, basic\nauthentication is enabled, with either a provided password or a generated\none."
- ],
- "enum": [
- "UNKNOWN",
- "SET_PASSWORD",
- "GENERATE_PASSWORD",
- "SET_USERNAME"
- ]
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "update": {
- "description": "A description of the update.",
- "$ref": "MasterAuth"
- }
- },
- "id": "SetMasterAuthRequest"
- },
- "SetNetworkPolicyRequest": {
- "id": "SetNetworkPolicyRequest",
- "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "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."
- }
- }
- },
- "NodePoolAutoscaling": {
- "id": "NodePoolAutoscaling",
- "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.",
- "type": "object",
- "properties": {
- "enabled": {
- "description": "Is autoscaling enabled for this node pool.",
- "type": "boolean"
- },
- "maxNodeCount": {
- "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.",
- "format": "int32",
- "type": "integer"
- },
- "minNodeCount": {
- "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "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": {
- "desiredAddonsConfig": {
- "description": "Configurations for the various addons available to run in the cluster.",
- "$ref": "AddonsConfig"
- },
- "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": {
- "description": "The desired configuration options for the PodSecurityPolicy feature.",
- "$ref": "PodSecurityPolicyConfig"
- },
- "desiredMasterAuthorizedNetworksConfig": {
- "description": "The desired configuration options for master authorized networks feature.",
- "$ref": "MasterAuthorizedNetworksConfig"
- },
- "desiredNodePoolAutoscaling": {
- "$ref": "NodePoolAutoscaling",
- "description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool."
- },
- "desiredLocations": {
- "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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"
- }
- }
- },
- "IPAllocationPolicy": {
- "id": "IPAllocationPolicy",
- "description": "Configuration for controlling how IPs are allocated in the cluster.",
- "type": "object",
- "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"
- },
- "clusterIpv4CidrBlock": {
- "description": "The IP address range for the cluster pod IPs. If this field is set, then\n`cluster.cluster_ipv4_cidr` must be left blank.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
- "type": "string"
- },
- "clusterSecondaryRangeName": {
- "description": "The name of the secondary range to be used for the cluster CIDR\nblock. The secondary range will be used for pod IP\naddresses. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases and\ncreate_subnetwork is false.",
- "type": "string"
- },
- "nodeIpv4CidrBlock": {
- "description": "The IP address range of the instance IPs in this cluster.\n\nThis is applicable only if `create_subnetwork` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
- "type": "string"
- },
- "createSubnetwork": {
- "description": "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true.",
- "type": "boolean"
- },
- "useIpAliases": {
- "description": "Whether alias IPs will be used for pod IPs in the cluster.",
- "type": "boolean"
- },
- "servicesSecondaryRangeName": {
- "description": "The name of the secondary range to be used as for the services\nCIDR block. The secondary range will be used for service\nClusterIPs. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases and\ncreate_subnetwork is false.",
- "type": "string"
- }
- }
- },
- "HorizontalPodAutoscaling": {
- "id": "HorizontalPodAutoscaling",
- "description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
- "type": "object",
- "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"
- }
- }
- },
- "SetNodePoolManagementRequest": {
- "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
- "type": "object",
- "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": {
- "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": "SetNodePoolManagementRequest"
- },
- "MasterAuthorizedNetworksConfig": {
- "description": "Configuration options for the master authorized networks feature. Enabled\nmaster authorized networks will disallow all external traffic to access\nKubernetes master through HTTPS except traffic from the given CIDR blocks,\nGoogle Compute Engine Public IPs and Google Prod IPs.",
- "type": "object",
- "properties": {
- "enabled": {
- "description": "Whether or not master authorized networks is enabled.",
- "type": "boolean"
- },
- "cidrBlocks": {
- "description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS.",
- "type": "array",
- "items": {
- "$ref": "CidrBlock"
- }
- }
- },
- "id": "MasterAuthorizedNetworksConfig"
- },
- "SetNodePoolAutoscalingRequest": {
- "id": "SetNodePoolAutoscalingRequest",
- "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.",
- "type": "object",
- "properties": {
- "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": {
- "description": "Autoscaling configuration for the node pool.",
- "$ref": "NodePoolAutoscaling"
- },
- "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"
- },
- "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"
- }
- }
- },
- "CreateClusterRequest": {
- "description": "CreateClusterRequest creates a cluster.",
- "type": "object",
- "properties": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
- "type": "string"
- },
- "cluster": {
- "description": "A [cluster\nresource](/container-engine/reference/rest/v1beta1/projects.zones.clusters)",
- "$ref": "Cluster"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
- "type": "string"
- },
- "parent": {
- "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
- "type": "string"
- }
- },
- "id": "CreateClusterRequest"
- },
- "UpdateNodePoolRequest": {
- "description": "SetNodePoolVersionRequest updates the version of a node pool.",
- "type": "object",
- "properties": {
- "imageType": {
- "description": "The desired image type for the node pool.",
- "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"
- },
- "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"
- }
- },
- "id": "UpdateNodePoolRequest"
- },
- "AcceleratorConfig": {
- "id": "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"
- }
- }
- },
- "SetAddonsConfigRequest": {
- "id": "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": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "addonsConfig": {
- "$ref": "AddonsConfig",
- "description": "The desired configurations for the various addons available to run in the\ncluster."
- }
- }
- },
- "NodeTaint": {
- "id": "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": {
- "description": "Effect for taint.",
- "type": "string",
- "enumDescriptions": [
- "Not set",
- "NoSchedule",
- "PreferNoSchedule",
- "NoExecute"
- ],
- "enum": [
- "EFFECT_UNSPECIFIED",
- "NO_SCHEDULE",
- "PREFER_NO_SCHEDULE",
- "NO_EXECUTE"
- ]
- }
- }
- },
- "SetLegacyAbacRequest": {
- "id": "SetLegacyAbacRequest",
- "description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "enabled": {
- "description": "Whether ABAC authorization will be enabled in the cluster.",
- "type": "boolean"
- },
- "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 update.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- }
- },
- "AddonsConfig": {
- "id": "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": {
- "description": "Configuration for the Kubernetes Dashboard.",
- "$ref": "KubernetesDashboard"
- }
- }
- },
- "SetLocationsRequest": {
- "description": "SetLocationsRequest sets the locations of the cluster.",
- "type": "object",
- "properties": {
- "clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "name": {
- "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "locations": {
- "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "SetLocationsRequest"
- },
- "SetNodePoolSizeRequest": {
- "description": "SetNodePoolSizeRequest sets the size a node\npool.",
- "type": "object",
- "properties": {
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "nodeCount": {
- "description": "The desired node count for the pool.",
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\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).",
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "nodePoolId": {
- "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- },
- "id": "SetNodePoolSizeRequest"
- },
- "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"
- },
- "UpdateClusterRequest": {
- "description": "UpdateClusterRequest updates the settings of a cluster.",
- "type": "object",
- "properties": {
- "clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "update": {
- "description": "A description of the update.",
- "$ref": "ClusterUpdate"
- },
- "name": {
- "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "UpdateClusterRequest"
- },
- "Cluster": {
- "id": "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"
- },
- "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": {
- "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": "The configuration options for master authorized networks feature.",
- "$ref": "MasterAuthorizedNetworksConfig"
- },
- "statusMessage": {
- "description": "[Output only] Additional information about the current status of this\ncluster, if available.",
- "type": "string"
- },
- "masterAuth": {
- "description": "The authentication information for accessing the master endpoint.",
- "$ref": "MasterAuth"
- },
- "currentMasterVersion": {
- "description": "[Output only] The current software version of the master endpoint.",
- "type": "string"
- },
- "nodeConfig": {
- "$ref": "NodeConfig",
- "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used."
- },
- "podSecurityPolicyConfig": {
- "description": "Configuration for the PodSecurityPolicy feature.",
- "$ref": "PodSecurityPolicyConfig"
- },
- "addonsConfig": {
- "$ref": "AddonsConfig",
- "description": "Configurations for the various addons available to run in the cluster."
- },
- "status": {
- "description": "[Output only] The current status of this cluster.",
- "type": "string",
- "enumDescriptions": [
- "Not set.",
- "The PROVISIONING state indicates the cluster is being created.",
- "The RUNNING state indicates the cluster has been created and is fully\nusable.",
- "The RECONCILING state indicates that some work is actively being done on\nthe cluster, such as upgrading the master or node software. Details can\nbe found in the `statusMessage` field.",
- "The STOPPING state indicates the cluster is being deleted.",
- "The ERROR state indicates the cluster may be unusable. Details\ncan be found in the `statusMessage` field."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "PROVISIONING",
- "RUNNING",
- "RECONCILING",
- "STOPPING",
- "ERROR"
- ]
- },
- "subnetwork": {
- "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected.",
- "type": "string"
- },
- "currentNodeVersion": {
- "description": "[Output only] The current version of the node software components.\nIf they are currently at multiple versions because they're in the process\nof being upgraded, this reflects the minimum version of all nodes.",
- "type": "string"
- },
- "maintenancePolicy": {
- "description": "Configure the maintenance policy for this cluster.",
- "$ref": "MaintenancePolicy"
- },
- "name": {
- "description": "The name of this cluster. The name must be unique within this project\nand zone, and can be up to 40 characters with the following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.",
- "type": "string"
- },
- "initialClusterVersion": {
- "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.",
- "type": "string"
- },
- "ipAllocationPolicy": {
- "$ref": "IPAllocationPolicy",
- "description": "Configuration for cluster IP allocation."
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "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": {
- "description": "Deprecated. Use node_pools.instance_group_urls.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "servicesIpv4Cidr": {
- "description": "[Output only] The IP address range of the Kubernetes services in\nthis cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `1.2.3.4/29`). Service addresses are\ntypically put in the last `/16` from the container CIDR.",
- "type": "string"
- },
- "networkPolicy": {
- "description": "Configuration options for the NetworkPolicy feature.",
- "$ref": "NetworkPolicy"
- },
- "enableKubernetesAlpha": {
- "description": "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. 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": {
- "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"
- }
- }
- },
- "CreateNodePoolRequest": {
- "description": "CreateNodePoolRequest creates a node pool for a cluster.",
- "type": "object",
- "properties": {
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "type": "string"
- },
- "nodePool": {
- "$ref": "NodePool",
- "description": "The node pool to create."
- },
- "parent": {
- "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
- "type": "string"
- }
- },
- "id": "CreateNodePoolRequest"
- },
- "MasterAuth": {
- "description": "The authentication information for accessing the master endpoint.\nAuthentication can be done using HTTP basic auth or using client\ncertificates.",
- "type": "object",
- "properties": {
- "clientKey": {
- "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.",
- "type": "string"
- },
- "clusterCaCertificate": {
- "description": "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster.",
- "type": "string"
- },
- "clientCertificate": {
- "description": "[Output only] Base64-encoded public certificate used by clients to\nauthenticate to the cluster endpoint.",
- "type": "string"
- },
- "username": {
- "description": "The username to use for HTTP basic authentication to the master endpoint.\nFor clusters v1.6.0 and later, you can disable basic authentication by\nproviding an empty username.",
- "type": "string"
- },
- "password": {
- "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."
- }
- },
- "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.\nIt must be in format \"HH:MM”, where HH : [00-23] and MM : [00-59] GMT.",
- "type": "string"
- },
- "duration": {
- "description": "[Output only] Duration of the time window, automatically chosen to be\nsmallest possible in the given scenario.",
- "type": "string"
- }
- },
- "id": "DailyMaintenanceWindow"
- },
- "MaintenancePolicy": {
- "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
- "type": "object",
- "properties": {
- "window": {
- "$ref": "MaintenanceWindow",
- "description": "Specifies the maintenance window in which maintenance may be performed."
- }
- },
- "id": "MaintenancePolicy"
- },
- "ClientCertificateConfig": {
- "description": "Configuration for client certificates on the cluster.",
- "type": "object",
- "properties": {
- "issueClientCertificate": {
- "description": "Issue a client certificate.",
- "type": "boolean"
- }
- },
- "id": "ClientCertificateConfig"
- },
- "SetLoggingServiceRequest": {
- "id": "SetLoggingServiceRequest",
- "description": "SetLoggingServiceRequest sets the logging service of a cluster.",
- "type": "object",
- "properties": {
- "clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "loggingService": {
- "description": "The logging service the cluster should use to write metrics.\nCurrently available options:\n\n* \"logging.googleapis.com\" - the Google Cloud Logging service\n* \"none\" - no metrics will be exported from the cluster",
- "type": "string"
- },
- "name": {
- "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string"
- }
- }
- },
- "SetMaintenancePolicyRequest": {
- "description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.",
- "type": "object",
- "properties": {
- "clusterId": {
- "description": "The name of the cluster to update.",
- "type": "string"
- },
- "maintenancePolicy": {
- "$ref": "MaintenancePolicy",
- "description": "The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy."
- },
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string"
- }
- },
- "id": "SetMaintenancePolicyRequest"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "WorkloadMetadataConfig": {
- "id": "WorkloadMetadataConfig",
- "description": "WorkloadMetadataConfig defines the metadata configuration to expose to\nworkloads on the node pool.",
- "type": "object",
- "properties": {
- "nodeMetadata": {
- "enumDescriptions": [
- "Not set.",
- "Expose only a secure subset of metadata to pods. Currently, this blocks\nkube-env, but exposes all other metadata.",
- "Expose all GCE metadata to pods."
- ],
- "enum": [
- "UNSPECIFIED",
- "SECURE",
- "EXPOSE"
- ],
- "description": "NodeMetadata is the configuration for if and how to expose the node\nmetadata to the workload running on the node.",
- "type": "string"
- }
- }
- },
- "ListNodePoolsResponse": {
- "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
- "type": "object",
- "properties": {
- "nodePools": {
- "description": "A list of node pools for a cluster.",
- "type": "array",
- "items": {
- "$ref": "NodePool"
- }
- }
- },
- "id": "ListNodePoolsResponse"
- },
- "CompleteIPRotationRequest": {
- "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.",
- "type": "object",
- "properties": {
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- },
- "id": "CompleteIPRotationRequest"
- },
- "StartIPRotationRequest": {
- "description": "StartIPRotationRequest creates a new IP for the cluster and then performs\na node upgrade on each node pool to point to the new IP.",
- "type": "object",
- "properties": {
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- },
- "id": "StartIPRotationRequest"
+ "id": "NodeConfig",
+ "description": "Parameters that describe the nodes in a cluster.",
+ "type": "object"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "canonicalName": "Container",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://container.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "container",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Kubernetes Engine API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "zones": {
- "methods": {
- "getServerconfig": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "query",
- "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
- "id": "container.projects.zones.getServerconfig",
- "description": "Returns configuration info about the Kubernetes Engine service.",
- "response": {
- "$ref": "ServerConfig"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "GET"
- }
- },
- "resources": {
- "operations": {
- "methods": {
- "cancel": {
- "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
- "id": "container.projects.zones.operations.cancel",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Cancels the specified operation.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "operationId": {
- "location": "path",
- "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel"
- },
- "list": {
- "path": "v1beta1/projects/{projectId}/zones/{zone}/operations",
- "id": "container.projects.zones.operations.list",
- "description": "Lists all operations in a project in a specific zone or all zones.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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": {
- "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",
- "location": "path"
- },
- "parent": {
- "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations"
- },
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "query",
- "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
- "type": "string"
- },
- "operationId": {
- "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}",
- "id": "container.projects.zones.operations.get",
- "description": "Gets the specified operation.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "httpMethod": "GET"
- }
- }
- },
- "clusters": {
- "methods": {
- "monitoring": {
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
- "id": "container.projects.zones.clusters.monitoring",
- "description": "Sets the monitoring service of a specific cluster.",
- "request": {
- "$ref": "SetMonitoringServiceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring"
- },
- "master": {
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
- "id": "container.projects.zones.clusters.master",
- "description": "Updates the master of a specific cluster.",
- "request": {
- "$ref": "UpdateMasterRequest"
- },
- "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 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).",
- "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}/master"
- },
- "setMasterAuth": {
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
- "id": "container.projects.zones.clusters.setMasterAuth",
- "request": {
- "$ref": "SetMasterAuthRequest"
- },
- "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST"
- },
- "logging": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
- "id": "container.projects.zones.clusters.logging",
- "request": {
- "$ref": "SetLoggingServiceRequest"
- },
- "description": "Sets the logging service of a specific cluster."
- },
- "list": {
- "response": {
- "$ref": "ListClustersResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string"
- },
- "zone": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
- "id": "container.projects.zones.clusters.list",
- "description": "Lists all clusters owned by a project in either the specified zone or all\nzones."
- },
- "create": {
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
- "id": "container.projects.zones.clusters.create",
- "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
- "request": {
- "$ref": "CreateClusterRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\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"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters"
- },
- "resourceLabels": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "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"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "id": "container.projects.zones.clusters.resourceLabels",
- "request": {
- "$ref": "SetLabelsRequest"
- },
- "description": "Sets labels on a cluster."
- },
- "completeIpRotation": {
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
- "id": "container.projects.zones.clusters.completeIpRotation",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
- "request": {
- "$ref": "CompleteIPRotationRequest"
- },
- "description": "Completes master IP rotation.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- }
- },
- "setNetworkPolicy": {
- "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": {
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
- "id": "container.projects.zones.clusters.setNetworkPolicy",
- "description": "Enables/Disables Network Policy for a cluster.",
- "request": {
- "$ref": "SetNetworkPolicyRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST"
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "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"
- },
- "get": {
- "description": "Gets the details of a specific cluster.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster) of the cluster to retrieve.\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": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.get",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"
- },
- "startIpRotation": {
- "parameters": {
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
- "id": "container.projects.zones.clusters.startIpRotation",
- "request": {
- "$ref": "StartIPRotationRequest"
- },
- "description": "Start master IP rotation.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST"
- },
- "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",
- "parameters": {
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to update.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy"
- },
- "addons": {
- "parameters": {
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
- "id": "container.projects.zones.clusters.addons",
- "request": {
- "$ref": "SetAddonsConfigRequest"
- },
- "description": "Sets the addons of a specific cluster.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST"
- },
- "delete": {
- "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"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "query",
- "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"
- },
- "locations": {
- "request": {
- "$ref": "SetLocationsRequest"
- },
- "description": "Sets the locations of a specific cluster.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster 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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
- "id": "container.projects.zones.clusters.locations"
- },
- "update": {
- "request": {
- "$ref": "UpdateClusterRequest"
- },
- "description": "Updates the settings of a specific cluster.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.update"
- }
- },
- "resources": {
- "nodePools": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "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."
- },
- "setManagement": {
- "parameters": {
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
- "id": "container.projects.zones.clusters.nodePools.setManagement",
- "request": {
- "$ref": "SetNodePoolManagementRequest"
- },
- "description": "Sets the NodeManagement options for a node pool.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "POST"
- },
- "setSize": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\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"
- },
- "nodePoolId": {
- "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
- "id": "container.projects.zones.clusters.nodePools.setSize",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
- "description": "Sets the size of a specific node pool.",
- "request": {
- "$ref": "SetNodePoolSizeRequest"
- }
- },
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string"
- },
- "parent": {
- "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "id": "container.projects.zones.clusters.nodePools.list",
- "description": "Lists the node pools for a cluster.",
- "response": {
- "$ref": "ListNodePoolsResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "GET"
- },
- "rollback": {
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
- "id": "container.projects.zones.clusters.nodePools.rollback",
- "request": {
- "$ref": "RollbackNodePoolUpgradeRequest"
- },
- "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "clusterId": {
- "description": "The name of the cluster to rollback.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "nodePoolId": {
- "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback"
- },
- "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": {
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster.\nThis field is deprecated, use parent 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 parent instead.",
- "required": true,
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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"
- },
- "autoscaling": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "nodePoolId": {
- "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
- "id": "container.projects.zones.clusters.nodePools.autoscaling",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
- "request": {
- "$ref": "SetNodePoolAutoscalingRequest"
- },
- "description": "Sets the autoscaling settings of a specific node pool."
- },
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "name": {
- "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string",
- "location": "query"
- },
- "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}/nodePools/{nodePoolId}",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "id": "container.projects.zones.clusters.nodePools.get",
- "description": "Retrieves the node pool requested.",
- "response": {
- "$ref": "NodePool"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "GET"
- },
- "update": {
- "request": {
- "$ref": "UpdateNodePoolRequest"
- },
- "description": "Updates the version and/or iamge type of a specific node pool.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
- "id": "container.projects.zones.clusters.nodePools.update",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update"
- }
- }
- }
- }
- }
- }
- },
- "locations": {
- "methods": {
- "getServerConfig": {
- "parameters": {
- "name": {
- "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "projectId": {
- "location": "query",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig",
- "path": "v1beta1/{+name}/serverConfig",
- "id": "container.projects.locations.getServerConfig",
- "description": "Returns configuration info about the Kubernetes Engine service.",
- "response": {
- "$ref": "ServerConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET"
- }
- },
- "resources": {
- "operations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
- "type": "string"
- },
- "zone": {
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
- "path": "v1beta1/{+parent}/operations",
- "id": "container.projects.locations.operations.list",
- "description": "Lists all operations in a project in a specific zone or all zones."
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
- "location": "path"
- },
- "operationId": {
- "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "location": "query",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "zone": {
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
- "path": "v1beta1/{+name}",
- "id": "container.projects.locations.operations.get",
- "description": "Gets the specified operation."
- },
- "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",
- "path": "v1beta1/{+name}:cancel",
- "id": "container.projects.locations.operations.cancel"
- }
- }
- },
- "clusters": {
- "methods": {
- "create": {
- "path": "v1beta1/{+parent}/clusters",
- "id": "container.projects.locations.clusters.create",
- "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
- "request": {
- "$ref": "CreateClusterRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters"
- },
- "completeIpRotation": {
- "request": {
- "$ref": "CompleteIPRotationRequest"
- },
- "description": "Completes master IP rotation.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "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/*'.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation",
- "path": "v1beta1/{+name}:completeIpRotation",
- "id": "container.projects.locations.clusters.completeIpRotation"
- },
- "get": {
- "description": "Gets the details of a specific cluster.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Cluster"
- },
- "parameters": {
- "clusterId": {
- "location": "query",
- "description": "The name of the cluster to retrieve.\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 retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "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.",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "location": "query",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
- "id": "container.projects.locations.clusters.get",
- "path": "v1beta1/{+name}"
- },
- "setNetworkPolicy": {
- "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",
- "request": {
- "$ref": "SetNetworkPolicyRequest"
- },
- "description": "Enables/Disables Network Policy for a cluster.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST"
- },
- "setAddons": {
- "path": "v1beta1/{+name}:setAddons",
- "id": "container.projects.locations.clusters.setAddons",
- "request": {
- "$ref": "SetAddonsConfigRequest"
- },
- "description": "Sets the addons of a specific cluster.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "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/*'.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setAddons"
- },
- "startIpRotation": {
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation",
- "id": "container.projects.locations.clusters.startIpRotation",
- "path": "v1beta1/{+name}:startIpRotation",
- "request": {
- "$ref": "StartIPRotationRequest"
- },
- "description": "Start master IP rotation.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- }
- },
- "setMonitoring": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring",
- "path": "v1beta1/{+name}:setMonitoring",
- "id": "container.projects.locations.clusters.setMonitoring",
- "request": {
- "$ref": "SetMonitoringServiceRequest"
- },
- "description": "Sets the monitoring service of a specific cluster."
- },
- "setMaintenancePolicy": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy",
- "path": "v1beta1/{+name}:setMaintenancePolicy",
- "id": "container.projects.locations.clusters.setMaintenancePolicy",
- "description": "Sets the maintenance policy for a cluster.",
- "request": {
- "$ref": "SetMaintenancePolicyRequest"
- }
- },
- "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",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "clusterId": {
- "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
- "id": "container.projects.locations.clusters.delete",
- "path": "v1beta1/{+name}"
- },
- "setLegacyAbac": {
- "path": "v1beta1/{+name}:setLegacyAbac",
- "id": "container.projects.locations.clusters.setLegacyAbac",
- "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
- "request": {
- "$ref": "SetLegacyAbacRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac"
- },
- "setResourceLabels": {
- "path": "v1beta1/{+name}:setResourceLabels",
- "id": "container.projects.locations.clusters.setResourceLabels",
- "description": "Sets labels on a cluster.",
- "request": {
- "$ref": "SetLabelsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels"
- },
- "updateMaster": {
- "request": {
- "$ref": "UpdateMasterRequest"
- },
- "description": "Updates the master of a specific cluster.",
- "httpMethod": "POST",
- "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"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:updateMaster",
- "id": "container.projects.locations.clusters.updateMaster",
- "path": "v1beta1/{+name}:updateMaster"
- },
- "setLocations": {
- "id": "container.projects.locations.clusters.setLocations",
- "path": "v1beta1/{+name}:setLocations",
- "request": {
- "$ref": "SetLocationsRequest"
- },
- "description": "Sets the locations of a specific cluster.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations"
- },
- "update": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
- "path": "v1beta1/{+name}",
- "id": "container.projects.locations.clusters.update",
- "description": "Updates the settings of a specific cluster.",
- "request": {
- "$ref": "UpdateClusterRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT"
- },
- "setMasterAuth": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string"
- }
- },
- "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": "SetMasterAuthRequest"
- }
- },
- "setLogging": {
- "description": "Sets the logging service of a specific cluster.",
- "request": {
- "$ref": "SetLoggingServiceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLogging",
- "path": "v1beta1/{+name}:setLogging",
- "id": "container.projects.locations.clusters.setLogging"
- },
- "list": {
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "query",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
- "type": "string"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
- "path": "v1beta1/{+parent}/clusters",
- "id": "container.projects.locations.clusters.list",
- "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.",
- "response": {
- "$ref": "ListClustersResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET"
- }
- },
- "resources": {
- "nodePools": {
- "methods": {
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "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"
- }
- },
- "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": {
- "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": {
- "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.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "nodePoolId": {
- "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
- "path": "v1beta1/{+name}",
- "id": "container.projects.locations.clusters.nodePools.get",
- "description": "Retrieves the node pool requested."
- },
- "update": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster, node pool) of the node pool to update.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
- "path": "v1beta1/{+name}",
- "id": "container.projects.locations.clusters.nodePools.update",
- "description": "Updates the version and/or iamge type of a specific node pool.",
- "request": {
- "$ref": "UpdateNodePoolRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT"
- },
- "setAutoscaling": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling",
- "id": "container.projects.locations.clusters.nodePools.setAutoscaling",
- "path": "v1beta1/{+name}:setAutoscaling",
- "description": "Sets the autoscaling settings of a specific node pool.",
- "request": {
- "$ref": "SetNodePoolAutoscalingRequest"
- }
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterId": {
- "location": "query",
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "nodePoolId": {
- "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "query",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "zone": {
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
- "path": "v1beta1/{+name}",
- "id": "container.projects.locations.clusters.nodePools.delete",
- "description": "Deletes a node pool from a cluster."
- },
- "setSize": {
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\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}:setSize",
- "path": "v1beta1/{+name}:setSize",
- "id": "container.projects.locations.clusters.nodePools.setSize",
- "request": {
- "$ref": "SetNodePoolSizeRequest"
- },
- "description": "Sets the size of a specific node pool.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST"
- },
- "setManagement": {
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement",
- "path": "v1beta1/{+name}:setManagement",
- "id": "container.projects.locations.clusters.nodePools.setManagement",
- "request": {
- "$ref": "SetNodePoolManagementRequest"
- },
- "description": "Sets the NodeManagement options for a node pool.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST"
- },
- "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",
- "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": {
- "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/*'.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools"
- },
- "rollback": {
- "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
- "request": {
- "$ref": "RollbackNodePoolUpgradeRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback",
- "path": "v1beta1/{+name}:rollback",
- "id": "container.projects.locations.clusters.nodePools.rollback"
- }
- }
- }
- }
- }
- }
- }
- }
- }
+ "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/dataflow/v1b3/dataflow-api.json b/dataflow/v1b3/dataflow-api.json
index ee4fb8d..bd24c7b 100644
--- a/dataflow/v1b3/dataflow-api.json
+++ b/dataflow/v1b3/dataflow-api.json
@@ -1,74 +1,18 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/userinfo.email": {
- "description": "View your email address"
- },
- "https://www.googleapis.com/auth/compute.readonly": {
- "description": "View your Google Compute Engine resources"
- },
- "https://www.googleapis.com/auth/compute": {
- "description": "View and manage your Google Compute Engine resources"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "description": "Manages Google Cloud Dataflow projects on Google Cloud Platform.",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "rootUrl": "https://dataflow.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "dataflow",
- "batchPath": "batch",
- "revision": "20180118",
- "documentationLink": "https://cloud.google.com/dataflow",
- "id": "dataflow:v1b3",
- "title": "Google Dataflow API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
"projects": {
- "methods": {
- "workerMessages": {
- "parameters": {
- "projectId": {
- "description": "The project to send the WorkerMessages to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/WorkerMessages",
- "id": "dataflow.projects.workerMessages",
- "path": "v1b3/projects/{projectId}/WorkerMessages",
- "request": {
- "$ref": "SendWorkerMessagesRequest"
- },
- "description": "Send a worker_message to the service.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "SendWorkerMessagesResponse"
- }
- }
- },
"resources": {
"templates": {
"methods": {
"launch": {
+ "path": "v1b3/projects/{projectId}/templates:launch",
+ "id": "dataflow.projects.templates.launch",
+ "description": "Launch a template.",
+ "request": {
+ "$ref": "LaunchTemplateParameters"
+ },
"response": {
"$ref": "LaunchTemplateResponse"
},
@@ -83,35 +27,29 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
+ "validateOnly": {
+ "location": "query",
+ "description": "If true, the request is validated but not actually executed.\nDefaults to false.",
+ "type": "boolean"
+ },
+ "projectId": {
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
"gcsPath": {
"location": "query",
"description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.",
"type": "string"
},
"location": {
+ "location": "query",
"description": "The location to which to direct the request.",
- "type": "string",
- "location": "query"
- },
- "validateOnly": {
- "description": "If true, the request is validated but not actually executed.\nDefaults to false.",
- "type": "boolean",
- "location": "query"
- },
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Required. The ID of the Cloud Platform project that the job belongs to."
+ "type": "string"
}
},
- "flatPath": "v1b3/projects/{projectId}/templates:launch",
- "path": "v1b3/projects/{projectId}/templates:launch",
- "id": "dataflow.projects.templates.launch",
- "description": "Launch a template.",
- "request": {
- "$ref": "LaunchTemplateParameters"
- }
+ "flatPath": "v1b3/projects/{projectId}/templates:launch"
},
"get": {
"response": {
@@ -121,7 +59,23 @@
"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": {
+ "gcsPath": {
+ "location": "query",
+ "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The location to which to direct the request.",
+ "type": "string",
+ "location": "query"
+ },
"projectId": {
"location": "path",
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
@@ -129,40 +83,24 @@
"type": "string"
},
"view": {
+ "location": "query",
"enum": [
"METADATA_ONLY"
],
"description": "The view to retrieve. Defaults to METADATA_ONLY.",
- "type": "string",
- "location": "query"
- },
- "gcsPath": {
- "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
- "type": "string",
- "location": "query"
- },
- "location": {
- "type": "string",
- "location": "query",
- "description": "The location to which to direct the request."
+ "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:get",
"path": "v1b3/projects/{projectId}/templates:get",
"id": "dataflow.projects.templates.get",
"description": "Get the template associated with a template."
},
"create": {
- "description": "Creates a Cloud Dataflow job from a template.",
"request": {
"$ref": "CreateJobFromTemplateRequest"
},
+ "description": "Creates a Cloud Dataflow job from a template.",
"httpMethod": "POST",
"parameterOrder": [
"projectId"
@@ -170,12 +108,6 @@
"response": {
"$ref": "Job"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
"parameters": {
"projectId": {
"location": "path",
@@ -184,6 +116,12 @@
"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",
"id": "dataflow.projects.templates.create",
"path": "v1b3/projects/{projectId}/templates"
@@ -191,51 +129,95 @@
}
},
"locations": {
- "methods": {
- "workerMessages": {
- "response": {
- "$ref": "SendWorkerMessagesResponse"
- },
- "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": {
- "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"
- }
- }
- },
"resources": {
"templates": {
"methods": {
+ "create": {
+ "description": "Creates a Cloud Dataflow job from a template.",
+ "request": {
+ "$ref": "CreateJobFromTemplateRequest"
+ },
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "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"
+ },
+ "launch": {
+ "path": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
+ "id": "dataflow.projects.locations.templates.launch",
+ "description": "Launch a template.",
+ "request": {
+ "$ref": "LaunchTemplateParameters"
+ },
+ "response": {
+ "$ref": "LaunchTemplateResponse"
+ },
+ "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": {
+ "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"
+ },
+ "validateOnly": {
+ "description": "If true, the request is validated but not actually executed.\nDefaults to false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:launch"
+ },
"get": {
"description": "Get the template associated with a template.",
- "httpMethod": "GET",
"response": {
"$ref": "GetTemplateResponse"
},
@@ -243,13 +225,14 @@
"projectId",
"location"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
- "location": {
- "location": "path",
- "description": "The location to which to direct the request.",
- "required": true,
- "type": "string"
- },
"projectId": {
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
"required": true,
@@ -265,86 +248,8 @@
"type": "string"
},
"gcsPath": {
- "type": "string",
"location": "query",
- "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:get",
- "id": "dataflow.projects.locations.templates.get",
- "path": "v1b3/projects/{projectId}/locations/{location}/templates:get"
- },
- "create": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "location": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The location to which to direct the request."
- }
- },
- "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": {
- "validateOnly": {
- "location": "query",
- "description": "If true, the request is validated but not actually executed.\nDefaults to false.",
- "type": "boolean"
- },
- "projectId": {
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "gcsPath": {
- "location": "query",
- "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.",
+ "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": {
@@ -354,25 +259,282 @@
"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}/templates:launch",
- "id": "dataflow.projects.locations.templates.launch",
- "path": "v1b3/projects/{projectId}/locations/{location}/templates:launch"
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:get",
+ "path": "v1b3/projects/{projectId}/locations/{location}/templates:get",
+ "id": "dataflow.projects.locations.templates.get"
}
}
},
"jobs": {
+ "resources": {
+ "debug": {
+ "methods": {
+ "getConfig": {
+ "response": {
+ "$ref": "GetDebugConfigResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "description": "The job id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "location": {
+ "location": "path",
+ "description": "The location which contains the job specified by job_id.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig",
+ "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."
+ },
+ "sendCapture": {
+ "response": {
+ "$ref": "SendDebugCaptureResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "location": {
+ "description": "The location which contains the job specified by job_id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job id.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture",
+ "id": "dataflow.projects.locations.jobs.debug.sendCapture",
+ "description": "Send encoded debug capture data for component.",
+ "request": {
+ "$ref": "SendDebugCaptureRequest"
+ }
+ }
+ }
+ },
+ "workItems": {
+ "methods": {
+ "lease": {
+ "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": {
+ "location": "path",
+ "description": "Identifies the project this worker belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "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",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
+ "id": "dataflow.projects.locations.jobs.workItems.lease",
+ "request": {
+ "$ref": "LeaseWorkItemRequest"
+ },
+ "description": "Leases a dataflow WorkItem to run."
+ },
+ "reportStatus": {
+ "id": "dataflow.projects.locations.jobs.workItems.reportStatus",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus",
+ "request": {
+ "$ref": "ReportWorkItemStatusRequest"
+ },
+ "description": "Reports the status of dataflow WorkItems leased by a worker.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "ReportWorkItemStatusResponse"
+ },
+ "parameters": {
+ "location": {
+ "description": "The location which contains 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"
+ }
+ },
+ "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:reportStatus"
+ }
+ }
+ },
+ "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"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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": {
+ "description": "The location which contains the job specified by job_id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "startTime": {
+ "location": "query",
+ "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "minimumImportance": {
+ "enum": [
+ "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
+ "JOB_MESSAGE_DEBUG",
+ "JOB_MESSAGE_DETAILED",
+ "JOB_MESSAGE_BASIC",
+ "JOB_MESSAGE_WARNING",
+ "JOB_MESSAGE_ERROR"
+ ],
+ "description": "Filter to only get messages with importance \u003e= level",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "description": "A project id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "description": "The job to get messages about.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages"
+ }
+ }
+ }
+ },
"methods": {
"getMetrics": {
- "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"
},
@@ -382,7 +544,19 @@
"jobId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
+ "location": {
+ "location": "path",
+ "description": "The location which contains the job specified by job_id.",
+ "required": true,
+ "type": "string"
+ },
"startTime": {
"location": "query",
"description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.",
@@ -396,28 +570,21 @@
"location": "path"
},
"jobId": {
- "location": "path",
"description": "The job to get messages for.",
"required": true,
- "type": "string"
- },
- "location": {
- "location": "path",
- "description": "The location which contains the job specified by job_id.",
- "required": true,
- "type": "string"
+ "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}/metrics",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
+ "id": "dataflow.projects.locations.jobs.getMetrics",
+ "description": "Request the job status."
},
"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.",
- "httpMethod": "GET",
"response": {
"$ref": "Job"
},
@@ -426,6 +593,13 @@
"location",
"jobId"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
"location": {
"description": "The location that contains this job.",
@@ -434,10 +608,10 @@
"location": "path"
},
"projectId": {
- "location": "path",
"description": "The ID of the Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"jobId": {
"location": "path",
@@ -446,7 +620,6 @@
"type": "string"
},
"view": {
- "location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
"JOB_VIEW_SUMMARY",
@@ -454,18 +627,11 @@
"JOB_VIEW_DESCRIPTION"
],
"description": "The level of information requested in response.",
- "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}/locations/{location}/jobs/{jobId}",
- "id": "dataflow.projects.locations.jobs.get",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}"
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}"
},
"list": {
"response": {
@@ -476,24 +642,7 @@
"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": {
- "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.",
@@ -518,29 +667,40 @@
"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",
- "location": "query"
+ "type": "string"
},
"pageSize": {
- "type": "integer",
"location": "query",
"description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
+ },
+ "view": {
+ "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"
}
},
+ "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": {
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
- "id": "dataflow.projects.locations.jobs.update",
- "description": "Updates the state of an existing Cloud Dataflow job.",
- "request": {
- "$ref": "Job"
- },
"response": {
"$ref": "Job"
},
@@ -550,19 +710,7 @@
"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": "path",
- "description": "The location that contains this job.",
- "required": true,
- "type": "string"
- },
"projectId": {
"location": "path",
"description": "The ID of the Cloud Platform project that the job belongs to.",
@@ -574,53 +722,12 @@
"required": true,
"type": "string",
"location": "path"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}"
- },
- "create": {
- "id": "dataflow.projects.locations.jobs.create",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "request": {
- "$ref": "Job"
- },
- "description": "Creates a Cloud Dataflow job.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "response": {
- "$ref": "Job"
- },
- "parameters": {
- "projectId": {
- "description": "The ID of the Cloud Platform project that the job belongs to.",
+ },
+ "location": {
+ "description": "The location that contains this job.",
"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": {
- "location": "path",
- "description": "The location that contains this job.",
- "required": true,
- "type": "string"
- },
- "replaceJobId": {
- "description": "Deprecated. This field is now in the Job message.",
- "type": "string",
- "location": "query"
}
},
"scopes": [
@@ -629,289 +736,86 @@
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs"
- }
- },
- "resources": {
- "debug": {
- "methods": {
- "getConfig": {
- "request": {
- "$ref": "GetDebugConfigRequest"
- },
- "description": "Get encoded debug configuration for component. Not cacheable.",
- "response": {
- "$ref": "GetDebugConfigResponse"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project id.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "location": "path",
- "description": "The job id.",
- "required": true,
- "type": "string"
- },
- "location": {
- "description": "The location which contains the job specified by 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/getConfig",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig",
- "id": "dataflow.projects.locations.jobs.debug.getConfig"
- },
- "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"
- },
- "response": {
- "$ref": "SendDebugCaptureResponse"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "description": "The project id.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "location": "path",
- "description": "The job id.",
- "required": true,
- "type": "string"
- },
- "location": {
- "location": "path",
- "description": "The location which contains the job specified by job_id.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture"
- }
- }
+ "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."
},
- "workItems": {
- "methods": {
- "reportStatus": {
- "description": "Reports the status of dataflow WorkItems leased by a worker.",
- "request": {
- "$ref": "ReportWorkItemStatusRequest"
- },
- "response": {
- "$ref": "ReportWorkItemStatusResponse"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "description": "The project which owns the WorkItem's job.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "location": "path",
- "description": "The job which the WorkItem is part of.",
- "required": true,
- "type": "string"
- },
- "location": {
- "description": "The location which contains the WorkItem's job.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus",
- "id": "dataflow.projects.locations.jobs.workItems.reportStatus"
+ "create": {
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Creates a Cloud Dataflow job.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "replaceJobId": {
+ "location": "query",
+ "description": "Deprecated. This field is now in the Job message.",
+ "type": "string"
},
- "lease": {
- "request": {
- "$ref": "LeaseWorkItemRequest"
- },
- "description": "Leases a dataflow WorkItem to run.",
- "response": {
- "$ref": "LeaseWorkItemResponse"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
+ "projectId": {
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "view": {
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Identifies the project this worker belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "description": "Identifies the workflow job this worker belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "location": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The location which contains the WorkItem's 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}/workItems:lease",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
- "id": "dataflow.projects.locations.jobs.workItems.lease"
+ "description": "The level of information requested in response.",
+ "type": "string",
+ "location": "query"
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
- }
- },
- "messages": {
- "methods": {
- "list": {
- "parameters": {
- "jobId": {
- "location": "path",
- "description": "The job to get messages about.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "A project id.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "location": {
- "location": "path",
- "description": "The location which contains the job specified by job_id.",
- "required": true,
- "type": "string"
- },
- "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"
- },
- "startTime": {
- "location": "query",
- "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
- "format": "google-datetime",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.",
- "format": "int32",
- "type": "integer"
- },
- "minimumImportance": {
- "description": "Filter to only get messages with importance \u003e= level",
- "type": "string",
- "location": "query",
- "enum": [
- "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
- "JOB_MESSAGE_DEBUG",
- "JOB_MESSAGE_DETAILED",
- "JOB_MESSAGE_BASIC",
- "JOB_MESSAGE_WARNING",
- "JOB_MESSAGE_ERROR"
- ]
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
- "id": "dataflow.projects.locations.jobs.messages.list",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
- "description": "Request the job status.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListJobMessagesResponse"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ]
- }
- }
+ },
+ "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"
}
}
}
- }
- },
- "jobs": {
+ },
"methods": {
- "aggregated": {
+ "workerMessages": {
+ "path": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages",
+ "id": "dataflow.projects.locations.workerMessages",
+ "description": "Send a worker_message to the service.",
+ "request": {
+ "$ref": "SendWorkerMessagesRequest"
+ },
"response": {
- "$ref": "ListJobsResponse"
+ "$ref": "SendWorkerMessagesResponse"
},
"parameterOrder": [
- "projectId"
+ "projectId",
+ "location"
],
- "httpMethod": "GET",
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
@@ -919,6 +823,40 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
+ "projectId": {
+ "description": "The project to send the WorkerMessages to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "location": {
+ "location": "path",
+ "description": "The location which contains the job",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages"
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
+ "aggregated": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project which owns the jobs.",
+ "required": true,
+ "type": "string"
+ },
"filter": {
"location": "query",
"enum": [
@@ -931,14 +869,14 @@
"type": "string"
},
"location": {
- "location": "query",
"description": "The location that contains this job.",
- "type": "string"
+ "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"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -947,7 +885,6 @@
"type": "integer"
},
"view": {
- "location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
"JOB_VIEW_SUMMARY",
@@ -955,18 +892,19 @@
"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"
+ "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:aggregated",
- "path": "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": {
@@ -978,16 +916,32 @@
],
"httpMethod": "GET",
"parameters": {
- "pageToken": {
+ "filter": {
"location": "query",
- "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.",
+ "enum": [
+ "UNKNOWN",
+ "ALL",
+ "TERMINATED",
+ "ACTIVE"
+ ],
+ "description": "The kind of filter to use.",
"type": "string"
},
- "pageSize": {
+ "location": {
"location": "query",
+ "description": "The location that contains this job.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ "type": "integer",
+ "location": "query"
},
"view": {
"location": "query",
@@ -1005,22 +959,6 @@
"description": "The project which owns the jobs.",
"required": true,
"type": "string"
- },
- "filter": {
- "description": "The kind of filter to use.",
- "type": "string",
- "location": "query",
- "enum": [
- "UNKNOWN",
- "ALL",
- "TERMINATED",
- "ACTIVE"
- ]
- },
- "location": {
- "location": "query",
- "description": "The location that contains this job.",
- "type": "string"
}
},
"scopes": [
@@ -1042,15 +980,25 @@
"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": {
+ "location": "query",
+ "description": "Deprecated. This field is now in the Job message.",
+ "type": "string"
+ },
"projectId": {
+ "location": "path",
"description": "The ID of the Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"view": {
- "location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
"JOB_VIEW_SUMMARY",
@@ -1058,37 +1006,24 @@
"JOB_VIEW_DESCRIPTION"
],
"description": "The level of information requested in response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"location": {
- "location": "query",
"description": "The location that contains this job.",
- "type": "string"
- },
- "replaceJobId": {
- "location": "query",
- "description": "Deprecated. This field is now in the Job message.",
- "type": "string"
+ "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",
"path": "v1b3/projects/{projectId}/jobs",
"id": "dataflow.projects.jobs.create",
+ "description": "Creates a Cloud Dataflow job.",
"request": {
"$ref": "Job"
- },
- "description": "Creates a Cloud Dataflow job."
+ }
},
"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"
@@ -1098,42 +1033,42 @@
"jobId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
"parameters": {
+ "location": {
+ "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",
- "location": "path"
+ "type": "string"
},
"jobId": {
"description": "The job to get messages for.",
"required": true,
"type": "string",
"location": "path"
- },
- "location": {
- "location": "query",
- "description": "The location which contains the job specified by job_id.",
- "type": "string"
- },
- "startTime": {
- "type": "string",
- "location": "query",
- "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.",
- "format": "google-datetime"
}
- }
+ },
+ "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",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
+ "id": "dataflow.projects.jobs.getMetrics"
},
"get": {
- "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.",
"response": {
"$ref": "Job"
@@ -1150,16 +1085,11 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
- "location": {
- "description": "The location that contains this job.",
- "type": "string",
- "location": "query"
- },
"projectId": {
+ "location": "path",
"description": "The ID of the Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"jobId": {
"description": "The job ID.",
@@ -1177,35 +1107,37 @@
"description": "The level of information requested in response.",
"type": "string",
"location": "query"
+ },
+ "location": {
+ "location": "query",
+ "description": "The location that contains this job.",
+ "type": "string"
}
- }
+ },
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}",
+ "id": "dataflow.projects.jobs.get"
},
"update": {
- "path": "v1b3/projects/{projectId}/jobs/{jobId}",
"id": "dataflow.projects.jobs.update",
- "description": "Updates the state of an existing Cloud Dataflow job.",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}",
"request": {
"$ref": "Job"
},
- "response": {
- "$ref": "Job"
- },
+ "description": "Updates the state of an existing Cloud Dataflow job.",
+ "httpMethod": "PUT",
"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"
- ],
+ "response": {
+ "$ref": "Job"
+ },
"parameters": {
"location": {
- "type": "string",
"location": "query",
- "description": "The location that contains this job."
+ "description": "The location that contains this job.",
+ "type": "string"
},
"projectId": {
"location": "path",
@@ -1220,6 +1152,12 @@
"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}"
}
},
@@ -1231,20 +1169,20 @@
"$ref": "GetDebugConfigRequest"
},
"description": "Get encoded debug configuration for component. Not cacheable.",
- "response": {
- "$ref": "GetDebugConfigResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"jobId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "GetDebugConfigResponse"
+ },
"parameters": {
"projectId": {
+ "location": "path",
"description": "The project id.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"jobId": {
"location": "path",
@@ -1260,14 +1198,14 @@
"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"
+ "id": "dataflow.projects.jobs.debug.getConfig",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig"
},
"sendCapture": {
- "description": "Send encoded debug capture data for component.",
"request": {
"$ref": "SendDebugCaptureRequest"
},
+ "description": "Send encoded debug capture data for component.",
"response": {
"$ref": "SendDebugCaptureResponse"
},
@@ -1276,26 +1214,26 @@
"jobId"
],
"httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "description": "The job id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "parameters": {
- "projectId": {
- "description": "The project id.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "location": "path",
- "description": "The job id.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
"path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
"id": "dataflow.projects.jobs.debug.sendCapture"
@@ -1305,26 +1243,26 @@
"workItems": {
"methods": {
"reportStatus": {
- "response": {
- "$ref": "ReportWorkItemStatusResponse"
+ "id": "dataflow.projects.jobs.workItems.reportStatus",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
+ "request": {
+ "$ref": "ReportWorkItemStatusRequest"
},
+ "description": "Reports the status of dataflow WorkItems leased by a worker.",
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"jobId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
+ "response": {
+ "$ref": "ReportWorkItemStatusResponse"
+ },
"parameters": {
"projectId": {
- "location": "path",
"description": "The project which owns the WorkItem's job.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"jobId": {
"description": "The job which the WorkItem is part of.",
@@ -1333,21 +1271,21 @@
"location": "path"
}
},
- "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"
- }
+ "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"
},
"lease": {
"path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
"id": "dataflow.projects.jobs.workItems.lease",
+ "description": "Leases a dataflow WorkItem to run.",
"request": {
"$ref": "LeaseWorkItemRequest"
},
- "description": "Leases a dataflow WorkItem to run.",
"response": {
"$ref": "LeaseWorkItemResponse"
},
@@ -1356,12 +1294,18 @@
"jobId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
"projectId": {
- "location": "path",
"description": "Identifies the project this worker belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"jobId": {
"location": "path",
@@ -1370,12 +1314,6 @@
"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:lease"
}
}
@@ -1383,6 +1321,9 @@
"messages": {
"methods": {
"list": {
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
+ "id": "dataflow.projects.jobs.messages.list",
+ "description": "Request the job status.",
"response": {
"$ref": "ListJobMessagesResponse"
},
@@ -1391,11 +1332,24 @@
"jobId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
- "location": {
+ "jobId": {
+ "description": "The job to get messages about.",
+ "required": true,
"type": "string",
- "location": "query",
- "description": "The location which contains the job specified by job_id."
+ "location": "path"
+ },
+ "projectId": {
+ "description": "A project id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
},
"endTime": {
"location": "query",
@@ -1403,6 +1357,11 @@
"format": "google-datetime",
"type": "string"
},
+ "location": {
+ "location": "query",
+ "description": "The location which contains the job specified by job_id.",
+ "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",
@@ -1415,10 +1374,10 @@
"type": "string"
},
"pageSize": {
- "location": "query",
"description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"minimumImportance": {
"location": "query",
@@ -1432,86 +1391,76 @@
],
"description": "Filter to only get messages with importance \u003e= level",
"type": "string"
- },
- "jobId": {
- "location": "path",
- "description": "The job to get messages about.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "A project id."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
- "id": "dataflow.projects.jobs.messages.list",
- "description": "Request the job status."
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/messages"
}
}
}
}
}
+ },
+ "methods": {
+ "workerMessages": {
+ "description": "Send a worker_message to the service.",
+ "request": {
+ "$ref": "SendWorkerMessagesRequest"
+ },
+ "response": {
+ "$ref": "SendWorkerMessagesResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The project to send the WorkerMessages to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/WorkerMessages",
+ "path": "v1b3/projects/{projectId}/WorkerMessages",
+ "id": "dataflow.projects.workerMessages"
+ }
}
}
},
"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.",
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
- "pp": {
- "description": "Pretty-print response.",
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
"location": "query"
},
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
"type": "string",
"location": "query"
},
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
@@ -1526,6 +1475,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",
@@ -1533,40 +1488,61 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
+ "default": "json"
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "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": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
}
},
"schemas": {
"SourceOperationResponse": {
- "description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed.",
- "type": "object",
"properties": {
"getMetadata": {
- "description": "A response to a request to get metadata about a source.",
- "$ref": "SourceGetMetadataResponse"
+ "$ref": "SourceGetMetadataResponse",
+ "description": "A response to a request to get metadata about a source."
},
"split": {
- "$ref": "SourceSplitResponse",
- "description": "A response to a request to split a source."
+ "description": "A response to a request to split a source.",
+ "$ref": "SourceSplitResponse"
}
},
- "id": "SourceOperationResponse"
+ "id": "SourceOperationResponse",
+ "description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed.",
+ "type": "object"
+ },
+ "SendDebugCaptureResponse": {
+ "properties": {},
+ "id": "SendDebugCaptureResponse",
+ "description": "Response to a send capture request.\nnothing",
+ "type": "object"
},
"SideInputInfo": {
"description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
@@ -1580,12 +1556,12 @@
}
},
"kind": {
- "description": "How to interpret the source element(s) as a side input value.",
- "type": "object",
"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.",
@@ -1594,59 +1570,54 @@
},
"id": "SideInputInfo"
},
- "SendDebugCaptureResponse": {
- "description": "Response to a send capture request.\nnothing",
- "type": "object",
- "properties": {},
- "id": "SendDebugCaptureResponse"
- },
"CounterStructuredNameAndMetadata": {
- "id": "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": {
"description": "Metadata associated with a counter",
"$ref": "CounterMetadata"
- },
- "name": {
- "description": "Structured name of the counter.",
- "$ref": "CounterStructuredName"
}
- }
+ },
+ "id": "CounterStructuredNameAndMetadata"
},
"ConcatPosition": {
- "type": "object",
"properties": {
- "position": {
- "$ref": "Position",
- "description": "Position within the inner source."
- },
"index": {
- "type": "integer",
"description": "Index of the inner source.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
+ },
+ "position": {
+ "description": "Position within the inner source.",
+ "$ref": "Position"
}
},
"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."
+ "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": {
"description": "An instruction that writes records.\nTakes one input, produces no outputs.",
"type": "object",
"properties": {
- "sink": {
- "$ref": "Sink",
- "description": "The sink to write to."
- },
"input": {
- "$ref": "InstructionInput",
- "description": "The input."
+ "description": "The input.",
+ "$ref": "InstructionInput"
+ },
+ "sink": {
+ "description": "The sink to write to.",
+ "$ref": "Sink"
}
},
"id": "WriteInstruction"
},
"StreamingComputationRanges": {
+ "description": "Describes full or partial data disk assignment information of the computation\nranges.",
"type": "object",
"properties": {
"computationId": {
@@ -1661,14 +1632,13 @@
}
}
},
- "id": "StreamingComputationRanges",
- "description": "Describes full or partial data disk assignment information of the computation\nranges."
+ "id": "StreamingComputationRanges"
},
"AutoscalingSettings": {
+ "description": "Settings for WorkerPool autoscaling.",
+ "type": "object",
"properties": {
"algorithm": {
- "description": "The algorithm to use for autoscaling.",
- "type": "string",
"enumDescriptions": [
"The algorithm is unknown, or unspecified.",
"Disable autoscaling.",
@@ -1678,37 +1648,30 @@
"AUTOSCALING_ALGORITHM_UNKNOWN",
"AUTOSCALING_ALGORITHM_NONE",
"AUTOSCALING_ALGORITHM_BASIC"
- ]
+ ],
+ "description": "The algorithm to use for autoscaling.",
+ "type": "string"
},
"maxNumWorkers": {
- "type": "integer",
"description": "The maximum number of workers to cap scaling at.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "AutoscalingSettings",
- "description": "Settings for WorkerPool autoscaling.",
- "type": "object"
+ "id": "AutoscalingSettings"
},
"ExecutionStageSummary": {
"properties": {
- "outputSource": {
- "description": "Output sources for this stage.",
- "type": "array",
- "items": {
- "$ref": "StageSource"
- }
- },
"name": {
"description": "Dataflow service generated name for this stage.",
"type": "string"
},
"inputSource": {
+ "description": "Input sources for this stage.",
"type": "array",
"items": {
"$ref": "StageSource"
- },
- "description": "Input sources for this stage."
+ }
},
"id": {
"description": "Dataflow service generated id for this stage.",
@@ -1729,6 +1692,17 @@
}
},
"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": [
@@ -1741,18 +1715,14 @@
"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"
]
+ },
+ "outputSource": {
+ "description": "Output sources for this stage.",
+ "type": "array",
+ "items": {
+ "$ref": "StageSource"
+ }
}
},
"id": "ExecutionStageSummary",
@@ -1778,10 +1748,14 @@
"id": "SendWorkerMessagesRequest"
},
"SourceSplitShard": {
- "description": "DEPRECATED in favor of DerivedSource.",
- "type": "object",
"properties": {
"derivationMode": {
+ "enumDescriptions": [
+ "The source derivation is unknown, or unspecified.",
+ "Produce a completely independent Source with no base.",
+ "Produce a Source based on the Source being split.",
+ "Produce a Source based on the base of the Source being split."
+ ],
"enum": [
"SOURCE_DERIVATION_MODE_UNKNOWN",
"SOURCE_DERIVATION_MODE_INDEPENDENT",
@@ -1789,25 +1763,24 @@
"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."
- ]
+ "type": "string"
},
"source": {
- "$ref": "Source",
- "description": "DEPRECATED"
+ "description": "DEPRECATED",
+ "$ref": "Source"
}
},
- "id": "SourceSplitShard"
+ "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",
@@ -1817,14 +1790,11 @@
"description": "Timestamp of the measurement.",
"format": "google-datetime",
"type": "string"
- },
- "totalMs": {
- "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.",
- "format": "uint64",
- "type": "string"
}
},
- "id": "CPUTime"
+ "id": "CPUTime",
+ "description": "Modeled after information exposed by /proc/stat.",
+ "type": "object"
},
"Environment": {
"description": "Describes the environment in which a Dataflow Job runs.",
@@ -1862,31 +1832,31 @@
}
},
"dataset": {
- "type": "string",
- "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}"
+ "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"
- },
- "description": "The list of experiments to enable."
+ }
},
"internalExperiments": {
- "description": "Experimental settings.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "Experimental settings.",
+ "type": "object"
},
"version": {
- "type": "object",
"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."
+ "description": "A structure describing which components and their versions of the service\nare required in order to run the job.",
+ "type": "object"
},
"serviceAccountEmail": {
"description": "Identity to run virtual machines as. Defaults to the default account.",
@@ -1896,14 +1866,20 @@
"id": "Environment"
},
"StreamingComputationTask": {
- "type": "object",
"properties": {
+ "computationRanges": {
+ "description": "Contains ranges of a streaming computation this task should apply to.",
+ "type": "array",
+ "items": {
+ "$ref": "StreamingComputationRanges"
+ }
+ },
"dataDisks": {
+ "description": "Describes the set of data disks this task should apply to.",
"type": "array",
"items": {
"$ref": "MountedDataDisk"
- },
- "description": "Describes the set of data disks this task should apply to."
+ }
},
"taskType": {
"enumDescriptions": [
@@ -1918,35 +1894,29 @@
],
"description": "A type of streaming computation task.",
"type": "string"
- },
- "computationRanges": {
- "description": "Contains ranges of a streaming computation this task should apply to.",
- "type": "array",
- "items": {
- "$ref": "StreamingComputationRanges"
- }
}
},
"id": "StreamingComputationTask",
- "description": "A task which describes what action should be performed for the specified\nstreaming computation ranges."
+ "description": "A task which describes what action should be performed for the specified\nstreaming computation ranges.",
+ "type": "object"
},
"SendDebugCaptureRequest": {
"properties": {
- "location": {
- "type": "string",
- "description": "The location which contains the job specified by job_id."
- },
"data": {
"description": "The encoded debug information.",
"type": "string"
},
"componentId": {
- "type": "string",
- "description": "The internal component id for which debug information is sent."
+ "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",
@@ -1954,7 +1924,6 @@
"type": "object"
},
"GetDebugConfigResponse": {
- "id": "GetDebugConfigResponse",
"description": "Response to a get debug configuration request.",
"type": "object",
"properties": {
@@ -1962,11 +1931,10 @@
"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.",
@@ -1977,20 +1945,18 @@
"type": "string"
},
"userName": {
- "type": "string",
- "description": "Human-readable name for this transform; may be user or system generated."
+ "description": "Human-readable name for this transform; may be user or system generated.",
+ "type": "string"
}
},
- "id": "ComponentTransform"
+ "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": {
- "streamingComputationTopology": {
- "$ref": "TopologyConfig",
- "description": "The global topology of the streaming Dataflow job."
- },
"workerHarnessPort": {
"description": "The TCP port used by the worker to communicate with the Dataflow\nworker harness.",
"format": "int32",
@@ -2001,17 +1967,18 @@
"type": "boolean"
},
"receiveWorkPort": {
- "type": "integer",
"description": "The TCP port on which the worker should listen for messages from\nother streaming computation workers.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
+ },
+ "streamingComputationTopology": {
+ "$ref": "TopologyConfig",
+ "description": "The global topology of the streaming Dataflow job."
}
},
"id": "StreamingSetupTask"
},
"PubsubLocation": {
- "id": "PubsubLocation",
- "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.",
- "type": "object",
"properties": {
"withAttributes": {
"description": "If true, then the client has requested to get pubsub attributes.",
@@ -2041,22 +2008,13 @@
"description": "If set, specifies the pubsub subscription that will be used for tracking\ncustom time timestamps for watermark estimation.",
"type": "string"
}
- }
+ },
+ "id": "PubsubLocation",
+ "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.",
+ "type": "object"
},
"WorkerHealthReport": {
- "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": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- }
- },
"vmStartupTime": {
"description": "The time the VM was booted.",
"format": "google-datetime",
@@ -2070,18 +2028,28 @@
"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"
+ },
+ "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"
+ }
}
},
"id": "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."
+ "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"
},
"JobMessage": {
- "description": "A particular message pertaining to a Dataflow job.",
- "type": "object",
"properties": {
"messageText": {
- "type": "string",
- "description": "The text of the message."
+ "description": "The text of the message.",
+ "type": "string"
},
"messageImportance": {
"enumDescriptions": [
@@ -2113,15 +2081,15 @@
"type": "string"
}
},
- "id": "JobMessage"
+ "id": "JobMessage",
+ "description": "A particular message pertaining to a Dataflow job.",
+ "type": "object"
},
"ParameterMetadata": {
- "description": "Metadata for a specific parameter.",
- "type": "object",
"properties": {
"label": {
- "type": "string",
- "description": "Required. The label to display for the parameter."
+ "description": "Required. The label to display for the parameter.",
+ "type": "string"
},
"helpText": {
"description": "Required. The help text to display for the parameter.",
@@ -2143,47 +2111,81 @@
}
}
},
- "id": "ParameterMetadata"
+ "id": "ParameterMetadata",
+ "description": "Metadata for a specific parameter.",
+ "type": "object"
},
"MultiOutputInfo": {
- "description": "Information about an output of a multi-output DoFn.",
- "type": "object",
"properties": {
"tag": {
"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"
+ "id": "MultiOutputInfo",
+ "description": "Information about an output of a multi-output DoFn.",
+ "type": "object"
},
"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",
"properties": {
"source": {
"$ref": "Source",
"description": "Specification of the source to be split."
},
"options": {
- "$ref": "SourceSplitOptions",
- "description": "Hints for tuning the splitting process."
+ "description": "Hints for tuning the splitting process.",
+ "$ref": "SourceSplitOptions"
}
},
- "id": "SourceSplitRequest"
+ "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": {
+ "description": "The result of a SourceGetMetadataOperation.",
"type": "object",
"properties": {
"metadata": {
- "description": "The computed metadata.",
- "$ref": "SourceMetadata"
+ "$ref": "SourceMetadata",
+ "description": "The computed metadata."
}
},
- "id": "SourceGetMetadataResponse",
- "description": "The result of a SourceGetMetadataOperation."
+ "id": "SourceGetMetadataResponse"
+ },
+ "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"
+ },
+ "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": {
- "id": "AutoscalingEvent",
"description": "A structured message reporting an autoscaling decision made by the Dataflow\nservice.",
"type": "object",
"properties": {
@@ -2211,65 +2213,31 @@
]
},
"currentNumWorkers": {
- "type": "string",
"description": "The current number of workers the job has.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"description": {
- "description": "A message describing why the system decided to adjust the current\nnumber of workers, why it failed, or why the system decided to\nnot make any changes to the number of workers.",
- "$ref": "StructuredMessage"
+ "$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"
}
- }
- },
- "MetricShortId": {
- "id": "MetricShortId",
- "description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest",
- "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"
- }
- }
- },
- "ShellTask": {
- "type": "object",
- "properties": {
- "exitCode": {
- "description": "Exit code for the task.",
- "format": "int32",
- "type": "integer"
- },
- "command": {
- "type": "string",
- "description": "The shell command to run."
- }
},
- "id": "ShellTask",
- "description": "A task which consists of a shell command for the worker to execute."
+ "id": "AutoscalingEvent"
},
"TaskRunnerSettings": {
- "description": "Taskrunner configuration settings.",
- "type": "object",
"properties": {
"alsologtostderr": {
- "type": "boolean",
- "description": "Whether to also send taskrunner log info to stderr."
+ "description": "Whether to also send taskrunner log info to stderr.",
+ "type": "boolean"
},
"taskGroup": {
- "type": "string",
- "description": "The UNIX group ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"wheel\"."
+ "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.",
@@ -2279,10 +2247,6 @@
"description": "The directory on the VM to store logs.",
"type": "string"
},
- "dataflowApiVersion": {
- "description": "The API version of endpoint, e.g. \"v1b3\"",
- "type": "string"
- },
"oauthScopes": {
"description": "The OAuth2 scopes to be requested by the taskrunner in order to\naccess the Cloud Dataflow API.",
"type": "array",
@@ -2290,21 +2254,25 @@
"type": "string"
}
},
+ "dataflowApiVersion": {
+ "description": "The API version of endpoint, e.g. \"v1b3\"",
+ "type": "string"
+ },
"logUploadLocation": {
- "type": "string",
- "description": "Indicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}"
+ "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": {
- "type": "string",
- "description": "The streaming worker main class name."
+ "description": "The streaming worker main class name.",
+ "type": "string"
},
"workflowFileName": {
"description": "The file to store the workflow in.",
"type": "string"
},
"baseTaskDir": {
- "type": "string",
- "description": "The location on the worker for task-specific subdirectories."
+ "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}",
@@ -2319,8 +2287,8 @@
"type": "string"
},
"baseUrl": {
- "type": "string",
- "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/\""
+ "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.",
@@ -2331,19 +2299,21 @@
"type": "boolean"
},
"parallelWorkerSettings": {
- "$ref": "WorkerSettings",
- "description": "The settings to pass to the parallel worker harness."
- },
- "taskUser": {
- "type": "string",
- "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\"."
+ "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"
}
},
- "id": "TaskRunnerSettings"
+ "id": "TaskRunnerSettings",
+ "description": "Taskrunner configuration settings.",
+ "type": "object"
},
"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.",
@@ -2354,8 +2324,8 @@
"type": "string"
},
"concatPosition": {
- "description": "CloudPosition is a concat position.",
- "$ref": "ConcatPosition"
+ "$ref": "ConcatPosition",
+ "description": "CloudPosition is a concat position."
},
"byteOffset": {
"description": "Position is a byte offset.",
@@ -2371,39 +2341,35 @@
"type": "string"
},
"recordIndex": {
- "type": "string",
"description": "Position is a record index.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
}
},
"id": "Position"
},
- "SplitInt64": {
- "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON.",
+ "Source": {
+ "description": "A source that records can be read and decoded from.",
"type": "object",
"properties": {
- "highBits": {
- "description": "The high order bits, including the sign: n \u003e\u003e 32.",
- "format": "int32",
- "type": "integer"
+ "baseSpecs": {
+ "description": "While splitting, sources may specify the produced bundles\nas differences against another source, in order to save backend-side\nmemory and allow bigger jobs. For details, see SourceSplitRequest.\nTo support this use case, the full set of parameters of the source\nis logically obtained by taking the latest explicitly specified value\nof each parameter in the order:\nbase_specs (later items win), spec (overrides anything in base_specs).",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "type": "object"
+ }
},
- "lowBits": {
- "description": "The low order bits: n & 0xffffffff.",
- "format": "uint32",
- "type": "integer"
- }
- },
- "id": "SplitInt64"
- },
- "Source": {
- "properties": {
"codec": {
- "type": "object",
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
+ "description": "Properties of the object.",
+ "type": "any"
},
- "description": "The codec to use to decode data read from the source."
+ "description": "The codec to use to decode data read from the source.",
+ "type": "object"
},
"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.",
@@ -2418,29 +2384,114 @@
"type": "object"
},
"metadata": {
- "$ref": "SourceMetadata",
- "description": "Optionally, metadata for this source can be supplied right away,\navoiding a SourceGetMetadataOperation roundtrip\n(see SourceOperationRequest).\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated."
- },
- "baseSpecs": {
- "description": "While splitting, sources may specify the produced bundles\nas differences against another source, in order to save backend-side\nmemory and allow bigger jobs. For details, see SourceSplitRequest.\nTo support this use case, the full set of parameters of the source\nis logically obtained by taking the latest explicitly specified value\nof each parameter in the order:\nbase_specs (later items win), spec (overrides anything in base_specs).",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- }
+ "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.",
+ "$ref": "SourceMetadata"
}
},
- "id": "Source",
- "description": "A source that records can be read and decoded from.",
- "type": "object"
+ "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": {
+ "zone": {
+ "description": "Zone to run the worker pools in. If empty or unspecified, the service\nwill attempt to choose a reasonable default.",
+ "type": "string"
+ },
+ "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"
+ },
+ "diskSourceImage": {
+ "description": "Fully qualified source image for disks.",
+ "type": "string"
+ },
+ "packages": {
+ "description": "Packages to be installed on workers.",
+ "type": "array",
+ "items": {
+ "$ref": "Package"
+ }
+ },
+ "teardownPolicy": {
+ "enum": [
+ "TEARDOWN_POLICY_UNKNOWN",
+ "TEARDOWN_ALWAYS",
+ "TEARDOWN_ON_SUCCESS",
+ "TEARDOWN_NEVER"
+ ],
+ "description": "Sets the policy for determining when to turndown worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down regardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn\ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until they are explicitly terminated by the user.\nBecause of this, Google recommends using the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jobs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonable\ndefault.",
+ "type": "string",
+ "enumDescriptions": [
+ "The teardown policy isn't specified, or is unknown.",
+ "Always teardown the resource.",
+ "Teardown the resource on success. This is useful for debugging\nfailures.",
+ "Never teardown the resource. This is useful for debugging and\ndevelopment."
+ ]
+ },
+ "onHostMaintenance": {
+ "description": "The action to take on host maintenance, as defined by the Google\nCompute Engine API.",
+ "type": "string"
+ },
+ "poolArgs": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Extra arguments for this worker pool.",
+ "type": "object"
+ },
+ "diskSizeGb": {
+ "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "workerHarnessContainerImage": {
+ "description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry.",
+ "type": "string"
+ },
+ "machineType": {
+ "description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the\nservice will attempt to choose a reasonable default.",
+ "type": "string"
+ },
+ "diskType": {
+ "description": "Type of root disk for VMs. If empty or unspecified, the service will\nattempt to choose a reasonable default.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.",
+ "type": "string"
+ },
+ "dataDisks": {
+ "description": "Data disks that are used by a VM in this workflow.",
+ "type": "array",
+ "items": {
+ "$ref": "Disk"
+ }
+ },
"subnetwork": {
"description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of\nthe form \"regions/REGION/subnetworks/SUBNETWORK\".",
"type": "string"
@@ -2468,19 +2519,13 @@
"description": "Settings for autoscaling of this WorkerPool."
},
"metadata": {
- "description": "Metadata to set on the Google Compute Engine VMs.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Metadata to set on the Google Compute Engine VMs.",
+ "type": "object"
},
"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",
@@ -2488,106 +2533,25 @@
"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"
- },
- "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.",
- "type": "string"
- },
- "packages": {
- "description": "Packages to be installed on workers.",
- "type": "array",
- "items": {
- "$ref": "Package"
- }
- },
- "teardownPolicy": {
- "type": "string",
- "enumDescriptions": [
- "The teardown policy isn't specified, or is unknown.",
- "Always teardown the resource.",
- "Teardown the resource on success. This is useful for debugging\nfailures.",
- "Never teardown the resource. This is useful for debugging and\ndevelopment."
- ],
- "enum": [
- "TEARDOWN_POLICY_UNKNOWN",
- "TEARDOWN_ALWAYS",
- "TEARDOWN_ON_SUCCESS",
- "TEARDOWN_NEVER"
- ],
- "description": "Sets the policy for determining when to turndown worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down regardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn\ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until they are explicitly terminated by the user.\nBecause of this, Google recommends using the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jobs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonable\ndefault."
- },
- "onHostMaintenance": {
- "description": "The action to take on host maintenance, as defined by the Google\nCompute Engine API.",
- "type": "string"
- },
- "poolArgs": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Extra arguments for this worker pool.",
- "type": "object"
- },
- "diskSizeGb": {
- "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
- "format": "int32",
- "type": "integer"
- },
- "workerHarnessContainerImage": {
- "type": "string",
- "description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry."
- },
- "diskType": {
- "description": "Type of root disk for VMs. If empty or unspecified, the service will\nattempt to choose a reasonable default.",
- "type": "string"
- },
- "machineType": {
- "description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the\nservice will attempt to choose a reasonable default.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.",
- "type": "string"
- },
- "dataDisks": {
- "description": "Data disks that are used by a VM in this workflow.",
- "type": "array",
- "items": {
- "$ref": "Disk"
- }
}
},
"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": {
- "getMetadata": {
- "description": "Information about a request to get metadata about a source.",
- "$ref": "SourceGetMetadataRequest"
- },
- "split": {
- "description": "Information about a request to split a source.",
- "$ref": "SourceSplitRequest"
- },
"name": {
"description": "User-provided name of the Read instruction for this source.",
"type": "string"
@@ -2603,45 +2567,27 @@
"stageName": {
"description": "System-defined name of the stage containing the source operation.\nUnique across the workflow.",
"type": "string"
+ },
+ "getMetadata": {
+ "$ref": "SourceGetMetadataRequest",
+ "description": "Information about a request to get metadata about a source."
+ },
+ "split": {
+ "description": "Information about a request to split a source.",
+ "$ref": "SourceSplitRequest"
}
},
- "id": "SourceOperationRequest",
- "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.",
- "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": {
- "messageKey": {
- "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message.",
- "type": "string"
- },
- "messageText": {
- "type": "string",
- "description": "Human-readable version of message."
- },
- "parameters": {
- "type": "array",
- "items": {
- "$ref": "Parameter"
- },
- "description": "The structured data associated with this message."
- }
- },
- "id": "StructuredMessage"
+ "id": "SourceOperationRequest"
},
"WorkItem": {
- "description": "WorkItem represents basic information about a WorkItem to be executed\nin the cloud.",
- "type": "object",
"properties": {
"configuration": {
"description": "Work item-specific configuration as an opaque blob.",
"type": "string"
},
"mapTask": {
- "$ref": "MapTask",
- "description": "Additional information for MapTask WorkItems."
+ "description": "Additional information for MapTask WorkItems.",
+ "$ref": "MapTask"
},
"seqMapTask": {
"$ref": "SeqMapTask",
@@ -2655,25 +2601,25 @@
}
},
"projectId": {
- "type": "string",
- "description": "Identifies the cloud project this WorkItem belongs to."
+ "description": "Identifies the cloud project this WorkItem belongs to.",
+ "type": "string"
},
"sourceOperationTask": {
"$ref": "SourceOperationRequest",
"description": "Additional information for source operation WorkItems."
},
+ "streamingSetupTask": {
+ "description": "Additional information for StreamingSetupTask WorkItems.",
+ "$ref": "StreamingSetupTask"
+ },
"reportStatusInterval": {
"description": "Recommended reporting interval.",
"format": "google-duration",
"type": "string"
},
- "streamingSetupTask": {
- "description": "Additional information for StreamingSetupTask WorkItems.",
- "$ref": "StreamingSetupTask"
- },
"streamingConfigTask": {
- "$ref": "StreamingConfigTask",
- "description": "Additional information for StreamingConfigTask WorkItems."
+ "description": "Additional information for StreamingConfigTask WorkItems.",
+ "$ref": "StreamingConfigTask"
},
"leaseExpireTime": {
"description": "Time when the lease on this Work will expire.",
@@ -2685,14 +2631,14 @@
"format": "int64",
"type": "string"
},
- "streamingComputationTask": {
- "description": "Additional information for StreamingComputationTask WorkItems.",
- "$ref": "StreamingComputationTask"
- },
"shellTask": {
"$ref": "ShellTask",
"description": "Additional information for ShellTask WorkItems."
},
+ "streamingComputationTask": {
+ "$ref": "StreamingComputationTask",
+ "description": "Additional information for StreamingComputationTask WorkItems."
+ },
"jobId": {
"description": "Identifies the workflow job this WorkItem belongs to.",
"type": "string"
@@ -2703,11 +2649,49 @@
"type": "string"
}
},
- "id": "WorkItem"
+ "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"
+ },
+ "parameters": {
+ "description": "The structured data associated with this message.",
+ "type": "array",
+ "items": {
+ "$ref": "Parameter"
+ }
+ },
+ "messageKey": {
+ "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message.",
+ "type": "string"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "ReportedParallelism"
},
"ResourceUtilizationReport": {
- "description": "Worker metrics exported from workers. This contains resource utilization\nmetrics accumulated from a variety of sources. For more information, see\ngo/df-resource-signals.",
- "type": "object",
"properties": {
"cpuTime": {
"description": "CPU utilization samples.",
@@ -2717,27 +2701,11 @@
}
}
},
- "id": "ResourceUtilizationReport"
- },
- "ReportedParallelism": {
- "id": "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": {
- "type": "number",
- "description": "Specifies the level of parallelism in case it is finite.",
- "format": "double"
- }
- }
+ "id": "ResourceUtilizationReport",
+ "description": "Worker metrics exported from workers. This contains resource utilization\nmetrics accumulated from a variety of sources. For more information, see\ngo/df-resource-signals.",
+ "type": "object"
},
"TopologyConfig": {
- "description": "Global topology of the streaming Dataflow job, including all\ncomputations and their sharded locations.",
- "type": "object",
"properties": {
"userStageToComputationNameMap": {
"additionalProperties": {
@@ -2747,11 +2715,11 @@
"type": "object"
},
"computations": {
+ "description": "The computations associated with a streaming Dataflow job.",
"type": "array",
"items": {
"$ref": "ComputationTopology"
- },
- "description": "The computations associated with a streaming Dataflow job."
+ }
},
"dataDiskAssignments": {
"description": "The disks assigned to a streaming Dataflow job.",
@@ -2771,12 +2739,11 @@
"type": "integer"
}
},
- "id": "TopologyConfig"
+ "id": "TopologyConfig",
+ "description": "Global topology of the streaming Dataflow job, including all\ncomputations and their sharded locations.",
+ "type": "object"
},
"SourceSplitOptions": {
- "id": "SourceSplitOptions",
- "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.",
- "type": "object",
"properties": {
"desiredBundleSizeBytes": {
"description": "The source should be split into a set of bundles where the estimated size\nof each is approximately this many bytes.",
@@ -2788,15 +2755,18 @@
"format": "int64",
"type": "string"
}
- }
+ },
+ "id": "SourceSplitOptions",
+ "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.",
+ "type": "object"
},
"ReadInstruction": {
"description": "An instruction that reads records.\nTakes no inputs, produces one output.",
"type": "object",
"properties": {
"source": {
- "$ref": "Source",
- "description": "The source to read from."
+ "description": "The source to read from.",
+ "$ref": "Source"
}
},
"id": "ReadInstruction"
@@ -2805,6 +2775,18 @@
"description": "Provides data to pass through to the worker harness.",
"type": "object",
"properties": {
+ "servicePath": {
+ "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\".",
+ "type": "string"
+ },
+ "shuffleServicePath": {
+ "description": "The Shuffle service path relative to the root URL, for example,\n\"shuffle/v1beta1\".",
+ "type": "string"
+ },
+ "workerId": {
+ "description": "The ID of the worker running this pipeline.",
+ "type": "string"
+ },
"tempStoragePrefix": {
"description": "The prefix of the resources the system should use for temporary\nstorage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
"type": "string"
@@ -2816,22 +2798,21 @@
"reportingEnabled": {
"description": "Whether to send work progress updates to the service.",
"type": "boolean"
- },
- "servicePath": {
- "type": "string",
- "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\"."
- },
- "shuffleServicePath": {
- "description": "The Shuffle service path relative to the root URL, for example,\n\"shuffle/v1beta1\".",
- "type": "string"
- },
- "workerId": {
- "description": "The ID of the worker running this pipeline.",
- "type": "string"
}
},
"id": "WorkerSettings"
},
+ "StreamingStageLocation": {
+ "properties": {
+ "streamId": {
+ "description": "Identifies the particular stream within the streaming Dataflow\njob.",
+ "type": "string"
+ }
+ },
+ "id": "StreamingStageLocation",
+ "description": "Identifies the location of a streaming computation stage, for\nstage-to-stage communication.",
+ "type": "object"
+ },
"DataDiskAssignment": {
"description": "Data disk assignment for a given VM instance.",
"type": "object",
@@ -2850,41 +2831,24 @@
},
"id": "DataDiskAssignment"
},
- "StreamingStageLocation": {
- "description": "Identifies the location of a streaming computation stage, for\nstage-to-stage communication.",
- "type": "object",
- "properties": {
- "streamId": {
- "description": "Identifies the particular stream within the streaming Dataflow\njob.",
- "type": "string"
- }
- },
- "id": "StreamingStageLocation"
- },
"ApproximateSplitRequest": {
- "description": "A suggestion by the service to the worker to dynamically split the WorkItem.",
- "type": "object",
"properties": {
- "position": {
- "$ref": "Position",
- "description": "A Position at which to split the work item."
- },
"fractionConsumed": {
"description": "A fraction at which to split the work item, from 0.0 (beginning of the\ninput) to 1.0 (end of the input).",
"format": "double",
"type": "number"
+ },
+ "position": {
+ "description": "A Position at which to split the work item.",
+ "$ref": "Position"
}
},
- "id": "ApproximateSplitRequest"
+ "id": "ApproximateSplitRequest",
+ "description": "A suggestion by the service to the worker to dynamically split the WorkItem.",
+ "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",
@@ -2900,38 +2864,19 @@
"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"
},
"ExecutionStageState": {
- "id": "ExecutionStageState",
- "description": "A message describing the state of a particular execution stage.",
- "type": "object",
"properties": {
- "executionStageName": {
- "description": "The name of the execution stage.",
- "type": "string"
- },
- "currentStateTime": {
- "description": "The time at which the stage transitioned to this state.",
- "format": "google-datetime",
- "type": "string"
- },
"executionStageState": {
- "enumDescriptions": [
- "The job's run state isn't specified.",
- "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
- "`JOB_STATE_RUNNING` indicates that the job is currently running.",
- "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
- "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
- "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
- "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
- "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
- "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
- "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
- "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
- ],
"enum": [
"JOB_STATE_UNKNOWN",
"JOB_STATE_STOPPED",
@@ -2946,9 +2891,34 @@
"JOB_STATE_CANCELLING"
],
"description": "Executions stage states allow the same set of values as JobState.",
+ "type": "string",
+ "enumDescriptions": [
+ "The job's run state isn't specified.",
+ "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
+ "`JOB_STATE_RUNNING` indicates that the job is currently running.",
+ "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
+ "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
+ "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
+ "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
+ "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
+ "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
+ "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
+ "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
+ ]
+ },
+ "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.",
+ "type": "object"
},
"StreamLocation": {
"description": "Describes a stream of data, either as input to be processed or as\noutput of a streaming Dataflow job.",
@@ -2967,15 +2937,13 @@
"description": "The stream is a pubsub stream."
},
"sideInputLocation": {
- "$ref": "StreamingSideInputLocation",
- "description": "The stream is a streaming side input."
+ "description": "The stream is a streaming side input.",
+ "$ref": "StreamingSideInputLocation"
}
},
"id": "StreamLocation"
},
"SendWorkerMessagesResponse": {
- "description": "The response to the worker messages.",
- "type": "object",
"properties": {
"workerMessageResponses": {
"description": "The servers response to the worker messages.",
@@ -2985,26 +2953,22 @@
}
}
},
- "id": "SendWorkerMessagesResponse"
- },
- "LeaseWorkItemResponse": {
- "description": "Response to a request to lease WorkItems.",
- "type": "object",
- "properties": {
- "workItems": {
- "description": "A list of the leased WorkItems.",
- "type": "array",
- "items": {
- "$ref": "WorkItem"
- }
- }
- },
- "id": "LeaseWorkItemResponse"
+ "id": "SendWorkerMessagesResponse",
+ "description": "The response to the worker messages.",
+ "type": "object"
},
"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",
@@ -3015,24 +2979,19 @@
"computationId": {
"description": "Unique identifier for this computation.",
"type": "string"
- },
- "systemName": {
- "description": "System defined name for this computation.",
- "type": "string"
- },
- "stageName": {
- "type": "string",
- "description": "Stage name of this computation."
}
},
"id": "StreamingComputationConfig"
},
"TransformSummary": {
- "type": "object",
"properties": {
+ "name": {
+ "description": "User provided name for this transform instance.",
+ "type": "string"
+ },
"id": {
- "type": "string",
- "description": "SDK generated id of this transform instance."
+ "description": "SDK generated id of this transform instance.",
+ "type": "string"
},
"displayData": {
"description": "Transform-specific display data.",
@@ -3049,6 +3008,17 @@
}
},
"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 transform.",
"type": "string",
"enumDescriptions": [
@@ -3061,17 +3031,6 @@
"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"
]
},
"inputCollectionName": {
@@ -3080,46 +3039,51 @@
"items": {
"type": "string"
}
- },
- "name": {
- "description": "User provided name for this transform instance.",
- "type": "string"
}
},
"id": "TransformSummary",
- "description": "Description of the type, names/ids, and input/outputs for a transform."
+ "description": "Description of the type, names/ids, and input/outputs for a transform.",
+ "type": "object"
+ },
+ "LeaseWorkItemResponse": {
+ "properties": {
+ "workItems": {
+ "description": "A list of the leased WorkItems.",
+ "type": "array",
+ "items": {
+ "$ref": "WorkItem"
+ }
+ }
+ },
+ "id": "LeaseWorkItemResponse",
+ "description": "Response to a request to lease WorkItems.",
+ "type": "object"
},
"Sink": {
- "description": "A sink that records can be encoded and written to.",
- "type": "object",
"properties": {
"codec": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
- "description": "The codec to use to encode data written to the sink."
+ "description": "The codec to use to encode data written to the sink.",
+ "type": "object"
},
"spec": {
- "description": "The sink to write to, plus its parameters.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- }
+ },
+ "description": "The sink to write to, plus its parameters.",
+ "type": "object"
}
},
- "id": "Sink"
+ "id": "Sink",
+ "description": "A sink that records can be encoded and written to.",
+ "type": "object"
},
"LaunchTemplateParameters": {
- "description": "Parameters to provide to the template being launched.",
- "type": "object",
"properties": {
- "environment": {
- "description": "The runtime environment for the job.",
- "$ref": "RuntimeEnvironment"
- },
"parameters": {
"additionalProperties": {
"type": "string"
@@ -3130,9 +3094,15 @@
"jobName": {
"description": "Required. The job name to use for the created job.",
"type": "string"
+ },
+ "environment": {
+ "$ref": "RuntimeEnvironment",
+ "description": "The runtime environment for the job."
}
},
- "id": "LaunchTemplateParameters"
+ "id": "LaunchTemplateParameters",
+ "description": "Parameters to provide to the template being launched.",
+ "type": "object"
},
"FlattenInstruction": {
"description": "An instruction that copies its inputs (zero or more) to its (single) output.",
@@ -3149,15 +3119,16 @@
"id": "FlattenInstruction"
},
"PartialGroupByKeyInstruction": {
+ "description": "An instruction that does a partial group-by-key.\nOne input and one output.",
"type": "object",
"properties": {
"inputElementCodec": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
- "description": "The codec to use for interpreting an element in the input PTable."
+ "description": "The codec to use for interpreting an element in the input PTable.",
+ "type": "object"
},
"valueCombiningFn": {
"additionalProperties": {
@@ -3168,8 +3139,8 @@
"type": "object"
},
"originalCombineValuesInputStoreName": {
- "type": "string",
- "description": "If this instruction includes a combining function this is the name of the\nintermediate store between the GBK and the CombineValues."
+ "description": "If this instruction includes a combining function this is the name of the\nintermediate store between the GBK and the CombineValues.",
+ "type": "string"
},
"sideInputs": {
"description": "Zero or more side inputs.",
@@ -3183,14 +3154,15 @@
"type": "string"
},
"input": {
- "$ref": "InstructionInput",
- "description": "Describes the input to the partial group-by-key instruction."
+ "description": "Describes the input to the partial group-by-key instruction.",
+ "$ref": "InstructionInput"
}
},
- "id": "PartialGroupByKeyInstruction",
- "description": "An instruction that does a partial group-by-key.\nOne input and one output."
+ "id": "PartialGroupByKeyInstruction"
},
"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.",
@@ -3203,9 +3175,7 @@
"type": "integer"
}
},
- "id": "InstructionInput",
- "description": "An input of an instruction, as a reference to an output of a\nproducer instruction.",
- "type": "object"
+ "id": "InstructionInput"
},
"StageSource": {
"properties": {
@@ -3223,8 +3193,8 @@
"type": "string"
},
"userName": {
- "type": "string",
- "description": "Human-readable name for this source; may be user or system generated."
+ "description": "Human-readable name for this source; may be user or system generated.",
+ "type": "string"
}
},
"id": "StageSource",
@@ -3232,8 +3202,6 @@
"type": "object"
},
"StringList": {
- "description": "A metric value representing a list of strings.",
- "type": "object",
"properties": {
"elements": {
"description": "Elements of the list.",
@@ -3243,14 +3211,28 @@
}
}
},
- "id": "StringList"
+ "id": "StringList",
+ "description": "A metric value representing a list of strings.",
+ "type": "object"
},
"DisplayData": {
- "type": "object",
"properties": {
+ "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": {
- "type": "string",
- "description": "Contains value if the data is of string type."
+ "description": "Contains value if the data is of string type.",
+ "type": "string"
},
"int64Value": {
"description": "Contains value if the data is of int64 type.",
@@ -3284,25 +3266,32 @@
"type": "string"
},
"label": {
- "type": "string",
- "description": "An optional label to display in a dax UI for the element."
- },
- "timestampValue": {
- "description": "Contains value if the data is of timestamp type.",
- "format": "google-datetime",
+ "description": "An optional label to display in a dax UI for the element.",
"type": "string"
- },
- "javaClassValue": {
- "description": "Contains value if the data is of java class type.",
- "type": "string"
- },
- "boolValue": {
- "description": "Contains value if the data is of a boolean type.",
- "type": "boolean"
}
},
"id": "DisplayData",
- "description": "Data provided with a pipeline or transform to provide descriptive info."
+ "description": "Data provided with a pipeline or transform to provide descriptive info.",
+ "type": "object"
+ },
+ "GetDebugConfigRequest": {
+ "properties": {
+ "componentId": {
+ "description": "The internal component id for which debug configuration is\nrequested.",
+ "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": "GetDebugConfigRequest",
+ "description": "Request to get updated debug configuration for component.",
+ "type": "object"
},
"LeaseWorkItemRequest": {
"description": "Request to lease WorkItems.",
@@ -3313,10 +3302,6 @@
"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",
@@ -3324,9 +3309,9 @@
"type": "string"
}
},
- "workerId": {
- "type": "string",
- "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker."
+ "location": {
+ "description": "The location which contains the WorkItem's job.",
+ "type": "string"
},
"workerCapabilities": {
"description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities.",
@@ -3335,6 +3320,10 @@
"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",
@@ -3343,49 +3332,30 @@
},
"id": "LeaseWorkItemRequest"
},
- "GetDebugConfigRequest": {
- "description": "Request to get updated debug configuration for component.",
- "type": "object",
- "properties": {
- "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"
- },
- "componentId": {
- "type": "string",
- "description": "The internal component id for which debug configuration is\nrequested."
- }
- },
- "id": "GetDebugConfigRequest"
- },
"GetTemplateResponse": {
- "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."
+ "description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details.",
+ "$ref": "Status"
},
"metadata": {
- "$ref": "TemplateMetadata",
- "description": "The template metadata describing the template name, available\nparameters, etc."
+ "description": "The template metadata describing the template name, available\nparameters, etc.",
+ "$ref": "TemplateMetadata"
}
},
"id": "GetTemplateResponse",
- "description": "The response to a GetTemplate request."
+ "description": "The response to a GetTemplate request.",
+ "type": "object"
},
"Parameter": {
"properties": {
- "value": {
- "type": "any",
- "description": "Value for this parameter."
- },
"key": {
"description": "Key or name for this parameter.",
"type": "string"
+ },
+ "value": {
+ "description": "Value for this parameter.",
+ "type": "any"
}
},
"id": "Parameter",
@@ -3393,9 +3363,6 @@
"type": "object"
},
"ReportWorkItemStatusRequest": {
- "id": "ReportWorkItemStatusRequest",
- "description": "Request to report the status of WorkItems.",
- "type": "object",
"properties": {
"workerId": {
"description": "The ID of the worker reporting the WorkItem status. If this\ndoes not match the ID of the worker which the Dataflow service\nbelieves currently has the lease on the WorkItem, the report\nwill be dropped (with an error response).",
@@ -3417,9 +3384,44 @@
"$ref": "WorkItemStatus"
}
}
- }
+ },
+ "id": "ReportWorkItemStatusRequest",
+ "description": "Request to report the status of WorkItems.",
+ "type": "object"
+ },
+ "StreamingConfigTask": {
+ "description": "A task that carries configuration information for streaming computations.",
+ "type": "object",
+ "properties": {
+ "windmillServiceEndpoint": {
+ "description": "If present, the worker must use this endpoint to communicate with Windmill\nService dispatchers, otherwise the worker must continue to use whatever\nendpoint it had been using.",
+ "type": "string"
+ },
+ "userStepToStateFamilyNameMap": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Map from user step names to state families.",
+ "type": "object"
+ },
+ "windmillServicePort": {
+ "description": "If present, the worker must use this port to communicate with Windmill\nService dispatchers. Only applicable when windmill_service_endpoint is\nspecified.",
+ "format": "int64",
+ "type": "string"
+ },
+ "streamingComputationConfigs": {
+ "description": "Set of computation configuration information.",
+ "type": "array",
+ "items": {
+ "$ref": "StreamingComputationConfig"
+ }
+ }
+ },
+ "id": "StreamingConfigTask"
},
"PipelineDescription": {
+ "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.",
@@ -3443,55 +3445,10 @@
}
}
},
- "id": "PipelineDescription",
- "description": "A descriptive representation of submitted pipeline as well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics.",
- "type": "object"
- },
- "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": {
- "description": "If present, the worker must use this endpoint to communicate with Windmill\nService dispatchers, otherwise the worker must continue to use whatever\nendpoint it had been using.",
- "type": "string"
- },
- "userStepToStateFamilyNameMap": {
- "description": "Map from user step names to state families.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "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"
- },
- "JobExecutionInfo": {
- "id": "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": {
- "description": "A mapping from each stage to the information about that stage.",
- "type": "object",
- "additionalProperties": {
- "$ref": "JobExecutionStageInfo"
- }
- }
- }
+ "id": "PipelineDescription"
},
"Step": {
+ "description": "Defines a particular step within a Cloud Dataflow job.\n\nA job consists of multiple steps, each of which performs some\nspecific operation as part of the overall job. Data is typically\npassed from one step to another as part of the job.\n\nHere's an example of a sequence of steps which together implement a\nMap-Reduce job:\n\n * Read a collection of data from some source, parsing the\n collection's elements.\n\n * Validate the elements.\n\n * Apply a user-defined function to map each element to some value\n and extract an element-specific key value.\n\n * Group elements with the same key into a single element with\n that key, transforming a multiply-keyed collection into a\n uniquely-keyed collection.\n\n * Write the elements out to some data sink.\n\nNote that the Cloud Dataflow service may be used to run many different\ntypes of jobs, not just Map-Reduce.",
"type": "object",
"properties": {
"properties": {
@@ -3511,11 +3468,23 @@
"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."
+ "id": "Step"
+ },
+ "JobExecutionInfo": {
+ "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job.",
+ "type": "object",
+ "properties": {
+ "stages": {
+ "additionalProperties": {
+ "$ref": "JobExecutionStageInfo"
+ },
+ "description": "A mapping from each stage to the information about that stage.",
+ "type": "object"
+ }
+ },
+ "id": "JobExecutionInfo"
},
"FailedLocation": {
- "type": "object",
"properties": {
"name": {
"description": "The name of the failed location.",
@@ -3523,16 +3492,15 @@
}
},
"id": "FailedLocation",
- "description": "Indicates which location failed to respond to a request for data."
+ "description": "Indicates which location failed to respond to a request for data.",
+ "type": "object"
},
"Disk": {
- "description": "Describes the data disk used by a workflow job.",
- "type": "object",
"properties": {
"sizeGb": {
- "type": "integer",
"description": "Size of disk in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"diskType": {
"description": "Disk storage type, as defined by Google Compute Engine. This\nmust be a disk type appropriate to the project and zone in which\nthe workers will run. If unknown or unspecified, the service\nwill attempt to choose a reasonable default.\n\nFor example, the standard persistent disk type is a resource name\ntypically ending in \"pd-standard\". If SSD persistent disks are\navailable, the resource name typically ends with \"pd-ssd\". The\nactual valid values are defined the Google Compute Engine API,\nnot by the Cloud Dataflow API; consult the Google Compute Engine\ndocumentation for more information about determining the set of\navailable disk types for a particular project and zone.\n\nGoogle Compute Engine Disk types are local to a particular\nproject in a particular zone, and so the resource name will\ntypically look something like this:\n\ncompute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard",
@@ -3543,11 +3511,11 @@
"type": "string"
}
},
- "id": "Disk"
+ "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": {
"kind": {
"enumDescriptions": [
@@ -3608,10 +3576,11 @@
"type": "string"
}
},
- "id": "CounterMetadata"
+ "id": "CounterMetadata",
+ "description": "CounterMetadata includes all static non-name non-value counter attributes.",
+ "type": "object"
},
"ListJobMessagesResponse": {
- "id": "ListJobMessagesResponse",
"description": "Response to a request to list job messages.",
"type": "object",
"properties": {
@@ -3633,11 +3602,10 @@
"$ref": "AutoscalingEvent"
}
}
- }
+ },
+ "id": "ListJobMessagesResponse"
},
"ApproximateReportedProgress": {
- "description": "A progress measurement of a WorkItem by a worker.",
- "type": "object",
"properties": {
"position": {
"$ref": "Position",
@@ -3657,7 +3625,9 @@
"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."
}
},
- "id": "ApproximateReportedProgress"
+ "id": "ApproximateReportedProgress",
+ "description": "A progress measurement of a WorkItem by a worker.",
+ "type": "object"
},
"IntegerList": {
"properties": {
@@ -3674,25 +3644,25 @@
"type": "object"
},
"StateFamilyConfig": {
- "description": "State family configuration.",
- "type": "object",
"properties": {
- "stateFamily": {
- "description": "The state family value.",
- "type": "string"
- },
"isRead": {
"description": "If true, this family corresponds to a read operation.",
"type": "boolean"
+ },
+ "stateFamily": {
+ "description": "The state family value.",
+ "type": "string"
}
},
- "id": "StateFamilyConfig"
+ "id": "StateFamilyConfig",
+ "description": "State family configuration.",
+ "type": "object"
},
"ResourceUtilizationReportResponse": {
- "description": "Service-side response to WorkerMessage reporting resource utilization.",
- "type": "object",
"properties": {},
- "id": "ResourceUtilizationReportResponse"
+ "id": "ResourceUtilizationReportResponse",
+ "description": "Service-side response to WorkerMessage reporting resource utilization.",
+ "type": "object"
},
"SourceSplitResponse": {
"description": "The response to a SourceSplitRequest.",
@@ -3720,17 +3690,16 @@
}
},
"shards": {
+ "description": "DEPRECATED in favor of bundles.",
"type": "array",
"items": {
"$ref": "SourceSplitShard"
- },
- "description": "DEPRECATED in favor of bundles."
+ }
}
},
"id": "SourceSplitResponse"
},
"ParallelInstruction": {
- "type": "object",
"properties": {
"outputs": {
"description": "Describes the outputs of the instruction.",
@@ -3743,14 +3712,14 @@
"description": "User-provided name of this operation.",
"type": "string"
},
- "parDo": {
- "$ref": "ParDoInstruction",
- "description": "Additional information for ParDo instructions."
- },
"read": {
"$ref": "ReadInstruction",
"description": "Additional information for Read instructions."
},
+ "parDo": {
+ "$ref": "ParDoInstruction",
+ "description": "Additional information for ParDo instructions."
+ },
"originalName": {
"description": "System-defined name for the operation in the original workflow graph.",
"type": "string"
@@ -3759,23 +3728,26 @@
"description": "Additional information for Flatten instructions.",
"$ref": "FlattenInstruction"
},
- "write": {
- "$ref": "WriteInstruction",
- "description": "Additional information for Write instructions."
- },
"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"
}
},
"id": "ParallelInstruction",
- "description": "Describes a particular operation comprising a MapTask."
+ "description": "Describes a particular operation comprising a MapTask.",
+ "type": "object"
},
"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.",
@@ -3786,13 +3758,9 @@
"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"
+ "id": "Package"
},
"KeyRangeDataDiskAssignment": {
- "description": "Data disk assignment information for a specific key-range of a sharded\ncomputation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.",
- "type": "object",
"properties": {
"start": {
"description": "The start (inclusive) of the key range.",
@@ -3807,7 +3775,9 @@
"type": "string"
}
},
- "id": "KeyRangeDataDiskAssignment"
+ "id": "KeyRangeDataDiskAssignment",
+ "description": "Data disk assignment information for a specific key-range of a sharded\ncomputation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.",
+ "type": "object"
},
"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.",
@@ -3828,12 +3798,12 @@
}
},
"userFn": {
- "description": "The user function to invoke.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- }
+ },
+ "description": "The user function to invoke.",
+ "type": "object"
},
"input": {
"$ref": "InstructionInput",
@@ -3847,21 +3817,99 @@
},
"id": "ParDoInstruction"
},
- "WorkerShutdownNotice": {
- "type": "object",
+ "MetricUpdate": {
"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.",
+ "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": {
+ "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"
}
},
- "id": "WorkerShutdownNotice",
- "description": "Shutdown notification from workers. This is to be sent by the shutdown\nscript of the worker VM so that the backend knows that the VM is being\nshut down."
+ "id": "MetricUpdate",
+ "description": "Describes the state of a metric.",
+ "type": "object"
},
"CounterStructuredName": {
"description": "Identifies a counter within a per-job namespace. Counters whose structured\nnames are the same get merged into a single value for the job.",
"type": "object",
"properties": {
+ "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"
+ },
+ "name": {
+ "description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired.",
+ "type": "string"
+ },
+ "executionStepName": {
+ "description": "Name of the stage. An execution step contains multiple component steps.",
+ "type": "string"
+ },
+ "originalRequestingStepName": {
+ "description": "The step name requesting an operation, such as GBK.\nI.e. the ParDo causing a read/write from shuffle to occur, or a\nread from side inputs.",
+ "type": "string"
+ },
+ "inputIndex": {
+ "description": "Index of an input collection that's being read from/written to as a side\ninput.\nThe index identifies a step's side inputs starting by 1 (e.g. the first\nside input has input_index 1, the third has input_index 3).\nSide inputs are identified by a pair of (original_step_name, input_index).\nThis field helps uniquely identify them.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "componentStepName": {
+ "description": "Name of the optimized step being executed by the workers.",
+ "type": "string"
+ },
"portion": {
"enum": [
"ALL",
@@ -3879,140 +3927,63 @@
"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"
- },
- "executionStepName": {
- "description": "Name of the stage. An execution step contains multiple component steps.",
- "type": "string"
- },
- "name": {
- "description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired.",
- "type": "string"
- },
- "origin": {
- "enum": [
- "SYSTEM",
- "USER"
- ],
- "description": "One of the standard Origins defined above.",
- "type": "string",
- "enumDescriptions": [
- "Counter was created by the Dataflow system.",
- "Counter was created by the user."
- ]
- },
- "originalRequestingStepName": {
- "description": "The step name requesting an operation, such as GBK.\nI.e. the ParDo causing a read/write from shuffle to occur, or a\nread from side inputs.",
- "type": "string"
- },
- "inputIndex": {
- "description": "Index of an input collection that's being read from/written to as a side\ninput.\nThe index identifies a step's side inputs starting by 1 (e.g. the first\nside input has input_index 1, the third has input_index 3).\nSide inputs are identified by a pair of (original_step_name, input_index).\nThis field helps uniquely identify them.",
- "format": "int32",
- "type": "integer"
- },
- "componentStepName": {
- "description": "Name of the optimized step being executed by the workers.",
- "type": "string"
}
},
"id": "CounterStructuredName"
},
- "MetricUpdate": {
- "id": "MetricUpdate",
- "description": "Describes the state of a metric.",
+ "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",
"properties": {
- "name": {
- "description": "Name of the metric.",
- "$ref": "MetricStructuredName"
- },
- "distribution": {
- "description": "A struct value describing properties of a distribution of numeric values.",
- "type": "any"
- },
- "set": {
- "type": "any",
- "description": "Worker-computed aggregate value for the \"Set\" aggregation kind. The only\npossible value type is a list of Values whose type can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type."
- },
- "internal": {
- "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice.",
- "type": "any"
- },
- "cumulative": {
- "description": "True if this metric is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this metric is reported\nas a delta that is not associated with any WorkItem.",
- "type": "boolean"
- },
- "kind": {
- "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",
+ "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"
},
"ApproximateProgress": {
"description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.",
"type": "object",
"properties": {
- "percentComplete": {
- "description": "Obsolete.",
- "format": "float",
- "type": "number"
- },
"remainingTime": {
- "type": "string",
"description": "Obsolete.",
- "format": "google-duration"
+ "format": "google-duration",
+ "type": "string"
},
"position": {
"description": "Obsolete.",
"$ref": "Position"
+ },
+ "percentComplete": {
+ "description": "Obsolete.",
+ "format": "float",
+ "type": "number"
}
},
"id": "ApproximateProgress"
},
"WorkerMessageResponse": {
- "description": "A worker_message response allows the server to pass information to the\nsender.",
- "type": "object",
"properties": {
- "workerHealthReportResponse": {
- "description": "The service's response to a worker's health report.",
- "$ref": "WorkerHealthReportResponse"
- },
"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": {
+ "description": "Metadata describing a template.",
"type": "object",
"properties": {
"name": {
@@ -4031,19 +4002,13 @@
"type": "string"
}
},
- "id": "TemplateMetadata",
- "description": "Metadata describing a template."
+ "id": "TemplateMetadata"
},
"WorkerMessage": {
- "type": "object",
"properties": {
- "workerHealthReport": {
- "$ref": "WorkerHealthReport",
- "description": "The health of a worker."
- },
"workerMessageCode": {
- "$ref": "WorkerMessageCode",
- "description": "A worker message code."
+ "description": "A worker message code.",
+ "$ref": "WorkerMessageCode"
},
"workerMetrics": {
"description": "Resource metrics reported by workers.",
@@ -4064,15 +4029,17 @@
"workerShutdownNotice": {
"description": "Shutdown notice by workers.",
"$ref": "WorkerShutdownNotice"
+ },
+ "workerHealthReport": {
+ "$ref": "WorkerHealthReport",
+ "description": "The health of a worker."
}
},
"id": "WorkerMessage",
- "description": "WorkerMessage provides information to the backend about a worker."
+ "description": "WorkerMessage provides information to the backend about a worker.",
+ "type": "object"
},
"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",
"properties": {
"metricTime": {
"description": "Timestamp as of which metric values are current.",
@@ -4086,30 +4053,34 @@
"$ref": "MetricUpdate"
}
}
- }
+ },
+ "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"
},
"WorkerShutdownNoticeResponse": {
- "description": "Service-side response to WorkerMessage issuing shutdown notice.",
- "type": "object",
"properties": {},
- "id": "WorkerShutdownNoticeResponse"
+ "id": "WorkerShutdownNoticeResponse",
+ "description": "Service-side response to WorkerMessage issuing shutdown notice.",
+ "type": "object"
},
"FloatingPointList": {
+ "description": "A metric value representing a list of floating point numbers.",
+ "type": "object",
"properties": {
"elements": {
+ "description": "Elements of the list.",
"type": "array",
"items": {
"format": "double",
"type": "number"
- },
- "description": "Elements of the list."
+ }
}
},
- "id": "FloatingPointList",
- "description": "A metric value representing a list of floating point numbers.",
- "type": "object"
+ "id": "FloatingPointList"
},
"CounterUpdate": {
+ "description": "An update to a Counter sent from a worker.",
"type": "object",
"properties": {
"floatingPointList": {
@@ -4117,16 +4088,16 @@
"$ref": "FloatingPointList"
},
"integer": {
- "$ref": "SplitInt64",
- "description": "Integer value for Sum, Max, Min."
+ "description": "Integer value for Sum, Max, Min.",
+ "$ref": "SplitInt64"
},
"integerList": {
"$ref": "IntegerList",
"description": "List of integers, for Set."
},
"structuredNameAndMetadata": {
- "description": "Counter structured name and metadata.",
- "$ref": "CounterStructuredNameAndMetadata"
+ "$ref": "CounterStructuredNameAndMetadata",
+ "description": "Counter structured name and metadata."
},
"integerMean": {
"description": "Integer mean aggregation value for Mean.",
@@ -4146,16 +4117,16 @@
"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"
},
"nameAndKind": {
- "$ref": "NameAndKind",
- "description": "Counter name and aggregation type."
+ "description": "Counter name and aggregation type.",
+ "$ref": "NameAndKind"
},
"stringList": {
"description": "List of strings, for Set.",
@@ -4171,10 +4142,10 @@
"type": "string"
}
},
- "id": "CounterUpdate",
- "description": "An update to a Counter sent from a worker."
+ "id": "CounterUpdate"
},
"SourceMetadata": {
+ "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc.",
"type": "object",
"properties": {
"producesSortedKeys": {
@@ -4191,18 +4162,10 @@
"type": "string"
}
},
- "id": "SourceMetadata",
- "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc."
+ "id": "SourceMetadata"
},
"DistributionUpdate": {
- "id": "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": {
"description": "(Optional) Histogram of value counts for the distribution.",
"$ref": "Histogram"
@@ -4215,19 +4178,25 @@
"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"
+ },
"sumOfSquares": {
"description": "Use a double since the sum of squares is likely to overflow int64.",
"format": "double",
"type": "number"
},
- "min": {
- "description": "The minimum value present in the distribution.",
+ "sum": {
+ "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.",
"$ref": "SplitInt64"
}
- }
+ },
+ "id": "DistributionUpdate",
+ "description": "A metric value representing a distribution.",
+ "type": "object"
},
"WorkerHealthReportResponse": {
- "id": "WorkerHealthReportResponse",
"description": "WorkerHealthReportResponse contains information returned to the worker\nin response to a health ping.",
"type": "object",
"properties": {
@@ -4236,77 +4205,34 @@
"format": "google-duration",
"type": "string"
}
- }
+ },
+ "id": "WorkerHealthReportResponse"
},
"SourceFork": {
- "description": "DEPRECATED in favor of DynamicSourceSplit.",
- "type": "object",
"properties": {
- "primarySource": {
- "$ref": "DerivedSource",
- "description": "DEPRECATED"
- },
- "residual": {
- "$ref": "SourceSplitShard",
- "description": "DEPRECATED"
- },
- "residualSource": {
- "$ref": "DerivedSource",
- "description": "DEPRECATED"
- },
"primary": {
"description": "DEPRECATED",
"$ref": "SourceSplitShard"
+ },
+ "primarySource": {
+ "description": "DEPRECATED",
+ "$ref": "DerivedSource"
+ },
+ "residual": {
+ "description": "DEPRECATED",
+ "$ref": "SourceSplitShard"
+ },
+ "residualSource": {
+ "description": "DEPRECATED",
+ "$ref": "DerivedSource"
}
},
- "id": "SourceFork"
+ "id": "SourceFork",
+ "description": "DEPRECATED in favor of DynamicSourceSplit.",
+ "type": "object"
},
"WorkItemStatus": {
- "description": "Conveys a worker's progress through the work described by a WorkItem.",
- "type": "object",
"properties": {
- "counterUpdates": {
- "type": "array",
- "items": {
- "$ref": "CounterUpdate"
- },
- "description": "Worker output counters for this WorkItem."
- },
- "workItemId": {
- "type": "string",
- "description": "Identifies the WorkItem."
- },
- "errors": {
- "description": "Specifies errors which occurred during processing. If errors are\nprovided, and completed = true, then the WorkItem is considered\nto have failed.",
- "type": "array",
- "items": {
- "$ref": "Status"
- }
- },
- "metricUpdates": {
- "description": "DEPRECATED in favor of counter_updates.",
- "type": "array",
- "items": {
- "$ref": "MetricUpdate"
- }
- },
- "dynamicSourceSplit": {
- "description": "See documentation of stop_position.",
- "$ref": "DynamicSourceSplit"
- },
- "sourceOperationResponse": {
- "$ref": "SourceOperationResponse",
- "description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation."
- },
- "progress": {
- "description": "DEPRECATED in favor of reported_progress.",
- "$ref": "ApproximateProgress"
- },
- "requestedLeaseDuration": {
- "description": "Amount of time the worker requests for its lease.",
- "format": "google-duration",
- "type": "string"
- },
"reportIndex": {
"description": "The report index. When a WorkItem is leased, the lease will\ncontain an initial report index. When a WorkItem's status is\nreported to the system, the report should be sent with\nthat report index, and the response will contain the index the\nworker should use for the next report. Reports received with\nunexpected index values will be rejected by the service.\n\nIn order to preserve idempotency, the worker should not alter the\ncontents of a report, even if the worker must submit the same\nreport multiple times before getting back a response. The worker\nshould not submit a subsequent report until the response for the\nprevious report had been received from the service.",
"format": "int64",
@@ -4325,45 +4251,82 @@
"description": "The worker's progress through this WorkItem."
},
"sourceFork": {
- "$ref": "SourceFork",
- "description": "DEPRECATED in favor of dynamic_source_split."
+ "description": "DEPRECATED in favor of dynamic_source_split.",
+ "$ref": "SourceFork"
},
"totalThrottlerWaitTimeSeconds": {
"description": "Total time the worker spent being throttled by external systems.",
"format": "double",
"type": "number"
+ },
+ "counterUpdates": {
+ "description": "Worker output counters for this WorkItem.",
+ "type": "array",
+ "items": {
+ "$ref": "CounterUpdate"
+ }
+ },
+ "workItemId": {
+ "description": "Identifies the WorkItem.",
+ "type": "string"
+ },
+ "metricUpdates": {
+ "description": "DEPRECATED in favor of counter_updates.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricUpdate"
+ }
+ },
+ "errors": {
+ "description": "Specifies errors which occurred during processing. If errors are\nprovided, and completed = true, then the WorkItem is considered\nto have failed.",
+ "type": "array",
+ "items": {
+ "$ref": "Status"
+ }
+ },
+ "dynamicSourceSplit": {
+ "description": "See documentation of stop_position.",
+ "$ref": "DynamicSourceSplit"
+ },
+ "sourceOperationResponse": {
+ "$ref": "SourceOperationResponse",
+ "description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation."
+ },
+ "progress": {
+ "description": "DEPRECATED in favor of reported_progress.",
+ "$ref": "ApproximateProgress"
+ },
+ "requestedLeaseDuration": {
+ "description": "Amount of time the worker requests for its lease.",
+ "format": "google-duration",
+ "type": "string"
}
},
- "id": "WorkItemStatus"
+ "id": "WorkItemStatus",
+ "description": "Conveys a worker's progress through the work described by a WorkItem.",
+ "type": "object"
},
"ComponentSource": {
- "type": "object",
"properties": {
- "userName": {
- "type": "string",
- "description": "Human-readable name for this transform; may be user or system generated."
- },
- "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"
+ },
+ "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",
- "description": "Description of an interstitial value between transforms in an execution\nstage."
+ "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]",
- "format": "int32",
- "type": "integer"
- },
"bucketCounts": {
"description": "Counts of values in each bucket. For efficiency, prefix and trailing\nbuckets with count = 0 are elided. Buckets can store the full range of\nvalues of an unsigned long, with ULLONG_MAX falling into the 59th bucket\nwith range [1e19, 2e19).",
"type": "array",
@@ -4371,20 +4334,26 @@
"format": "int64",
"type": "string"
}
+ },
+ "firstBucketOffset": {
+ "description": "Starting index of first stored bucket. The non-inclusive upper-bound of\nthe ith bucket is given by:\n pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i-first_bucket_offset)%3]",
+ "format": "int32",
+ "type": "integer"
}
},
- "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": {
- "type": "object",
"properties": {
"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.",
@@ -4392,12 +4361,12 @@
"type": "string"
},
"harnessData": {
- "description": "Other data returned by the service, specific to the particular\nworker harness.",
- "type": "object",
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Other data returned by the service, specific to the particular\nworker harness.",
+ "type": "object"
},
"leaseExpireTime": {
"description": "Time at which the current lease will expire.",
@@ -4412,29 +4381,23 @@
}
},
"nextReportIndex": {
- "type": "string",
"description": "The index value to use for the next report sent by the worker.\nNote: If the report call fails for whatever reason, the worker should\nreuse this index for subsequent report attempts.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"suggestedStopPoint": {
- "$ref": "ApproximateProgress",
- "description": "DEPRECATED in favor of split_request."
+ "description": "DEPRECATED in favor of split_request.",
+ "$ref": "ApproximateProgress"
}
},
"id": "WorkItemServiceState",
- "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker."
+ "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.",
+ "type": "object"
},
"MetricStructuredName": {
"description": "Identifies a metric, by describing the source which generated the\nmetric.",
"type": "object",
"properties": {
- "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."
- },
"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"
@@ -4442,6 +4405,13 @@
"name": {
"description": "Worker-defined metric name.",
"type": "string"
+ },
+ "context": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Zero or more labeled fields which identify the part of the job this\nmetric is associated with, such as the name of a step or collection.\n\nFor example, built-in counters associated with steps will have\ncontext['step'] = \u003cstep-name\u003e. Counters associated with PCollections\nin the SDK will have context['pcollection'] = \u003cpcollection-name\u003e.",
+ "type": "object"
}
},
"id": "MetricStructuredName"
@@ -4450,20 +4420,18 @@
"description": "Information about an output of a SeqMapTask.",
"type": "object",
"properties": {
- "tag": {
- "description": "The id of the TupleTag the user code will tag the output value by.",
- "type": "string"
- },
"sink": {
"$ref": "Sink",
"description": "The sink to write the output value to."
+ },
+ "tag": {
+ "description": "The id of the TupleTag the user code will tag the output value by.",
+ "type": "string"
}
},
"id": "SeqMapTaskOutputInfo"
},
"JobExecutionStageInfo": {
- "description": "Contains information about how a particular\ngoogle.dataflow.v1beta3.Step will be executed.",
- "type": "object",
"properties": {
"stepName": {
"description": "The steps associated with the execution stage.\nNote that stages may have several steps, and that a given step\nmight be run by more than one stage.",
@@ -4473,12 +4441,22 @@
}
}
},
- "id": "JobExecutionStageInfo"
+ "id": "JobExecutionStageInfo",
+ "description": "Contains information about how a particular\ngoogle.dataflow.v1beta3.Step will be executed.",
+ "type": "object"
},
"KeyRangeLocation": {
"description": "Location information for a specific key-range of a sharded computation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.",
"type": "object",
"properties": {
+ "deprecatedPersistentDirectory": {
+ "description": "DEPRECATED. The location of the persistent state for this range, as a\npersistent directory in the worker local filesystem.",
+ "type": "string"
+ },
+ "deliveryEndpoint": {
+ "description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery.",
+ "type": "string"
+ },
"start": {
"description": "The start (inclusive) of the key range.",
"type": "string"
@@ -4490,14 +4468,6 @@
"end": {
"description": "The end (exclusive) of the key range.",
"type": "string"
- },
- "deprecatedPersistentDirectory": {
- "type": "string",
- "description": "DEPRECATED. The location of the persistent state for this range, as a\npersistent directory in the worker local filesystem."
- },
- "deliveryEndpoint": {
- "description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery.",
- "type": "string"
}
},
"id": "KeyRangeLocation"
@@ -4507,63 +4477,19 @@
"type": "object",
"properties": {
"source": {
- "$ref": "Source",
- "description": "Specification of the source whose metadata should be computed."
+ "description": "Specification of the source whose metadata should be computed.",
+ "$ref": "Source"
}
},
"id": "SourceGetMetadataRequest"
},
- "SeqMapTask": {
- "description": "Describes a particular function to invoke.",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The user-provided name of the SeqDo operation."
- },
- "outputInfos": {
- "description": "Information about each of the outputs.",
- "type": "array",
- "items": {
- "$ref": "SeqMapTaskOutputInfo"
- }
- },
- "inputs": {
- "description": "Information about each of the inputs.",
- "type": "array",
- "items": {
- "$ref": "SideInputInfo"
- }
- },
- "systemName": {
- "description": "System-defined name of the SeqDo operation.\nUnique across the workflow.",
- "type": "string"
- },
- "stageName": {
- "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.",
- "type": "string"
- },
- "userFn": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
- "description": "The user function to invoke.",
- "type": "object"
- }
- },
- "id": "SeqMapTask"
- },
"NameAndKind": {
- "description": "Basic metadata about a counter.",
- "type": "object",
"properties": {
"name": {
"description": "Name of the counter.",
"type": "string"
},
"kind": {
- "type": "string",
"enumDescriptions": [
"Counter aggregation kind was not set.",
"Aggregated value is the sum of all contributed values.",
@@ -4586,13 +4512,56 @@
"SET",
"DISTRIBUTION"
],
- "description": "Counter aggregation kind."
+ "description": "Counter aggregation kind.",
+ "type": "string"
}
},
- "id": "NameAndKind"
+ "id": "NameAndKind",
+ "description": "Basic metadata about a counter.",
+ "type": "object"
+ },
+ "SeqMapTask": {
+ "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",
+ "items": {
+ "$ref": "SideInputInfo"
+ }
+ },
+ "stageName": {
+ "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.",
+ "type": "string"
+ },
+ "systemName": {
+ "description": "System-defined name of the SeqDo operation.\nUnique across the workflow.",
+ "type": "string"
+ },
+ "userFn": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The user function to invoke.",
+ "type": "object"
+ }
+ },
+ "id": "SeqMapTask",
+ "description": "Describes a particular function to invoke.",
+ "type": "object"
},
"WorkerMessageCode": {
- "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",
"properties": {
@@ -4608,18 +4577,19 @@
"description": "The code is a string intended for consumption by a machine that identifies\nthe type of message being sent.\nExamples:\n 1. \"HARNESS_STARTED\" might be used to indicate the worker harness has\n started.\n 2. \"GCS_DOWNLOAD_ERROR\" might be used to indicate an error downloading\n a GCS file as part of the boot process of one of the worker containers.\n\nThis is a string and not an enum to make it easy to add new codes without\nwaiting for an API change.",
"type": "string"
}
- }
+ },
+ "id": "WorkerMessageCode"
},
"CustomSourceLocation": {
- "description": "Identifies the location of a custom souce.",
- "type": "object",
"properties": {
"stateful": {
"description": "Whether this source is stateful.",
"type": "boolean"
}
},
- "id": "CustomSourceLocation"
+ "id": "CustomSourceLocation",
+ "description": "Identifies the location of a custom souce.",
+ "type": "object"
},
"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.",
@@ -4644,8 +4614,6 @@
"id": "MapTask"
},
"FloatingPointMean": {
- "description": "A representation of a floating point mean metric contribution.",
- "type": "object",
"properties": {
"sum": {
"description": "The sum of all values being aggregated.",
@@ -4657,7 +4625,9 @@
"$ref": "SplitInt64"
}
},
- "id": "FloatingPointMean"
+ "id": "FloatingPointMean",
+ "description": "A representation of a floating point mean metric contribution.",
+ "type": "object"
},
"ReportWorkItemStatusResponse": {
"description": "Response from a request to report the status of WorkItems.",
@@ -4674,12 +4644,10 @@
"id": "ReportWorkItemStatusResponse"
},
"InstructionOutput": {
- "description": "An output of an instruction.",
- "type": "object",
"properties": {
"originalName": {
- "type": "string",
- "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."
+ "description": "System-defined name for this output in the original workflow graph.\nOutputs that do not contribute to an original instruction do not set this.",
+ "type": "string"
},
"systemName": {
"description": "System-defined name of this output.\nUnique across the workflow.",
@@ -4706,20 +4674,12 @@
"type": "string"
}
},
- "id": "InstructionOutput"
+ "id": "InstructionOutput",
+ "description": "An output of an instruction.",
+ "type": "object"
},
"CreateJobFromTemplateRequest": {
- "description": "A request to create a Cloud Dataflow job from a template.",
- "type": "object",
"properties": {
- "environment": {
- "$ref": "RuntimeEnvironment",
- "description": "The runtime environment for the job."
- },
- "location": {
- "description": "The location to which to direct the request.",
- "type": "string"
- },
"parameters": {
"additionalProperties": {
"type": "string"
@@ -4734,19 +4694,29 @@
"gcsPath": {
"description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
"type": "string"
+ },
+ "environment": {
+ "description": "The runtime environment for the job.",
+ "$ref": "RuntimeEnvironment"
+ },
+ "location": {
+ "description": "The location to which to direct the request.",
+ "type": "string"
}
},
- "id": "CreateJobFromTemplateRequest"
+ "id": "CreateJobFromTemplateRequest",
+ "description": "A request to create a Cloud Dataflow job from a template.",
+ "type": "object"
},
"IntegerMean": {
"properties": {
- "sum": {
- "$ref": "SplitInt64",
- "description": "The sum of all values being aggregated."
- },
"count": {
"$ref": "SplitInt64",
"description": "The number of values being aggregated."
+ },
+ "sum": {
+ "$ref": "SplitInt64",
+ "description": "The sum of all values being aggregated."
}
},
"id": "IntegerMean",
@@ -4757,6 +4727,13 @@
"description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsRequest.",
"type": "object",
"properties": {
+ "jobs": {
+ "description": "A subset of the requested job information.",
+ "type": "array",
+ "items": {
+ "$ref": "Job"
+ }
+ },
"nextPageToken": {
"description": "Set if there may be more results than fit in this response.",
"type": "string"
@@ -4767,18 +4744,13 @@
"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": {
"description": "The state family values.",
@@ -4817,12 +4789,27 @@
}
}
},
- "id": "ComputationTopology",
- "description": "All configuration data for a particular Computation.",
- "type": "object"
+ "id": "ComputationTopology"
},
"RuntimeEnvironment": {
+ "description": "The environment values to set at runtime.",
+ "type": "object",
"properties": {
+ "machineType": {
+ "description": "The machine type to use for the job. Defaults to the value from the\ntemplate if not specified.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline.",
+ "type": "string"
+ },
+ "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",
@@ -4839,25 +4826,19 @@
"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": {
- "type": "string",
- "description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline."
- },
- "additionalExperiments": {
- "description": "Additional experiment flags for the job.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
},
- "id": "RuntimeEnvironment",
- "description": "The environment values to set at runtime.",
+ "id": "RuntimeEnvironment"
+ },
+ "MountedDataDisk": {
+ "properties": {
+ "dataDisk": {
+ "description": "The name of the data disk.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".",
+ "type": "string"
+ }
+ },
+ "id": "MountedDataDisk",
+ "description": "Describes mounted data disk.",
"type": "object"
},
"StreamingSideInputLocation": {
@@ -4875,17 +4856,6 @@
},
"id": "StreamingSideInputLocation"
},
- "MountedDataDisk": {
- "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",
- "description": "Describes mounted data disk."
- },
"LaunchTemplateResponse": {
"description": "Response to the request to launch a template.",
"type": "object",
@@ -4897,109 +4867,8 @@
},
"id": "LaunchTemplateResponse"
},
- "DerivedSource": {
- "description": "Specification of one of the bundles produced as a result of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\nsplitting an active task using WorkItemStatus.dynamic_source_split),\nrelative to the source being split.",
- "type": "object",
- "properties": {
- "derivationMode": {
- "enumDescriptions": [
- "The source derivation is unknown, or unspecified.",
- "Produce a completely independent Source with no base.",
- "Produce a Source based on the Source being split.",
- "Produce a Source based on the base of the Source being split."
- ],
- "enum": [
- "SOURCE_DERIVATION_MODE_UNKNOWN",
- "SOURCE_DERIVATION_MODE_INDEPENDENT",
- "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
- "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- ],
- "description": "What source to base the produced source on (if any).",
- "type": "string"
- },
- "source": {
- "$ref": "Source",
- "description": "Specification of the source."
- }
- },
- "id": "DerivedSource"
- },
- "DynamicSourceSplit": {
- "type": "object",
- "properties": {
- "primary": {
- "$ref": "DerivedSource",
- "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current."
- },
- "residual": {
- "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."
- },
"Job": {
- "description": "Defines a job to be run by the Cloud Dataflow service.",
- "type": "object",
"properties": {
- "currentStateTime": {
- "description": "The timestamp associated with the current state.",
- "format": "google-datetime",
- "type": "string"
- },
- "transformNameMapping": {
- "type": "object",
- "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."
- },
- "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"
- }
- },
- "environment": {
- "$ref": "Environment",
- "description": "The environment for the job."
- },
- "createTime": {
- "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.",
- "format": "google-datetime",
- "type": "string"
- },
- "stageStates": {
- "type": "array",
- "items": {
- "$ref": "ExecutionStageState"
- },
- "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it."
- },
- "projectId": {
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "type": "string"
- },
- "type": {
- "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"
@@ -5049,6 +4918,10 @@
"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",
@@ -5056,13 +4929,9 @@
"$ref": "Step"
}
},
- "replacedByJobId": {
- "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.",
- "type": "string"
- },
"executionInfo": {
- "$ref": "JobExecutionInfo",
- "description": "Deprecated."
+ "description": "Deprecated.",
+ "$ref": "JobExecutionInfo"
},
"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.",
@@ -5101,16 +4970,147 @@
"location": {
"description": "The location that contains this job.",
"type": "string"
+ },
+ "currentStateTime": {
+ "description": "The timestamp associated with the current state.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "transformNameMapping": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.",
+ "type": "object"
+ },
+ "createTime": {
+ "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "environment": {
+ "$ref": "Environment",
+ "description": "The environment for the job."
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "User-defined labels for this job.\n\nThe labels map can contain no more than 64 entries. Entries of the labels\nmap are UTF8 strings that comply with the following restrictions:\n\n* Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62}\n* Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}\n* Both keys and values are additionally constrained to be \u003c= 128 bytes in\nsize.",
+ "type": "object"
+ },
+ "stageStates": {
+ "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
+ "type": "array",
+ "items": {
+ "$ref": "ExecutionStageState"
+ }
+ },
+ "projectId": {
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "JOB_TYPE_UNKNOWN",
+ "JOB_TYPE_BATCH",
+ "JOB_TYPE_STREAMING"
+ ],
+ "description": "The type of Cloud Dataflow job.",
+ "type": "string",
+ "enumDescriptions": [
+ "The type of the job is unspecified, or unknown.",
+ "A batch job with a well-defined end point: data is read, data is\nprocessed, data is written, and the job is done.",
+ "A continuously streaming job with no end: data is read,\nprocessed, and written continuously."
+ ]
+ },
+ "pipelineDescription": {
+ "$ref": "PipelineDescription",
+ "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL."
}
},
- "id": "Job"
+ "id": "Job",
+ "description": "Defines a job to be run by the Cloud Dataflow service.",
+ "type": "object"
+ },
+ "DynamicSourceSplit": {
+ "description": "When a task splits using WorkItemStatus.dynamic_source_split, this\nmessage describes the two parts of the split relative to the\ndescription of the current task's input.",
+ "type": "object",
+ "properties": {
+ "residual": {
+ "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source.",
+ "$ref": "DerivedSource"
+ },
+ "primary": {
+ "$ref": "DerivedSource",
+ "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current."
+ }
+ },
+ "id": "DynamicSourceSplit"
+ },
+ "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": {
+ "$ref": "Source",
+ "description": "Specification of the source."
+ }
+ },
+ "id": "DerivedSource"
}
},
"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": "v1b3",
- "baseUrl": "https://dataflow.googleapis.com/"
+ "baseUrl": "https://dataflow.googleapis.com/",
+ "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": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/userinfo.email": {
+ "description": "View your email address"
+ }
+ }
+ }
+ },
+ "servicePath": "",
+ "description": "Manages Google Cloud Dataflow projects on Google Cloud Platform.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://dataflow.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "dataflow",
+ "batchPath": "batch",
+ "revision": "20180118",
+ "documentationLink": "https://cloud.google.com/dataflow",
+ "id": "dataflow:v1b3",
+ "title": "Google Dataflow API"
}
diff --git a/dataproc/v1/dataproc-api.json b/dataproc/v1/dataproc-api.json
index c60de81..a2550f1 100644
--- a/dataproc/v1/dataproc-api.json
+++ b/dataproc/v1/dataproc-api.json
@@ -1,98 +1,10 @@
{
"basePath": "",
- "documentationLink": "https://cloud.google.com/dataproc/",
- "revision": "20180122",
"id": "dataproc:v1",
+ "revision": "20180122",
+ "documentationLink": "https://cloud.google.com/dataproc/",
"discoveryVersion": "v1",
"schemas": {
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
- }
- },
- "id": "Operation"
- },
- "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": {
- "$ref": "Job",
- "description": "Required. The job resource."
- }
- },
- "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"
- },
"InstanceGroupConfig": {
"description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
"type": "object",
@@ -103,24 +15,24 @@
"type": "integer"
},
"diskConfig": {
- "$ref": "DiskConfig",
- "description": "Optional. Disk option config settings."
+ "description": "Optional. Disk option config settings.",
+ "$ref": "DiskConfig"
},
- "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"
+ "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"
},
- "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"
+ "isPreemptible": {
+ "description": "Optional. Specifies that this instance group contains preemptible instances.",
+ "type": "boolean"
+ },
+ "managedGroupConfig": {
+ "description": "Output only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.",
+ "$ref": "ManagedGroupConfig"
},
"instanceNames": {
"description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).",
@@ -140,8 +52,6 @@
"id": "InstanceGroupConfig"
},
"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.",
@@ -149,7 +59,9 @@
"type": "integer"
}
},
- "id": "JobScheduling"
+ "id": "JobScheduling",
+ "description": "Job scheduling options.",
+ "type": "object"
},
"NodeInitializationAction": {
"description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
@@ -168,41 +80,39 @@
"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"
- },
- "CancelJobRequest": {
- "properties": {},
- "id": "CancelJobRequest",
- "description": "A request to cancel a job.",
+ "id": "ListJobsResponse",
+ "description": "A list of jobs in a project.",
"type": "object"
},
- "SparkSqlJob": {
- "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
+ "CancelJobRequest": {
+ "description": "A request to cancel a job.",
"type": "object",
+ "properties": {},
+ "id": "CancelJobRequest"
+ },
+ "SparkSqlJob": {
"properties": {
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
"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"
@@ -229,25 +139,27 @@
}
}
},
- "id": "SparkSqlJob"
+ "id": "SparkSqlJob",
+ "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
+ "type": "object"
},
"Cluster": {
"properties": {
"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"
- }
- },
- "metrics": {
- "description": "Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
- "$ref": "ClusterMetrics"
+ },
+ "description": "Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.",
+ "type": "object"
},
"status": {
"$ref": "ClusterStatus",
"description": "Output only. Cluster status."
},
+ "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."
+ },
"statusHistory": {
"description": "Output only. The previous cluster status.",
"type": "array",
@@ -256,17 +168,17 @@
}
},
"config": {
- "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.",
- "$ref": "ClusterConfig"
- },
- "clusterName": {
- "description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.",
- "type": "string"
+ "$ref": "ClusterConfig",
+ "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated."
},
"clusterUuid": {
"description": "Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.",
"type": "string"
},
+ "clusterName": {
+ "description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.",
+ "type": "string"
+ },
"projectId": {
"description": "Required. The Google Cloud Platform project ID that the cluster belongs to.",
"type": "string"
@@ -277,37 +189,22 @@
"type": "object"
},
"ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Operation"
}
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
}
},
- "id": "ListOperationsResponse"
- },
- "JobPlacement": {
- "description": "Cloud Dataproc job config.",
- "type": "object",
- "properties": {
- "clusterName": {
- "description": "Required. The name of the cluster where the job will be submitted.",
- "type": "string"
- },
- "clusterUuid": {
- "description": "Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.",
- "type": "string"
- }
- },
- "id": "JobPlacement"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
},
"SoftwareConfig": {
"description": "Specifies the selection and config of software inside the cluster.",
@@ -318,15 +215,30 @@
"type": "string"
},
"properties": {
+ "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xmlFor more information, see Cluster properties.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xmlFor more information, see Cluster properties.",
- "type": "object"
+ }
}
},
"id": "SoftwareConfig"
},
+ "JobPlacement": {
+ "properties": {
+ "clusterName": {
+ "description": "Required. The name of the cluster where the job will be submitted.",
+ "type": "string"
+ },
+ "clusterUuid": {
+ "description": "Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.",
+ "type": "string"
+ }
+ },
+ "id": "JobPlacement",
+ "description": "Cloud Dataproc job config.",
+ "type": "object"
+ },
"PigJob": {
"description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
"type": "object",
@@ -372,26 +284,9 @@
"id": "PigJob"
},
"ClusterStatus": {
+ "description": "The status of a cluster and its instances.",
+ "type": "object",
"properties": {
- "stateStartTime": {
- "description": "Output only. Time when this state was entered.",
- "format": "google-datetime",
- "type": "string"
- },
- "substate": {
- "enumDescriptions": [
- "The cluster substate is unknown.",
- "The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.",
- "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state."
- ],
- "enum": [
- "UNSPECIFIED",
- "UNHEALTHY",
- "STALE_STATUS"
- ],
- "description": "Output only. Additional state information that includes status reported by the agent.",
- "type": "string"
- },
"detail": {
"description": "Output only. Optional details of cluster's state.",
"type": "string"
@@ -415,11 +310,28 @@
"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": {
+ "description": "Output only. Additional state information that includes status reported by the agent.",
+ "type": "string",
+ "enumDescriptions": [
+ "The cluster substate is unknown.",
+ "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"
+ ]
}
},
- "id": "ClusterStatus",
- "description": "The status of a cluster and its instances.",
- "type": "object"
+ "id": "ClusterStatus"
},
"ListClustersResponse": {
"description": "The list of all clusters in a project.",
@@ -439,91 +351,21 @@
},
"id": "ListClustersResponse"
},
- "SparkJob": {
- "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",
- "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.",
- "type": "object"
- },
"Job": {
"description": "A Cloud Dataproc job resource.",
"type": "object",
"properties": {
- "reference": {
- "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e.",
- "$ref": "JobReference"
- },
- "hadoopJob": {
- "$ref": "HadoopJob",
- "description": "Job is a Hadoop job."
- },
- "placement": {
- "description": "Required. Job information, including how, when, and where to run the job.",
- "$ref": "JobPlacement"
- },
- "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"
- },
"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"
+ "$ref": "JobScheduling",
+ "description": "Optional. Job scheduling configuration."
},
"pigJob": {
- "description": "Job is a Pig job.",
- "$ref": "PigJob"
+ "$ref": "PigJob",
+ "description": "Job is a Pig job."
},
"hiveJob": {
"description": "Job is a Hive job.",
@@ -540,6 +382,14 @@
"description": "Output only. A URI pointing to the location of the stdout of the job's driver program.",
"type": "string"
},
+ "sparkJob": {
+ "$ref": "SparkJob",
+ "description": "Job is a Spark job."
+ },
+ "sparkSqlJob": {
+ "description": "Job is a SparkSql job.",
+ "$ref": "SparkSqlJob"
+ },
"statusHistory": {
"description": "Output only. The previous job status.",
"type": "array",
@@ -547,14 +397,6 @@
"$ref": "JobStatus"
}
},
- "sparkSqlJob": {
- "description": "Job is a SparkSql job.",
- "$ref": "SparkSqlJob"
- },
- "sparkJob": {
- "$ref": "SparkJob",
- "description": "Job is a Spark job."
- },
"yarnApplications": {
"description": "Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
"type": "array",
@@ -563,15 +405,83 @@
}
},
"pysparkJob": {
- "description": "Job is a Pyspark job.",
- "$ref": "PySparkJob"
+ "$ref": "PySparkJob",
+ "description": "Job is a Pyspark job."
+ },
+ "reference": {
+ "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e.",
+ "$ref": "JobReference"
+ },
+ "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": {
+ "description": "Required. Job information, including how, when, and where to run the job.",
+ "$ref": "JobPlacement"
}
},
"id": "Job"
},
+ "SparkJob": {
+ "properties": {
+ "mainJarFileUri": {
+ "description": "The HCFS URI of the jar file that contains the main class.",
+ "type": "string"
+ },
+ "jarFileUris": {
+ "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "loggingConfig": {
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
+ },
+ "properties": {
+ "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"
+ }
+ },
+ "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",
+ "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.",
+ "type": "object"
+ },
"JobStatus": {
- "description": "Cloud Dataproc job status.",
- "type": "object",
"properties": {
"stateStartTime": {
"description": "Output only. The time when this state was entered.",
@@ -595,18 +505,6 @@
"type": "string"
},
"state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "PENDING",
- "SETUP_DONE",
- "RUNNING",
- "CANCEL_PENDING",
- "CANCEL_STARTED",
- "CANCELLED",
- "DONE",
- "ERROR",
- "ATTEMPT_FAILURE"
- ],
"description": "Output only. A state message specifying the overall job state.",
"type": "string",
"enumDescriptions": [
@@ -620,6 +518,18 @@
"The job has completed successfully.",
"The job has completed, but encountered an error.",
"Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "PENDING",
+ "SETUP_DONE",
+ "RUNNING",
+ "CANCEL_PENDING",
+ "CANCEL_STARTED",
+ "CANCELLED",
+ "DONE",
+ "ERROR",
+ "ATTEMPT_FAILURE"
]
},
"details": {
@@ -627,7 +537,9 @@
"type": "string"
}
},
- "id": "JobStatus"
+ "id": "JobStatus",
+ "description": "Cloud Dataproc job status.",
+ "type": "object"
},
"ManagedGroupConfig": {
"description": "Specifies the resources used to actively manage an instance group.",
@@ -645,29 +557,7 @@
"id": "ManagedGroupConfig"
},
"ClusterOperationStatus": {
- "description": "The status of the operation.",
- "type": "object",
"properties": {
- "state": {
- "enumDescriptions": [
- "Unused.",
- "The operation has been created.",
- "The operation is running.",
- "The operation is done; either cancelled or completed."
- ],
- "enum": [
- "UNKNOWN",
- "PENDING",
- "RUNNING",
- "DONE"
- ],
- "description": "Output only. A message containing the operation state.",
- "type": "string"
- },
- "details": {
- "description": "Output only. A message containing any operation metadata details.",
- "type": "string"
- },
"innerState": {
"description": "Output only. A message containing the detailed operation state.",
"type": "string"
@@ -676,29 +566,96 @@
"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"
+ "id": "ClusterOperationStatus",
+ "description": "The status of the operation.",
+ "type": "object"
+ },
+ "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": {
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "NEW",
+ "NEW_SAVING",
+ "SUBMITTED",
+ "ACCEPTED",
+ "RUNNING",
+ "FINISHED",
+ "FAILED",
+ "KILLED"
+ ],
+ "description": "Required. The application state.",
+ "type": "string",
+ "enumDescriptions": [
+ "Status is unspecified.",
+ "Status is NEW.",
+ "Status is NEW_SAVING.",
+ "Status is SUBMITTED.",
+ "Status is ACCEPTED.",
+ "Status is RUNNING.",
+ "Status is FINISHED.",
+ "Status is FAILED.",
+ "Status is KILLED."
+ ]
+ },
+ "name": {
+ "description": "Required. The application name.",
+ "type": "string"
+ }
+ },
+ "id": "YarnApplication"
+ },
+ "QueryList": {
+ "properties": {
+ "queries": {
+ "description": "Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "QueryList",
+ "description": "A list of queries to run on a cluster.",
+ "type": "object"
},
"HadoopJob": {
"description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
"type": "object",
"properties": {
- "mainJarFileUri": {
- "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
- "type": "string"
- },
- "jarFileUris": {
- "description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "loggingConfig": {
- "description": "Optional. The runtime log config for job execution.",
- "$ref": "LoggingConfig"
- },
"properties": {
"additionalProperties": {
"type": "string"
@@ -730,69 +687,24 @@
"items": {
"type": "string"
}
- }
- },
- "id": "HadoopJob"
- },
- "QueryList": {
- "description": "A list of queries to run on a cluster.",
- "type": "object",
- "properties": {
- "queries": {
- "description": "Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n",
+ },
+ "mainJarFileUri": {
+ "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
+ "type": "string"
+ },
+ "jarFileUris": {
+ "description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.",
"type": "array",
"items": {
"type": "string"
}
+ },
+ "loggingConfig": {
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
}
},
- "id": "QueryList"
- },
- "YarnApplication": {
- "properties": {
- "state": {
- "description": "Required. The application state.",
- "type": "string",
- "enumDescriptions": [
- "Status is unspecified.",
- "Status is NEW.",
- "Status is NEW_SAVING.",
- "Status is SUBMITTED.",
- "Status is ACCEPTED.",
- "Status is RUNNING.",
- "Status is FINISHED.",
- "Status is FAILED.",
- "Status is KILLED."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "NEW",
- "NEW_SAVING",
- "SUBMITTED",
- "ACCEPTED",
- "RUNNING",
- "FINISHED",
- "FAILED",
- "KILLED"
- ]
- },
- "name": {
- "description": "Required. The application name.",
- "type": "string"
- },
- "trackingUrl": {
- "description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.",
- "type": "string"
- },
- "progress": {
- "description": "Required. The numerical progress of the application, from 1 to 100.",
- "format": "float",
- "type": "number"
- }
- },
- "id": "YarnApplication",
- "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": "HadoopJob"
},
"DiagnoseClusterRequest": {
"description": "A request to collect cluster diagnostic information.",
@@ -844,8 +756,8 @@
"type": "object"
},
"status": {
- "description": "Output only. Current operation status.",
- "$ref": "ClusterOperationStatus"
+ "$ref": "ClusterOperationStatus",
+ "description": "Output only. Current operation status."
},
"statusHistory": {
"description": "Output only. The previous operation status.",
@@ -869,18 +781,6 @@
"description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
"type": "object",
"properties": {
- "continueOnFailure": {
- "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
- "type": "boolean"
- },
- "queryList": {
- "$ref": "QueryList",
- "description": "A list of queries."
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains Hive queries.",
- "type": "string"
- },
"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",
@@ -889,11 +789,11 @@
}
},
"scriptVariables": {
- "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
+ "type": "object"
},
"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.",
@@ -901,15 +801,27 @@
"additionalProperties": {
"type": "string"
}
+ },
+ "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": {
+ "description": "A list of queries.",
+ "$ref": "QueryList"
}
},
"id": "HiveJob"
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
"properties": {},
- "id": "Empty"
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "type": "object"
},
"DiagnoseClusterResults": {
"description": "The location of diagnostic output.",
@@ -923,7 +835,25 @@
"id": "DiagnoseClusterResults"
},
"ClusterConfig": {
+ "description": "The cluster config.",
+ "type": "object",
"properties": {
+ "gceClusterConfig": {
+ "$ref": "GceClusterConfig",
+ "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster."
+ },
+ "softwareConfig": {
+ "$ref": "SoftwareConfig",
+ "description": "Optional. The config settings for software inside the cluster."
+ },
+ "masterConfig": {
+ "description": "Optional. The Google Compute Engine config settings for the master instance in a cluster.",
+ "$ref": "InstanceGroupConfig"
+ },
+ "secondaryWorkerConfig": {
+ "$ref": "InstanceGroupConfig",
+ "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster."
+ },
"initializationActions": {
"description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):\nROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n",
"type": "array",
@@ -938,43 +868,14 @@
"workerConfig": {
"$ref": "InstanceGroupConfig",
"description": "Optional. The Google Compute Engine config settings for worker instances in a cluster."
- },
- "gceClusterConfig": {
- "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster.",
- "$ref": "GceClusterConfig"
- },
- "softwareConfig": {
- "description": "Optional. The config settings for software inside the cluster.",
- "$ref": "SoftwareConfig"
- },
- "masterConfig": {
- "description": "Optional. The Google Compute Engine config settings for the master instance in a cluster.",
- "$ref": "InstanceGroupConfig"
- },
- "secondaryWorkerConfig": {
- "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster.",
- "$ref": "InstanceGroupConfig"
}
},
- "id": "ClusterConfig",
- "description": "The cluster config.",
- "type": "object"
+ "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": {
"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",
@@ -1013,6 +914,17 @@
"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"
}
},
"id": "PySparkJob"
@@ -1021,20 +933,12 @@
"description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
"type": "object",
"properties": {
- "networkUri": {
- "description": "Optional. The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault",
- "type": "string"
- },
- "zoneUri": {
- "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f",
- "type": "string"
- },
"metadata": {
+ "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",
"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.",
@@ -1061,38 +965,22 @@
"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": {
- "acceleratorTypeUri": {
- "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80",
- "type": "string"
- },
- "acceleratorCount": {
- "description": "The number of the accelerator cards of this type exposed to this instance.",
- "format": "int32",
- "type": "integer"
- }
- },
- "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": {
- "hdfsMetrics": {
- "description": "The HDFS metrics.",
- "type": "object",
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- }
- },
"yarnMetrics": {
"additionalProperties": {
"format": "int64",
@@ -1100,17 +988,40 @@
},
"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",
@@ -1121,13 +1032,102 @@
"ERROR",
"FATAL",
"OFF"
- ]
+ ],
+ "type": "string"
},
"description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'",
"type": "object"
}
},
"id": "LoggingConfig"
+ },
+ "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": {
+ "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": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "id": "Status"
}
},
"icons": {
@@ -1159,45 +1159,10 @@
"resources": {
"clusters": {
"methods": {
- "get": {
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
- "clusterName": {
- "location": "path",
- "description": "Required. The cluster name.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "patch": {
"flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.get",
- "description": "Gets the resource representation for a cluster in a project."
- },
- "patch": {
+ "id": "dataproc.projects.regions.clusters.patch",
"description": "Updates a cluster in a project.",
"request": {
"$ref": "Cluster"
@@ -1215,6 +1180,18 @@
"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,
@@ -1222,50 +1199,29 @@
"location": "path"
},
"gracefulDecommissionTimeout": {
+ "location": "query",
"description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.",
"format": "google-duration",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"projectId": {
"location": "path",
"description": "Required. The ID of the Google Cloud Platform project 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"
- },
- "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"
}
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.patch"
+ }
},
- "diagnose": {
- "path": "v1/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.",
+ "get": {
+ "httpMethod": "GET",
"response": {
- "$ref": "Operation"
+ "$ref": "Cluster"
},
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
- "httpMethod": "POST",
"parameters": {
"clusterName": {
"location": "path",
@@ -1289,12 +1245,53 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose"
+ "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."
+ },
+ "diagnose": {
+ "request": {
+ "$ref": "DiagnoseClusterRequest"
+ },
+ "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required. The cluster name.",
+ "required": true,
+ "type": "string"
+ },
+ "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}:diagnose",
+ "id": "dataproc.projects.regions.clusters.diagnose",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose"
},
"delete": {
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.delete",
- "description": "Deletes a cluster in a project.",
"response": {
"$ref": "Operation"
},
@@ -1304,9 +1301,6 @@
"clusterName"
],
"httpMethod": "DELETE",
- "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.",
@@ -1321,33 +1315,48 @@
"type": "string"
},
"clusterName": {
+ "location": "path",
"description": "Required. The cluster name.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
+ "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."
},
"list": {
"description": "Lists all regions/{region}/clusters in a project.",
- "response": {
- "$ref": "ListClustersResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"projectId",
"region"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
"parameters": {
+ "pageSize": {
+ "description": "Optional. The standard List page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ },
"region": {
+ "location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"filter": {
"location": "query",
@@ -1358,25 +1367,20 @@
"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"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
- "path": "v1/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.list"
+ "id": "dataproc.projects.regions.clusters.list",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters"
},
"create": {
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Creates a cluster in a project.",
"response": {
"$ref": "Operation"
},
@@ -1385,9 +1389,6 @@
"region"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"projectId": {
"location": "path",
@@ -1402,13 +1403,12 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
"path": "v1/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.create",
- "description": "Creates a cluster in a project.",
- "request": {
- "$ref": "Cluster"
- }
+ "id": "dataproc.projects.regions.clusters.create"
}
}
},
@@ -1423,62 +1423,60 @@
"name"
],
"httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
"path": "v1/{+name}:cancel",
"id": "dataproc.projects.regions.operations.cancel"
},
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.",
- "httpMethod": "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/[^/]+/regions/[^/]+/operations/[^/]+$"
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "id": "dataproc.projects.regions.operations.delete",
- "path": "v1/{+name}"
+ "path": "v1/{+name}",
+ "id": "dataproc.projects.regions.operations.delete"
},
"list": {
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations",
+ "id": "dataproc.projects.regions.operations.list",
+ "path": "v1/{+name}",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
"parameterOrder": [
"name"
],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
"parameters": {
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
"filter": {
"location": "query",
"description": "The standard list filter.",
@@ -1492,120 +1490,50 @@
"location": "path"
},
"pageToken": {
- "location": "query",
"description": "The standard list page token.",
- "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": {
- "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": {
- "description": "The name of the operation resource.",
- "required": true,
"type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "dataproc.projects.regions.operations.get"
- }
- }
- },
- "jobs": {
- "methods": {
- "submit": {
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit",
- "path": "v1/projects/{projectId}/regions/{region}/jobs:submit",
- "id": "dataproc.projects.regions.jobs.submit",
- "request": {
- "$ref": "SubmitJobRequest"
- },
- "description": "Submits a job to a cluster.",
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
+ "location": "query"
},
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "delete": {
- "response": {
- "$ref": "Empty"
- },
+ "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",
"parameterOrder": [
- "projectId",
- "region",
- "jobId"
+ "name"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "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"
],
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "description": "Required. The job ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.delete",
- "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION."
- },
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
+ "id": "dataproc.projects.regions.operations.get",
+ "path": "v1/{+name}"
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
"list": {
"description": "Lists regions/{region}/jobs in a project.",
"response": {
@@ -1618,16 +1546,16 @@
"httpMethod": "GET",
"parameters": {
"pageSize": {
+ "location": "query",
"description": "Optional. The number of results to return in each response.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"region": {
- "location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"clusterName": {
"location": "query",
@@ -1669,22 +1597,15 @@
"id": "dataproc.projects.regions.jobs.list"
},
"cancel": {
- "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.",
- "request": {
- "$ref": "CancelJobRequest"
- },
- "response": {
- "$ref": "Job"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"region",
"jobId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "Job"
+ },
"parameters": {
"region": {
"location": "path",
@@ -1705,15 +1626,18 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "id": "dataproc.projects.regions.jobs.cancel",
"path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
- "id": "dataproc.projects.regions.jobs.cancel"
+ "request": {
+ "$ref": "CancelJobRequest"
+ },
+ "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get."
},
"patch": {
- "request": {
- "$ref": "Job"
- },
- "description": "Updates a job in a project.",
"httpMethod": "PATCH",
"parameterOrder": [
"projectId",
@@ -1725,16 +1649,16 @@
},
"parameters": {
"region": {
- "location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"updateMask": {
- "location": "query",
"description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
"format": "google-fieldmask",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"projectId": {
"location": "path",
@@ -1743,10 +1667,10 @@
"type": "string"
},
"jobId": {
+ "location": "path",
"description": "Required. The job ID.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -1754,10 +1678,13 @@
],
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
"id": "dataproc.projects.regions.jobs.patch",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}"
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Updates a job in a project."
},
"get": {
- "description": "Gets the resource representation for a job in a project.",
"httpMethod": "GET",
"response": {
"$ref": "Job"
@@ -1775,14 +1702,87 @@
"location": "path"
},
"jobId": {
- "location": "path",
"description": "Required. The job ID.",
"required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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}",
+ "description": "Gets the resource representation for a job in a project."
+ },
+ "submit": {
+ "request": {
+ "$ref": "SubmitJobRequest"
+ },
+ "description": "Submits a job to a cluster.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
"type": "string"
},
"region": {
+ "location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit",
+ "id": "dataproc.projects.regions.jobs.submit",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs:submit"
+ },
+ "delete": {
+ "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "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"
}
@@ -1791,7 +1791,7 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.get",
+ "id": "dataproc.projects.regions.jobs.delete",
"path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}"
}
}
@@ -1802,64 +1802,19 @@
}
},
"parameters": {
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "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": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1868,8 +1823,11 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
"type": "string"
},
"alt": {
@@ -1887,11 +1845,53 @@
"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"
+ },
+ "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"
}
},
"version": "v1",
"baseUrl": "https://dataproc.googleapis.com/",
- "servicePath": "",
+ "kind": "discovery#restDescription",
"description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
- "kind": "discovery#restDescription"
+ "servicePath": ""
}
diff --git a/dataproc/v1beta2/dataproc-api.json b/dataproc/v1beta2/dataproc-api.json
index d6e68d4..e91ec91 100644
--- a/dataproc/v1beta2/dataproc-api.json
+++ b/dataproc/v1beta2/dataproc-api.json
@@ -1,25 +1,259 @@
{
- "documentationLink": "https://cloud.google.com/dataproc/",
"id": "dataproc:v1beta2",
+ "documentationLink": "https://cloud.google.com/dataproc/",
"revision": "20180122",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "InstantiateWorkflowTemplateRequest": {
+ "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": {
+ "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"
+ }
+ },
+ "id": "PySparkJob"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for TestIamPermissions method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "AcceleratorConfig": {
+ "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
+ "type": "object",
+ "properties": {
+ "acceleratorTypeUri": {
+ "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80",
+ "type": "string"
+ },
+ "acceleratorCount": {
+ "description": "The number of the accelerator cards of this type exposed to this instance.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "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": {
+ "description": "The YARN metrics.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "hdfsMetrics": {
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "The HDFS metrics.",
+ "type": "object"
+ }
+ },
+ "id": "ClusterMetrics"
+ },
+ "LoggingConfig": {
+ "properties": {
+ "driverLogLevels": {
+ "additionalProperties": {
+ "enum": [
+ "LEVEL_UNSPECIFIED",
+ "ALL",
+ "TRACE",
+ "DEBUG",
+ "INFO",
+ "WARN",
+ "ERROR",
+ "FATAL",
+ "OFF"
+ ],
+ "type": "string"
+ },
+ "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'",
+ "type": "object"
+ }
+ },
+ "id": "LoggingConfig",
+ "description": "The runtime logging config of the job.",
+ "type": "object"
+ },
+ "OrderedJob": {
+ "description": "A job executed by the workflow.",
+ "type": "object",
+ "properties": {
+ "sparkSqlJob": {
+ "$ref": "SparkSqlJob",
+ "description": "Job is a SparkSql job."
+ },
+ "sparkJob": {
+ "$ref": "SparkJob",
+ "description": "Job is a Spark job."
+ },
+ "pysparkJob": {
+ "description": "Job is a Pyspark job.",
+ "$ref": "PySparkJob"
+ },
+ "scheduling": {
+ "$ref": "JobScheduling",
+ "description": "Optional. Job scheduling configuration."
+ },
+ "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"
+ },
+ "prerequisiteStepIds": {
+ "description": "Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given job.",
+ "type": "object"
+ }
+ },
+ "id": "OrderedJob"
+ },
+ "WorkflowNode": {
+ "description": "The workflow node.",
+ "type": "object",
+ "properties": {
+ "prerequisiteStepIds": {
+ "description": "Output only. Node's prerequisite nodes.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "state": {
+ "enum": [
+ "NODE_STATUS_UNSPECIFIED",
+ "BLOCKED",
+ "RUNNABLE",
+ "RUNNING",
+ "COMPLETED",
+ "FAILED"
+ ],
+ "description": "Output only. The node state.",
+ "type": "string",
+ "enumDescriptions": [
+ "State is unspecified.",
+ "The node is awaiting prerequisite node to finish.",
+ "The node is runnable but not running.",
+ "The node is running.",
+ "The node completed successfully.",
+ "The node failed. A node can be marked FAILED because its ancestor or peer failed."
+ ]
+ },
+ "stepId": {
+ "description": "Output only. The name of the node.",
+ "type": "string"
+ },
+ "error": {
+ "description": "Output only. The error detail.",
+ "type": "string"
+ },
+ "jobId": {
+ "description": "Output only. The job id; populated after the node enters RUNNING state.",
+ "type": "string"
+ }
+ },
+ "id": "WorkflowNode"
+ },
+ "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",
- "description": "A request to instantiate a workflow template.",
- "type": "object"
+ "id": "InstantiateWorkflowTemplateRequest"
},
"SubmitJobRequest": {
"description": "A request to submit a job.",
@@ -33,6 +267,8 @@
"id": "SubmitJobRequest"
},
"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.",
@@ -40,18 +276,12 @@
"type": "integer"
}
},
- "id": "JobScheduling",
- "description": "Job scheduling options.",
- "type": "object"
+ "id": "JobScheduling"
},
"Cluster": {
"description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.",
"type": "object",
"properties": {
- "projectId": {
- "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.",
- "type": "string"
- },
"labels": {
"additionalProperties": {
"type": "string"
@@ -75,8 +305,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.",
@@ -85,6 +315,10 @@
"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"
@@ -112,11 +346,11 @@
"type": "string"
},
"properties": {
+ "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xmlFor more information, see Cluster properties.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xmlFor more information, see Cluster properties.",
- "type": "object"
+ }
}
},
"id": "SoftwareConfig"
@@ -143,21 +377,44 @@
"description": "Specifies workflow execution target.Either managed_cluster or cluster_selector is required.",
"type": "object",
"properties": {
- "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.",
- "$ref": "ClusterSelector"
- },
"managedCluster": {
"$ref": "ManagedCluster",
"description": "Optional. A cluster that is managed by the workflow."
+ },
+ "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.",
+ "$ref": "ClusterSelector"
}
},
"id": "WorkflowTemplatePlacement"
},
+ "ClusterOperation": {
+ "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",
+ "description": "The cluster operation triggered by a workflow.",
+ "type": "object"
+ },
"WorkflowMetadata": {
"description": "A Cloud Dataproc workflow template resource.",
"type": "object",
"properties": {
+ "deleteCluster": {
+ "description": "Output only. The delete cluster operation metadata.",
+ "$ref": "ClusterOperation"
+ },
"state": {
"enum": [
"UNKNOWN",
@@ -194,37 +451,18 @@
"template": {
"description": "Output only. The \"resource name\" of the template.",
"type": "string"
- },
- "deleteCluster": {
- "$ref": "ClusterOperation",
- "description": "Output only. The delete cluster operation metadata."
}
},
"id": "WorkflowMetadata"
},
- "ClusterOperation": {
- "description": "The cluster operation triggered by a workflow.",
- "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": {
+ "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",
@@ -267,10 +505,6 @@
"items": {
"type": "string"
}
- },
- "mainJarFileUri": {
- "description": "The HCFS URI of the jar file that contains the main class.",
- "type": "string"
}
},
"id": "SparkJob"
@@ -279,20 +513,29 @@
"description": "Cloud Dataproc job status.",
"type": "object",
"properties": {
- "state": {
+ "stateStartTime": {
+ "description": "Output only. The time when this state was entered.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "substate": {
"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."
+ "The job substate is unknown.",
+ "The Job is submitted to the agent.Applies to RUNNING state.",
+ "The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
+ "The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
],
"enum": [
+ "UNSPECIFIED",
+ "SUBMITTED",
+ "QUEUED",
+ "STALE_STATUS"
+ ],
+ "description": "Output only. Additional state information, which includes status reported by the agent.",
+ "type": "string"
+ },
+ "state": {
+ "enum": [
"STATE_UNSPECIFIED",
"PENDING",
"SETUP_DONE",
@@ -305,32 +548,23 @@
"ATTEMPT_FAILURE"
],
"description": "Output only. A state message specifying the overall job state.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "The job state is unknown.",
+ "The job is pending; it has been submitted, but is not yet running.",
+ "Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.",
+ "The job is running on the cluster.",
+ "A CancelJob request has been received, but is pending.",
+ "Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.",
+ "The job cancellation was successful.",
+ "The job has completed successfully.",
+ "The job has completed, but encountered an error.",
+ "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only."
+ ]
},
"details": {
"description": "Output only. Optional job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
"type": "string"
- },
- "stateStartTime": {
- "description": "Output only. The time when this state was entered.",
- "format": "google-datetime",
- "type": "string"
- },
- "substate": {
- "enum": [
- "UNSPECIFIED",
- "SUBMITTED",
- "QUEUED",
- "STALE_STATUS"
- ],
- "description": "Output only. Additional state information, which includes status reported by the agent.",
- "type": "string",
- "enumDescriptions": [
- "The job substate is unknown.",
- "The Job is submitted to the agent.Applies to RUNNING state.",
- "The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
- "The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
- ]
}
},
"id": "JobStatus"
@@ -342,12 +576,9 @@
"id": "DiagnoseClusterRequest"
},
"DiskConfig": {
+ "description": "Specifies the config of disk options for a group of VM instances.",
+ "type": "object",
"properties": {
- "bootDiskSizeGb": {
- "description": "Optional. Size in GB of the boot disk (default is 500GB).",
- "format": "int32",
- "type": "integer"
- },
"bootDiskType": {
"description": "Optional. Type of the boot disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) or \"pd-standard\" (Persistent Disk Hard Disk Drive).",
"type": "string"
@@ -356,16 +587,27 @@
"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"
+ "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",
@@ -374,11 +616,11 @@
}
},
"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": {
"description": "Output only. Current operation status.",
@@ -398,26 +640,43 @@
"clusterName": {
"description": "Output only. Name of the cluster for the operation.",
"type": "string"
- },
- "operationType": {
- "description": "Output only. The operation type.",
- "type": "string"
- },
- "description": {
- "description": "Output only. Short description of operation.",
- "type": "string"
}
},
"id": "ClusterOperationMetadata"
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
"properties": {},
- "id": "Empty"
+ "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"
},
"GceClusterConfig": {
+ "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
+ "type": "object",
"properties": {
+ "subnetworkUri": {
+ "description": "Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0",
+ "type": "string"
+ },
+ "networkUri": {
+ "description": "Optional. The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault",
+ "type": "string"
+ },
+ "zoneUri": {
+ "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f",
+ "type": "string"
+ },
+ "internalIpOnly": {
+ "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
+ "type": "boolean"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).",
+ "type": "object"
+ },
"serviceAccountScopes": {
"description": "Optional. The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:\nhttps://www.googleapis.com/auth/cloud.useraccounts.readonly\nhttps://www.googleapis.com/auth/devstorage.read_write\nhttps://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:\nhttps://www.googleapis.com/auth/bigquery\nhttps://www.googleapis.com/auth/bigtable.admin.table\nhttps://www.googleapis.com/auth/bigtable.data\nhttps://www.googleapis.com/auth/devstorage.full_control",
"type": "array",
@@ -435,39 +694,21 @@
"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"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).",
- "type": "object"
- },
- "internalIpOnly": {
- "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
- "type": "boolean"
}
},
- "id": "GceClusterConfig",
- "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
- "type": "object"
+ "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/docs).",
"type": "object",
"properties": {
+ "bindings": {
+ "description": "Associates a list of members to a role. bindings with no members will result in an error.",
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
+ }
+ },
"etag": {
"description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.",
"format": "byte",
@@ -477,20 +718,11 @@
"description": "Deprecated.",
"format": "int32",
"type": "integer"
- },
- "bindings": {
- "description": "Associates a list of members to a role. bindings with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
}
},
"id": "Policy"
},
"Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
"properties": {
"response": {
"additionalProperties": {
@@ -521,20 +753,22 @@
"type": "boolean"
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object"
},
"ListWorkflowTemplatesResponse": {
"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",
@@ -560,6 +794,17 @@
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
@@ -568,17 +813,6 @@
"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"
@@ -602,20 +836,9 @@
"id": "Binding"
},
"InstanceGroupConfig": {
+ "description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
+ "type": "object",
"properties": {
- "numInstances": {
- "description": "Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.",
- "format": "int32",
- "type": "integer"
- },
- "minCpuPlatform": {
- "description": "Optional. Specifies the minimum cpu platform for the Instance Group. See Cloud Dataproc→Minimum 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"
@@ -645,11 +868,22 @@
"items": {
"$ref": "AcceleratorConfig"
}
+ },
+ "numInstances": {
+ "description": "Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minCpuPlatform": {
+ "description": "Optional. Specifies the minimum cpu platform for the Instance Group. See Cloud Dataproc→Minimum CPU Platform.",
+ "type": "string"
+ },
+ "diskConfig": {
+ "$ref": "DiskConfig",
+ "description": "Optional. Disk option config settings."
}
},
- "id": "InstanceGroupConfig",
- "description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
- "type": "object"
+ "id": "InstanceGroupConfig"
},
"NodeInitializationAction": {
"description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
@@ -695,12 +929,20 @@
"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": {
- "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
+ "type": "object"
},
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.",
@@ -710,8 +952,8 @@
}
},
"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": {
@@ -719,14 +961,6 @@
},
"description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
"type": "object"
- },
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains SQL queries.",
- "type": "string"
}
},
"id": "SparkSqlJob"
@@ -750,8 +984,6 @@
"id": "ListOperationsResponse"
},
"JobPlacement": {
- "description": "Cloud Dataproc job config.",
- "type": "object",
"properties": {
"clusterName": {
"description": "Required. The name of the cluster where the job will be submitted.",
@@ -762,7 +994,9 @@
"type": "string"
}
},
- "id": "JobPlacement"
+ "id": "JobPlacement",
+ "description": "Cloud Dataproc job config.",
+ "type": "object"
},
"ClusterStatus": {
"description": "The status of a cluster and its instances.",
@@ -774,8 +1008,6 @@
"type": "string"
},
"substate": {
- "description": "Output only. Additional state information that includes status reported by the agent.",
- "type": "string",
"enumDescriptions": [
"The cluster substate is unknown.",
"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.",
@@ -785,13 +1017,23 @@
"UNSPECIFIED",
"UNHEALTHY",
"STALE_STATUS"
- ]
+ ],
+ "description": "Output only. Additional state information that includes status reported by the agent.",
+ "type": "string"
},
"detail": {
"description": "Output only. Optional details of cluster's state.",
"type": "string"
},
"state": {
+ "enumDescriptions": [
+ "The cluster state is unknown.",
+ "The cluster is being created and set up. It is not ready for use.",
+ "The cluster is currently running and healthy. It is ready for use.",
+ "The cluster encountered an error. It is not ready for use.",
+ "The cluster is being deleted. It cannot be used.",
+ "The cluster is being updated. It continues to accept and process jobs."
+ ],
"enum": [
"UNKNOWN",
"CREATING",
@@ -801,15 +1043,7 @@
"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."
- ]
+ "type": "string"
}
},
"id": "ClusterStatus"
@@ -818,6 +1052,18 @@
"description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
"type": "object",
"properties": {
+ "continueOnFailure": {
+ "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
+ "type": "boolean"
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains the Pig queries.",
+ "type": "string"
+ },
+ "queryList": {
+ "description": "A list of queries.",
+ "$ref": "QueryList"
+ },
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.",
"type": "array",
@@ -833,8 +1079,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": {
@@ -842,18 +1088,6 @@
},
"description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
"type": "object"
- },
- "continueOnFailure": {
- "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
- "type": "boolean"
- },
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains the Pig queries.",
- "type": "string"
}
},
"id": "PigJob"
@@ -882,8 +1116,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.",
@@ -894,14 +1128,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"
@@ -928,18 +1162,6 @@
"description": "A Cloud Dataproc job resource.",
"type": "object",
"properties": {
- "hadoopJob": {
- "$ref": "HadoopJob",
- "description": "Job is a Hadoop job."
- },
- "placement": {
- "description": "Required. Job information, including how, when, and where to run the job.",
- "$ref": "JobPlacement"
- },
- "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"
- },
"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"
@@ -949,8 +1171,8 @@
"description": "Optional. Job scheduling configuration."
},
"pigJob": {
- "$ref": "PigJob",
- "description": "Job is a Pig job."
+ "description": "Job is a Pig job.",
+ "$ref": "PigJob"
},
"hiveJob": {
"$ref": "HiveJob",
@@ -975,8 +1197,8 @@
}
},
"sparkSqlJob": {
- "description": "Job is a SparkSql job.",
- "$ref": "SparkSqlJob"
+ "$ref": "SparkSqlJob",
+ "description": "Job is a SparkSql job."
},
"sparkJob": {
"$ref": "SparkJob",
@@ -990,17 +1212,31 @@
}
},
"pysparkJob": {
- "description": "Job is a Pyspark job.",
- "$ref": "PySparkJob"
+ "$ref": "PySparkJob",
+ "description": "Job is a Pyspark job."
},
"reference": {
- "$ref": "JobReference",
- "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e."
+ "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e.",
+ "$ref": "JobReference"
+ },
+ "hadoopJob": {
+ "description": "Job is a Hadoop job.",
+ "$ref": "HadoopJob"
+ },
+ "placement": {
+ "$ref": "JobPlacement",
+ "description": "Required. Job information, including how, when, and where to run the job."
+ },
+ "status": {
+ "$ref": "JobStatus",
+ "description": "Output only. The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields."
}
},
"id": "Job"
},
"LifecycleConfig": {
+ "description": "Specifies the cluster auto delete related schedule configuration.",
+ "type": "object",
"properties": {
"autoDeleteTtl": {
"description": "Optional. The life duration of cluster, the cluster will be auto-deleted at the end of this duration.",
@@ -1018,9 +1254,7 @@
"type": "string"
}
},
- "id": "LifecycleConfig",
- "description": "Specifies the cluster auto delete related schedule configuration.",
- "type": "object"
+ "id": "LifecycleConfig"
},
"ManagedGroupConfig": {
"description": "Specifies the resources used to actively manage an instance group.",
@@ -1041,18 +1275,7 @@
"description": "The status of the operation.",
"type": "object",
"properties": {
- "stateStartTime": {
- "description": "Output only. The time this state was entered.",
- "format": "google-datetime",
- "type": "string"
- },
"state": {
- "enumDescriptions": [
- "Unused.",
- "The operation has been created.",
- "The operation is running.",
- "The operation is done; either cancelled or completed."
- ],
"enum": [
"UNKNOWN",
"PENDING",
@@ -1060,7 +1283,13 @@
"DONE"
],
"description": "Output only. A message containing the operation state.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unused.",
+ "The operation has been created.",
+ "The operation is running.",
+ "The operation is done; either cancelled or completed."
+ ]
},
"details": {
"description": "Output only. A message containing any operation metadata details.",
@@ -1069,6 +1298,11 @@
"innerState": {
"description": "Output only. A message containing the detailed operation state.",
"type": "string"
+ },
+ "stateStartTime": {
+ "description": "Output only. The time this state was entered.",
+ "format": "google-datetime",
+ "type": "string"
}
},
"id": "ClusterOperationStatus"
@@ -1085,8 +1319,8 @@
"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.",
@@ -1095,52 +1329,6 @@
},
"id": "ManagedCluster"
},
- "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": {
- "enum": [
- "STATE_UNSPECIFIED",
- "NEW",
- "NEW_SAVING",
- "SUBMITTED",
- "ACCEPTED",
- "RUNNING",
- "FINISHED",
- "FAILED",
- "KILLED"
- ],
- "description": "Required. The application state.",
- "type": "string",
- "enumDescriptions": [
- "Status is unspecified.",
- "Status is NEW.",
- "Status is NEW_SAVING.",
- "Status is SUBMITTED.",
- "Status is ACCEPTED.",
- "Status is RUNNING.",
- "Status is FINISHED.",
- "Status is FAILED.",
- "Status is KILLED."
- ]
- },
- "name": {
- "description": "Required. The application name.",
- "type": "string"
- }
- },
- "id": "YarnApplication"
- },
"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",
@@ -1157,11 +1345,11 @@
"description": "Optional. The runtime log config for job execution."
},
"properties": {
- "description": "Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.",
+ "type": "object"
},
"args": {
"description": "Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
@@ -1209,13 +1397,59 @@
},
"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": {
+ "description": "Required. The application state.",
+ "type": "string",
+ "enumDescriptions": [
+ "Status is unspecified.",
+ "Status is NEW.",
+ "Status is NEW_SAVING.",
+ "Status is SUBMITTED.",
+ "Status is ACCEPTED.",
+ "Status is RUNNING.",
+ "Status is FINISHED.",
+ "Status is FAILED.",
+ "Status is KILLED."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "NEW",
+ "NEW_SAVING",
+ "SUBMITTED",
+ "ACCEPTED",
+ "RUNNING",
+ "FINISHED",
+ "FAILED",
+ "KILLED"
+ ]
+ },
+ "name": {
+ "description": "Required. The application name.",
+ "type": "string"
+ }
+ },
+ "id": "YarnApplication"
+ },
"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 the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.",
- "$ref": "Policy"
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them."
}
},
"id": "SetIamPolicyRequest"
@@ -1224,18 +1458,6 @@
"description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
"type": "object",
"properties": {
- "continueOnFailure": {
- "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
- "type": "boolean"
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains Hive queries.",
- "type": "string"
- },
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
"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",
@@ -1251,26 +1473,27 @@
"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"
+ },
+ "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."
}
},
"id": "HiveJob"
},
- "DiagnoseClusterResults": {
- "properties": {
- "outputUri": {
- "description": "Output only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.",
- "type": "string"
- }
- },
- "id": "DiagnoseClusterResults",
- "description": "The location of diagnostic output.",
- "type": "object"
- },
"WorkflowGraph": {
"description": "The workflow graph.",
"type": "object",
@@ -1285,19 +1508,32 @@
},
"id": "WorkflowGraph"
},
+ "DiagnoseClusterResults": {
+ "description": "The location of diagnostic output.",
+ "type": "object",
+ "properties": {
+ "outputUri": {
+ "description": "Output only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.",
+ "type": "string"
+ }
+ },
+ "id": "DiagnoseClusterResults"
+ },
"ClusterConfig": {
+ "description": "The cluster config.",
+ "type": "object",
"properties": {
"masterConfig": {
- "$ref": "InstanceGroupConfig",
- "description": "Optional. The Google Compute Engine config settings for the master instance in a cluster."
+ "description": "Optional. The Google Compute Engine config settings for the master instance in a cluster.",
+ "$ref": "InstanceGroupConfig"
},
"secondaryWorkerConfig": {
"description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster.",
"$ref": "InstanceGroupConfig"
},
"lifecycleConfig": {
- "$ref": "LifecycleConfig",
- "description": "Optional. The config setting for auto delete cluster schedule."
+ "description": "Optional. The config setting for auto delete cluster schedule.",
+ "$ref": "LifecycleConfig"
},
"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",
@@ -1311,8 +1547,8 @@
"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": {
"description": "Required. The shared Google Compute Engine config settings for all instances in a cluster.",
@@ -1323,249 +1559,13 @@
"$ref": "SoftwareConfig"
}
},
- "id": "ClusterConfig",
- "description": "The cluster config.",
- "type": "object"
- },
- "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": {
- "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"
- }
- },
- "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"
- },
- "TestIamPermissionsRequest": {
- "description": "Request message for TestIamPermissions method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "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": {
- "description": "The YARN metrics.",
- "type": "object",
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- }
- },
- "hdfsMetrics": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "The HDFS metrics.",
- "type": "object"
- }
- },
- "id": "ClusterMetrics"
- },
- "LoggingConfig": {
- "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": {
- "enum": [
- "LEVEL_UNSPECIFIED",
- "ALL",
- "TRACE",
- "DEBUG",
- "INFO",
- "WARN",
- "ERROR",
- "FATAL",
- "OFF"
- ],
- "type": "string"
- }
- }
- },
- "id": "LoggingConfig",
- "description": "The runtime logging config of the job.",
- "type": "object"
- },
- "OrderedJob": {
- "properties": {
- "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": {
- "$ref": "PigJob",
- "description": "Job is a Pig job."
- },
- "hadoopJob": {
- "description": "Job is a Hadoop job.",
- "$ref": "HadoopJob"
- },
- "hiveJob": {
- "description": "Job is a Hive job.",
- "$ref": "HiveJob"
- },
- "prerequisiteStepIds": {
- "description": "Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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"
- }
- },
- "sparkSqlJob": {
- "$ref": "SparkSqlJob",
- "description": "Job is a SparkSql job."
- },
- "sparkJob": {
- "description": "Job is a Spark job.",
- "$ref": "SparkJob"
- },
- "pysparkJob": {
- "description": "Job is a Pyspark job.",
- "$ref": "PySparkJob"
- },
- "scheduling": {
- "description": "Optional. Job scheduling configuration.",
- "$ref": "JobScheduling"
- }
- },
- "id": "OrderedJob",
- "description": "A job executed by the workflow.",
- "type": "object"
- },
- "WorkflowNode": {
- "description": "The workflow node.",
- "type": "object",
- "properties": {
- "state": {
- "enum": [
- "NODE_STATUS_UNSPECIFIED",
- "BLOCKED",
- "RUNNABLE",
- "RUNNING",
- "COMPLETED",
- "FAILED"
- ],
- "description": "Output only. The node state.",
- "type": "string",
- "enumDescriptions": [
- "State is unspecified.",
- "The node is awaiting prerequisite node to finish.",
- "The node is runnable but not running.",
- "The node is running.",
- "The node completed successfully.",
- "The node failed. A node can be marked FAILED because its ancestor or peer failed."
- ]
- },
- "stepId": {
- "description": "Output only. The name of the node.",
- "type": "string"
- },
- "error": {
- "description": "Output only. The error detail.",
- "type": "string"
- },
- "jobId": {
- "description": "Output only. The job id; populated after the node enters RUNNING state.",
- "type": "string"
- },
- "prerequisiteStepIds": {
- "description": "Output only. Node's prerequisite nodes.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "WorkflowNode"
+ "id": "ClusterConfig"
}
},
"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": "Dataproc",
"auth": {
@@ -1587,39 +1587,498 @@
"resources": {
"projects": {
"resources": {
- "regions": {
+ "locations": {
"resources": {
- "clusters": {
+ "workflowTemplates": {
"methods": {
- "testIamPermissions": {
+ "delete": {
+ "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.",
"response": {
- "$ref": "TestIamPermissionsResponse"
+ "$ref": "Empty"
},
"parameterOrder": [
- "resource"
+ "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": {
+ "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"
+ }
+ }
+ },
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "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"
+ }
+ }
+ },
+ "create": {
+ "request": {
+ "$ref": "WorkflowTemplate"
+ },
+ "description": "Creates new workflow template.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "WorkflowTemplate"
+ },
+ "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",
+ "id": "dataproc.projects.locations.workflowTemplates.create",
+ "path": "v1beta2/{+parent}/workflowTemplates"
+ },
+ "instantiate": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
+ "location": "path",
+ "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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 operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be 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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "version": {
+ "location": "query",
+ "description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
+ "location": "path",
+ "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "instantiateInline": {
+ "description": "Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.",
+ "request": {
+ "$ref": "WorkflowTemplate"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"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.",
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "Required. The \"resource name\" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
+ "required": true,
+ "type": "string"
+ },
+ "instanceId": {
+ "location": "query",
+ "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"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates:instantiateInline",
+ "path": "v1beta2/{+parent}/workflowTemplates:instantiateInline",
+ "id": "dataproc.projects.locations.workflowTemplates.instantiateInline"
+ },
+ "update": {
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
+ "path": "v1beta2/{+name}",
+ "id": "dataproc.projects.locations.workflowTemplates.update",
+ "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.",
+ "request": {
+ "$ref": "WorkflowTemplate"
+ },
+ "response": {
+ "$ref": "WorkflowTemplate"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
+ "location": "path",
+ "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ "required": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "regions": {
+ "resources": {
+ "jobs": {
+ "methods": {
+ "list": {
+ "id": "dataproc.projects.regions.jobs.list",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs",
+ "description": "Lists regions/{region}/jobs in a project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "parameters": {
+ "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"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterName": {
+ "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs"
+ },
+ "cancel": {
+ "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.",
+ "request": {
+ "$ref": "CancelJobRequest"
+ },
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "Required. The job ID.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "id": "dataproc.projects.regions.jobs.cancel"
+ },
+ "patch": {
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.patch",
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Updates a job in a project.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "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"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:testIamPermissions",
- "path": "v1beta2/{+resource}:testIamPermissions",
- "id": "dataproc.projects.regions.clusters.testIamPermissions",
- "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.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- }
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
- "diagnose": {
+ "get": {
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "Required. The job ID.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "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."
+ },
+ "submit": {
+ "request": {
+ "$ref": "SubmitJobRequest"
+ },
+ "description": "Submits a job to a cluster.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
+ "id": "dataproc.projects.regions.jobs.submit"
+ },
+ "delete": {
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.delete",
+ "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "Required. The job ID.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "clusters": {
+ "methods": {
+ "patch": {
"response": {
"$ref": "Operation"
},
@@ -1628,10 +2087,7 @@
"region",
"clusterName"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "httpMethod": "PATCH",
"parameters": {
"clusterName": {
"location": "path",
@@ -1639,8 +2095,14 @@
"required": true,
"type": "string"
},
+ "gracefulDecommissionTimeout": {
+ "description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.",
+ "format": "google-duration",
+ "type": "string",
+ "location": "query"
+ },
"projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
"required": true,
"type": "string",
"location": "path"
@@ -1650,26 +2112,102 @@
"required": true,
"type": "string",
"location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Required. Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e currently only some fields can be updated: |Mask|Purpose| |labels|Updates labels| |config.worker_config.num_instances|Resize primary worker group| |config.secondary_worker_config.num_instances|Resize secondary worker group|",
+ "format": "google-fieldmask",
+ "type": "string"
}
},
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
- "id": "dataproc.projects.regions.clusters.diagnose",
- "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.patch",
"request": {
- "$ref": "DiagnoseClusterRequest"
- }
+ "$ref": "Cluster"
+ },
+ "description": "Updates a cluster in a project."
},
- "delete": {
- "httpMethod": "DELETE",
+ "get": {
+ "description": "Gets the resource representation for a cluster in a project.",
+ "response": {
+ "$ref": "Cluster"
+ },
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterName": {
+ "description": "Required. The cluster name.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.get"
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:testIamPermissions",
+ "path": "v1beta2/{+resource}:testIamPermissions",
+ "id": "dataproc.projects.regions.clusters.testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning."
+ },
+ "delete": {
+ "description": "Deletes a cluster in a project.",
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "DELETE",
"parameters": {
"region": {
"description": "Required. The Cloud Dataproc region in which to handle the request.",
@@ -1699,9 +2237,49 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.delete",
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "description": "Deletes a cluster in a project."
+ "id": "dataproc.projects.regions.clusters.delete"
+ },
+ "diagnose": {
+ "request": {
+ "$ref": "DiagnoseClusterRequest"
+ },
+ "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "clusterName": {
+ "location": "path",
+ "description": "Required. The cluster name.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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"
},
"list": {
"description": "Lists all regions/{region}/clusters in a project.",
@@ -1713,20 +2291,17 @@
"region"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"pageToken": {
- "location": "query",
"description": "Optional. The standard List page token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
- "location": "query",
"description": "Optional. The standard List page size.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"projectId": {
"location": "path",
@@ -1735,10 +2310,10 @@
"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"
},
"filter": {
"location": "query",
@@ -1746,11 +2321,20 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters",
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
"id": "dataproc.projects.regions.clusters.list"
},
"create": {
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.create",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Creates a cluster in a project.",
"response": {
"$ref": "Operation"
},
@@ -1776,41 +2360,35 @@
"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",
- "request": {
- "$ref": "Cluster"
- },
- "description": "Creates a cluster in a project."
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters"
},
"setIamPolicy": {
+ "path": "v1beta2/{+resource}:setIamPolicy",
+ "id": "dataproc.projects.regions.clusters.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"request": {
"$ref": "SetIamPolicyRequest"
},
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "Policy"
},
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy",
- "id": "dataproc.projects.regions.clusters.setIamPolicy",
- "path": "v1beta2/{+resource}:setIamPolicy"
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy"
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
@@ -1823,11 +2401,11 @@
"httpMethod": "GET",
"parameters": {
"resource": {
- "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
- "location": "path",
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -1836,181 +2414,25 @@
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy",
"path": "v1beta2/{+resource}:getIamPolicy",
"id": "dataproc.projects.regions.clusters.getIamPolicy"
- },
- "get": {
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterName": {
- "description": "Required. The cluster name.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.get",
- "description": "Gets the resource representation for a cluster in a project."
- },
- "patch": {
- "request": {
- "$ref": "Cluster"
- },
- "description": "Updates a cluster in a project.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "clusterName": {
- "description": "Required. The cluster name.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "gracefulDecommissionTimeout": {
- "location": "query",
- "description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.",
- "format": "google-duration",
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.patch",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}"
}
}
},
"workflowTemplates": {
"methods": {
- "update": {
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
- "path": "v1beta2/{+name}",
- "id": "dataproc.projects.regions.workflowTemplates.update",
- "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.",
- "request": {
- "$ref": "WorkflowTemplate"
- }
- },
- "delete": {
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
- "id": "dataproc.projects.regions.workflowTemplates.delete",
- "path": "v1beta2/{+name}",
- "description": "Deletes a workflow template. It does not cancel in-progress workflows.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
- "location": "path",
- "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "required": true,
- "type": "string"
- },
- "version": {
- "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"
- ]
- },
"list": {
- "description": "Lists workflows that match the specified filter in the request.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListWorkflowTemplatesResponse"
},
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
- "type": "string"
- },
"pageSize": {
+ "location": "query",
"description": "Optional. The maximum number of results to return in each response.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"parent": {
"pattern": "^projects/[^/]+/regions/[^/]+$",
@@ -2018,14 +2440,20 @@
"description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
"required": true,
"type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates",
+ "id": "dataproc.projects.regions.workflowTemplates.list",
"path": "v1beta2/{+parent}/workflowTemplates",
- "id": "dataproc.projects.regions.workflowTemplates.list"
+ "description": "Lists workflows that match the specified filter in the request."
},
"create": {
"description": "Creates new workflow template.",
@@ -2044,11 +2472,11 @@
],
"parameters": {
"parent": {
- "pattern": "^projects/[^/]+/regions/[^/]+$",
- "location": "path",
"description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+$",
+ "location": "path"
}
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates",
@@ -2056,32 +2484,32 @@
"id": "dataproc.projects.regions.workflowTemplates.create"
},
"instantiate": {
- "path": "v1beta2/{+name}:instantiate",
- "id": "dataproc.projects.regions.workflowTemplates.instantiate",
- "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.",
"request": {
"$ref": "InstantiateWorkflowTemplateRequest"
},
- "response": {
- "$ref": "Operation"
- },
+ "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.",
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"location": "path",
"description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
+ "id": "dataproc.projects.regions.workflowTemplates.instantiate",
+ "path": "v1beta2/{+name}:instantiate"
},
"get": {
"response": {
@@ -2095,18 +2523,18 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "name": {
- "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
- "location": "path"
- },
"version": {
"location": "query",
"description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current 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/[^/]+$"
}
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
@@ -2115,37 +2543,96 @@
"description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter."
},
"instantiateInline": {
- "path": "v1beta2/{+parent}/workflowTemplates:instantiateInline",
- "id": "dataproc.projects.regions.workflowTemplates.instantiateInline",
"request": {
"$ref": "WorkflowTemplate"
},
"description": "Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.",
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/regions/[^/]+$",
- "location": "path",
- "description": "Required. The \"resource name\" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
- "required": true,
+ "instanceId": {
+ "location": "query",
+ "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"
},
- "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.",
+ "parent": {
+ "description": "Required. The \"resource name\" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
+ "required": true,
"type": "string",
- "location": "query"
+ "pattern": "^projects/[^/]+/regions/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates:instantiateInline"
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates:instantiateInline",
+ "id": "dataproc.projects.regions.workflowTemplates.instantiateInline",
+ "path": "v1beta2/{+parent}/workflowTemplates:instantiateInline"
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "WorkflowTemplate"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
+ "id": "dataproc.projects.regions.workflowTemplates.update",
+ "path": "v1beta2/{+name}",
+ "request": {
+ "$ref": "WorkflowTemplate"
+ },
+ "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version."
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$"
+ },
+ "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}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
+ "path": "v1beta2/{+name}",
+ "id": "dataproc.projects.regions.workflowTemplates.delete",
+ "description": "Deletes a workflow template. It does not cancel in-progress workflows."
}
}
},
@@ -2161,11 +2648,11 @@
"httpMethod": "POST",
"parameters": {
"name": {
+ "location": "path",
"description": "The name of the operation resource to be cancelled.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$"
}
},
"scopes": [
@@ -2177,13 +2664,13 @@
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED."
},
"delete": {
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
"parameters": {
"name": {
"location": "path",
@@ -2197,11 +2684,12 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "path": "v1beta2/{+name}",
"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."
},
"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"
},
@@ -2211,9 +2699,9 @@
"httpMethod": "GET",
"parameters": {
"filter": {
- "location": "query",
"description": "The standard list filter.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"name": {
"description": "The name of the operation's parent resource.",
@@ -2223,9 +2711,9 @@
"location": "path"
},
"pageToken": {
+ "location": "query",
"description": "The standard list page token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"description": "The standard list page size.",
@@ -2239,8 +2727,7 @@
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations",
"path": "v1beta2/{+name}",
- "id": "dataproc.projects.regions.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
+ "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.",
@@ -2251,9 +2738,6 @@
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"name": {
"description": "The name of the operation resource.",
@@ -2263,498 +2747,14 @@
"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.get"
}
}
- },
- "jobs": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterName": {
- "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "filter": {
- "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *",
- "type": "string",
- "location": "query"
- },
- "jobStateMatcher": {
- "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": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs",
- "id": "dataproc.projects.regions.jobs.list",
- "description": "Lists regions/{region}/jobs in a project."
- },
- "cancel": {
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}: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": {
- "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": {
- "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"
- ]
- },
- "patch": {
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "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": {
- "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"
- }
- }
- },
- "get": {
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.get",
- "description": "Gets the resource representation for a job in a project.",
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "location": "path",
- "description": "Required. The job ID.",
- "required": true,
- "type": "string"
- }
- }
- },
- "submit": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
- "id": "dataproc.projects.regions.jobs.submit",
- "description": "Submits a job to a cluster.",
- "request": {
- "$ref": "SubmitJobRequest"
- }
- },
- "delete": {
- "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "description": "Required. The job ID.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.delete"
- }
- }
- }
- }
- },
- "locations": {
- "resources": {
- "workflowTemplates": {
- "methods": {
- "instantiate": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
- "path": "v1beta2/{+name}:instantiate",
- "id": "dataproc.projects.locations.workflowTemplates.instantiate",
- "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.",
- "request": {
- "$ref": "InstantiateWorkflowTemplateRequest"
- }
- },
- "get": {
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "version": {
- "description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
- "path": "v1beta2/{+name}",
- "id": "dataproc.projects.locations.workflowTemplates.get",
- "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter."
- },
- "instantiateInline": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The \"resource name\" of the workflow template 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"
- },
- "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",
- "location": "query"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates:instantiateInline",
- "path": "v1beta2/{+parent}/workflowTemplates:instantiateInline",
- "id": "dataproc.projects.locations.workflowTemplates.instantiateInline",
- "description": "Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.",
- "request": {
- "$ref": "WorkflowTemplate"
- }
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
- "id": "dataproc.projects.locations.workflowTemplates.update",
- "path": "v1beta2/{+name}",
- "request": {
- "$ref": "WorkflowTemplate"
- },
- "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version."
- },
- "delete": {
- "description": "Deletes a workflow template. It does not cancel in-progress workflows.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "version": {
- "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
- "location": "path",
- "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
- "path": "v1beta2/{+name}",
- "id": "dataproc.projects.locations.workflowTemplates.delete"
- },
- "list": {
- "description": "Lists workflows that match the specified filter in the request.",
- "response": {
- "$ref": "ListWorkflowTemplatesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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}",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
- "path": "v1beta2/{+parent}/workflowTemplates",
- "id": "dataproc.projects.locations.workflowTemplates.list"
- },
- "create": {
- "description": "Creates new workflow template.",
- "request": {
- "$ref": "WorkflowTemplate"
- },
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "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"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
- "path": "v1beta2/{+parent}/workflowTemplates",
- "id": "dataproc.projects.locations.workflowTemplates.create"
- }
- }
}
}
}
@@ -2762,28 +2762,60 @@
}
},
"parameters": {
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "type": "string"
},
"callback": {
"description": "JSONP",
@@ -2791,6 +2823,11 @@
"location": "query"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -2799,12 +2836,7 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "default": "json"
},
"access_token": {
"description": "OAuth access token.",
@@ -2815,44 +2847,12 @@
"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"
}
},
"version": "v1beta2",
"baseUrl": "https://dataproc.googleapis.com/",
- "servicePath": "",
- "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
"kind": "discovery#restDescription",
+ "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
+ "servicePath": "",
"basePath": ""
}
diff --git a/datastore/v1/datastore-api.json b/datastore/v1/datastore-api.json
index 6b0818f..80461c8 100644
--- a/datastore/v1/datastore-api.json
+++ b/datastore/v1/datastore-api.json
@@ -1,47 +1,14 @@
{
- "rootUrl": "https://datastore.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "datastore",
- "batchPath": "batch",
"revision": "20180117",
"documentationLink": "https://cloud.google.com/datastore/",
"id": "datastore:v1",
"title": "Google Cloud Datastore API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": true,
"resources": {
"projects": {
"methods": {
- "allocateIds": {
- "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
- "request": {
- "$ref": "AllocateIdsRequest"
- },
- "response": {
- "$ref": "AllocateIdsResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}:allocateIds",
- "path": "v1/projects/{projectId}:allocateIds",
- "id": "datastore.projects.allocateIds"
- },
"beginTransaction": {
"httpMethod": "POST",
"parameterOrder": [
@@ -52,10 +19,10 @@
},
"parameters": {
"projectId": {
- "location": "path",
"description": "The ID of the project against which to make the request.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -71,8 +38,6 @@
"description": "Begins a new transaction."
},
"commit": {
- "path": "v1/projects/{projectId}:commit",
- "id": "datastore.projects.commit",
"description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
"request": {
"$ref": "CommitRequest"
@@ -96,9 +61,17 @@
"type": "string"
}
},
- "flatPath": "v1/projects/{projectId}:commit"
+ "flatPath": "v1/projects/{projectId}:commit",
+ "path": "v1/projects/{projectId}:commit",
+ "id": "datastore.projects.commit"
},
"reserveIds": {
+ "path": "v1/projects/{projectId}:reserveIds",
+ "id": "datastore.projects.reserveIds",
+ "request": {
+ "$ref": "ReserveIdsRequest"
+ },
+ "description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud\nDatastore.",
"response": {
"$ref": "ReserveIdsResponse"
},
@@ -118,43 +91,39 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1/projects/{projectId}:reserveIds",
- "path": "v1/projects/{projectId}:reserveIds",
- "id": "datastore.projects.reserveIds",
- "request": {
- "$ref": "ReserveIdsRequest"
- },
- "description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud\nDatastore."
+ "flatPath": "v1/projects/{projectId}:reserveIds"
},
"rollback": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}:rollback",
+ "path": "v1/projects/{projectId}:rollback",
+ "id": "datastore.projects.rollback",
+ "description": "Rolls back a transaction.",
"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"
+ "httpMethod": "POST"
},
"runQuery": {
+ "path": "v1/projects/{projectId}:runQuery",
+ "id": "datastore.projects.runQuery",
"request": {
"$ref": "RunQueryRequest"
},
@@ -178,24 +147,9 @@
"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"
+ "flatPath": "v1/projects/{projectId}:runQuery"
},
"lookup": {
- "path": "v1/projects/{projectId}:lookup",
- "id": "datastore.projects.lookup",
- "request": {
- "$ref": "LookupRequest"
- },
- "description": "Looks up entities by key.",
- "response": {
- "$ref": "LookupResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
"parameters": {
"projectId": {
"description": "The ID of the project against which to make the request.",
@@ -208,66 +162,80 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1/projects/{projectId}:lookup"
+ "flatPath": "v1/projects/{projectId}:lookup",
+ "id": "datastore.projects.lookup",
+ "path": "v1/projects/{projectId}:lookup",
+ "request": {
+ "$ref": "LookupRequest"
+ },
+ "description": "Looks up entities by key.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "LookupResponse"
+ }
+ },
+ "allocateIds": {
+ "response": {
+ "$ref": "AllocateIdsResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}:allocateIds",
+ "path": "v1/projects/{projectId}:allocateIds",
+ "id": "datastore.projects.allocateIds",
+ "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
+ "request": {
+ "$ref": "AllocateIdsRequest"
+ }
}
},
"resources": {
"operations": {
"methods": {
- "cancel": {
- "path": "v1/{+name}:cancel",
- "id": "datastore.projects.operations.cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "response": {
- "$ref": "Empty"
- },
+ "delete": {
+ "id": "datastore.projects.operations.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Empty"
+ },
+ "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.",
+ "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}:cancel"
- },
- "delete": {
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/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/datastore"
- ],
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "datastore.projects.operations.delete"
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}"
},
"list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
@@ -280,17 +248,12 @@
"https://www.googleapis.com/auth/datastore"
],
"parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
"name": {
- "location": "path",
"description": "The name of the operation's parent resource.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$"
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
},
"pageToken": {
"location": "query",
@@ -298,15 +261,21 @@
"type": "string"
},
"pageSize": {
- "location": "query",
"description": "The standard list page size.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
}
},
"flatPath": "v1/projects/{projectsId}/operations",
"path": "v1/{+name}/operations",
- "id": "datastore.projects.operations.list"
+ "id": "datastore.projects.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
},
"get": {
"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.",
@@ -317,10 +286,6 @@
"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.",
@@ -330,9 +295,39 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
"path": "v1/{+name}",
"id": "datastore.projects.operations.get"
+ },
+ "cancel": {
+ "path": "v1/{+name}:cancel",
+ "id": "datastore.projects.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel"
}
}
}
@@ -340,22 +335,35 @@
}
},
"parameters": {
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
- "uploadType": {
- "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"
},
+ "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"
@@ -364,17 +372,9 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -382,11 +382,12 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string"
},
"key": {
@@ -394,10 +395,15 @@
"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"
+ "type": "string",
+ "location": "query"
},
"pp": {
"description": "Pretty-print response.",
@@ -406,328 +412,20 @@
"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"
- },
- "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"
}
},
"schemas": {
- "Value": {
- "properties": {
- "entityValue": {
- "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key.",
- "$ref": "Entity"
- },
- "geoPointValue": {
- "$ref": "LatLng",
- "description": "A geo point value representing a point on the surface of Earth."
- },
- "integerValue": {
- "description": "An integer value.",
- "format": "int64",
- "type": "string"
- },
- "keyValue": {
- "description": "A key value.",
- "$ref": "Key"
- },
- "stringValue": {
- "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.",
- "type": "string"
- },
- "excludeFromIndexes": {
- "description": "If the value should be excluded from all indexes including those defined\nexplicitly.",
- "type": "boolean"
- },
- "doubleValue": {
- "description": "A double value.",
- "format": "double",
- "type": "number"
- },
- "timestampValue": {
- "description": "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.",
- "format": "google-datetime",
- "type": "string"
- },
- "nullValue": {
- "description": "A null value.",
- "type": "string",
- "enumDescriptions": [
- "Null value."
- ],
- "enum": [
- "NULL_VALUE"
- ]
- },
- "booleanValue": {
- "description": "A boolean value.",
- "type": "boolean"
- },
- "blobValue": {
- "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
- "format": "byte",
- "type": "string"
- },
- "meaning": {
- "description": "The `meaning` field should only be populated for backwards compatibility.",
- "format": "int32",
- "type": "integer"
- },
- "arrayValue": {
- "$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`."
- }
- },
- "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.",
- "type": "object",
- "properties": {
- "previousTransaction": {
- "description": "The transaction identifier of the transaction being retried.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "ReadWrite"
- },
- "LookupRequest": {
- "description": "The request for Datastore.Lookup.",
- "type": "object",
- "properties": {
- "readOptions": {
- "description": "The options for this lookup request.",
- "$ref": "ReadOptions"
- },
- "keys": {
- "description": "Keys of entities to look up.",
- "type": "array",
- "items": {
- "$ref": "Key"
- }
- }
- },
- "id": "LookupRequest"
- },
- "ReserveIdsRequest": {
- "description": "The request for Datastore.ReserveIds.",
- "type": "object",
- "properties": {
- "keys": {
- "description": "A list of keys with complete key paths whose numeric IDs should not be\nauto-allocated.",
- "type": "array",
- "items": {
- "$ref": "Key"
- }
- },
- "databaseId": {
- "description": "If not empty, the ID of the database against which to make the request.",
- "type": "string"
- }
- },
- "id": "ReserveIdsRequest"
- },
- "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"
- },
- "PropertyOrder": {
- "description": "The desired order for a specific property.",
- "type": "object",
- "properties": {
- "property": {
- "description": "The property to order by.",
- "$ref": "PropertyReference"
- },
- "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": {
- "description": "The response for Datastore.ReserveIds.",
- "type": "object",
- "properties": {},
- "id": "ReserveIdsResponse"
- },
- "GoogleDatastoreAdminV1beta1EntityFilter": {
- "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
- "type": "object",
- "properties": {
- "kinds": {
- "description": "If empty, then this represents all kinds.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "namespaceIds": {
- "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "GoogleDatastoreAdminV1beta1EntityFilter"
- },
- "PropertyReference": {
- "description": "A reference to a property relative to the kind expressions.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
- "type": "string"
- }
- },
- "id": "PropertyReference"
- },
- "Projection": {
- "description": "A representation of a property in a projection.",
- "type": "object",
- "properties": {
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to project."
- }
- },
- "id": "Projection"
- },
- "Mutation": {
- "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",
- "description": "A mutation to apply to an entity.",
- "type": "object"
- },
- "ReadOptions": {
- "description": "The options shared by read requests.",
- "type": "object",
- "properties": {
- "readConsistency": {
- "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Strong consistency.",
- "Eventual consistency."
- ],
- "enum": [
- "READ_CONSISTENCY_UNSPECIFIED",
- "STRONG",
- "EVENTUAL"
- ]
- },
- "transaction": {
- "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "ReadOptions"
- },
- "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": {
- "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."
- }
- },
- "id": "MutationResult"
- },
"RollbackRequest": {
+ "description": "The request for Datastore.Rollback.",
+ "type": "object",
"properties": {
"transaction": {
"description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
@@ -735,23 +433,19 @@
"type": "string"
}
},
- "id": "RollbackRequest",
- "description": "The request for Datastore.Rollback.",
- "type": "object"
+ "id": "RollbackRequest"
},
"GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
+ "description": "Metadata for ExportEntities operations.",
+ "type": "object",
"properties": {
- "progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
- },
"common": {
- "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.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of bytes processed."
},
"entityFilter": {
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
@@ -760,11 +454,13 @@
"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",
- "description": "Metadata for ExportEntities operations.",
- "type": "object"
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
},
"CompositeFilter": {
"description": "A filter that merges multiple other filters using the given operator.",
@@ -793,6 +489,7 @@
"id": "CompositeFilter"
},
"AllocateIdsResponse": {
+ "id": "AllocateIdsResponse",
"description": "The response for Datastore.AllocateIds.",
"type": "object",
"properties": {
@@ -803,13 +500,16 @@
"$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": {
+ "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.",
@@ -823,25 +523,22 @@
"type": "string"
},
"error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
+ }
}
},
"id": "GoogleLongrunningOperation"
},
"PropertyFilter": {
+ "id": "PropertyFilter",
"description": "A filter on a specific property.",
"type": "object",
"properties": {
@@ -850,8 +547,8 @@
"$ref": "Value"
},
"property": {
- "description": "The property to filter by.",
- "$ref": "PropertyReference"
+ "$ref": "PropertyReference",
+ "description": "The property to filter by."
},
"op": {
"enumDescriptions": [
@@ -875,8 +572,7 @@
"description": "The operator to filter by.",
"type": "string"
}
- },
- "id": "PropertyFilter"
+ }
},
"CommitResponse": {
"description": "The response for Datastore.Commit.",
@@ -913,6 +609,7 @@
"id": "PartitionId"
},
"Entity": {
+ "id": "Entity",
"description": "A Datastore data object.\n\nAn entity is limited to 1 megabyte when stored. That _roughly_\ncorresponds to a limit of 1 megabyte for the serialized form of this\nmessage.",
"type": "object",
"properties": {
@@ -921,36 +618,24 @@
"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": {
+ "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
+ "type": "object",
"additionalProperties": {
"$ref": "Value"
- },
- "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
- "type": "object"
+ }
}
- },
- "id": "Entity"
- },
- "GoogleDatastoreAdminV1beta1Progress": {
- "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",
- "description": "Measures the progress of a particular metric.",
- "type": "object"
+ }
},
"QueryResultBatch": {
+ "id": "QueryResultBatch",
"description": "A batch of results produced by a query.",
"type": "object",
"properties": {
+ "snapshotVersion": {
+ "description": "The version number of the snapshot this batch was returned from.\nThis applies to the range of results from the query's `start_cursor` (or\nthe beginning of the query if no cursor was given) to this batch's\n`end_cursor` (not the query's `end_cursor`).\n\nIn a single transaction, subsequent query result batches for the same query\ncan have a greater snapshot version number. Each batch's snapshot version\nis valid for all preceding batches.\nThe value will be zero for eventually consistent queries.",
+ "format": "int64",
+ "type": "string"
+ },
"skippedCursor": {
"description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.",
"format": "byte",
@@ -962,6 +647,8 @@
"type": "integer"
},
"entityResultType": {
+ "description": "The result type for every entity in `entity_results`.",
+ "type": "string",
"enumDescriptions": [
"Unspecified. This value is never used.",
"The key and properties.",
@@ -973,9 +660,7 @@
"FULL",
"PROJECTION",
"KEY_ONLY"
- ],
- "description": "The result type for every entity in `entity_results`.",
- "type": "string"
+ ]
},
"entityResults": {
"description": "The results for this batch.",
@@ -985,6 +670,8 @@
}
},
"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.",
@@ -998,22 +685,31 @@
"MORE_RESULTS_AFTER_LIMIT",
"MORE_RESULTS_AFTER_CURSOR",
"NO_MORE_RESULTS"
- ],
- "description": "The state of the query after the current batch.",
- "type": "string"
+ ]
},
"endCursor": {
"description": "A cursor that points to the position after the last result in the batch.",
"format": "byte",
"type": "string"
+ }
+ }
+ },
+ "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"
},
- "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.",
+ "workCompleted": {
+ "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.",
"format": "int64",
"type": "string"
}
},
- "id": "QueryResultBatch"
+ "id": "GoogleDatastoreAdminV1beta1Progress"
},
"PathElement": {
"description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
@@ -1055,16 +751,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"
@@ -1082,6 +778,9 @@
"id": "BeginTransactionResponse"
},
"LookupResponse": {
+ "id": "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.",
@@ -1104,22 +803,19 @@
"$ref": "Key"
}
}
- },
- "id": "LookupResponse",
- "description": "The response for Datastore.Lookup.",
- "type": "object"
+ }
},
"RunQueryResponse": {
"description": "The response for Datastore.RunQuery.",
"type": "object",
"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"
- },
- "batch": {
- "$ref": "QueryResultBatch",
- "description": "A batch of query results (always present)."
}
},
"id": "RunQueryResponse"
@@ -1139,17 +835,18 @@
"id": "AllocateIdsRequest"
},
"BeginTransactionRequest": {
+ "description": "The request for Datastore.BeginTransaction.",
+ "type": "object",
"properties": {
"transactionOptions": {
"description": "Options for a new transaction.",
"$ref": "TransactionOptions"
}
},
- "id": "BeginTransactionRequest",
- "description": "The request for Datastore.BeginTransaction.",
- "type": "object"
+ "id": "BeginTransactionRequest"
},
"CommitRequest": {
+ "id": "CommitRequest",
"description": "The request for Datastore.Commit.",
"type": "object",
"properties": {
@@ -1179,21 +876,23 @@
"format": "byte",
"type": "string"
}
- },
- "id": "CommitRequest"
+ }
},
"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": {
+ "id": "LatLng",
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
+ "type": "object",
"properties": {
"latitude": {
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
@@ -1205,30 +904,28 @@
"format": "double",
"type": "number"
}
- },
- "id": "LatLng",
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
- "type": "object"
+ }
},
"Key": {
+ "description": "A unique identifier for an entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
+ "type": "object",
"properties": {
- "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": {
+ "$ref": "PartitionId",
+ "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
}
},
- "id": "Key",
- "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"
+ "id": "Key"
},
"GoogleDatastoreAdminV1beta1CommonMetadata": {
+ "id": "GoogleDatastoreAdminV1beta1CommonMetadata",
"description": "Metadata common to all Datastore Admin operations.",
"type": "object",
"properties": {
@@ -1245,6 +942,8 @@
"type": "string"
},
"operationType": {
+ "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
+ "type": "string",
"enumDescriptions": [
"Unspecified.",
"ExportEntities.",
@@ -1254,11 +953,11 @@
"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.",
@@ -1278,19 +977,19 @@
"SUCCESSFUL",
"FAILED",
"CANCELLED"
- ],
- "description": "The current state of the Operation.",
- "type": "string"
+ ]
},
"startTime": {
"description": "The time that work began on the operation.",
"format": "google-datetime",
"type": "string"
}
- },
- "id": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ }
},
"ArrayValue": {
+ "id": "ArrayValue",
+ "description": "An array value.",
+ "type": "object",
"properties": {
"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.",
@@ -1299,10 +998,7 @@
"$ref": "Value"
}
}
- },
- "id": "ArrayValue",
- "description": "An array value.",
- "type": "object"
+ }
},
"GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
"description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
@@ -1345,21 +1041,28 @@
"id": "GqlQuery"
},
"Filter": {
+ "id": "Filter",
+ "description": "A holder for any type of filter.",
+ "type": "object",
"properties": {
"propertyFilter": {
- "$ref": "PropertyFilter",
- "description": "A filter on a property."
+ "description": "A filter on a property.",
+ "$ref": "PropertyFilter"
},
"compositeFilter": {
"$ref": "CompositeFilter",
"description": "A composite filter."
}
- },
- "id": "Filter",
- "description": "A holder for any type of filter.",
- "type": "object"
+ }
+ },
+ "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": {}
},
"RunQueryRequest": {
+ "id": "RunQueryRequest",
"description": "The request for Datastore.RunQuery.",
"type": "object",
"properties": {
@@ -1368,27 +1071,21 @@
"description": "The options for this query."
},
"query": {
- "$ref": "Query",
- "description": "The query to run."
+ "description": "The query to run.",
+ "$ref": "Query"
},
"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.",
"$ref": "PartitionId"
},
"gqlQuery": {
- "description": "The GQL query to run.",
- "$ref": "GqlQuery"
+ "$ref": "GqlQuery",
+ "description": "The GQL query to run."
}
- },
- "id": "RunQueryRequest"
- },
- "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"
+ }
},
"TransactionOptions": {
+ "id": "TransactionOptions",
"description": "Options for beginning a new transaction.\n\nTransactions can be created explicitly with calls to\nDatastore.BeginTransaction or implicitly by setting\nReadOptions.new_transaction in read requests.",
"type": "object",
"properties": {
@@ -1400,16 +1097,15 @@
"description": "The transaction should only allow reads.",
"$ref": "ReadOnly"
}
- },
- "id": "TransactionOptions"
+ }
},
"GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
"description": "Metadata for ImportEntities operations.",
"type": "object",
"properties": {
"common": {
- "description": "Metadata common to all Datastore Admin operations.",
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
+ "description": "Metadata common to all Datastore Admin operations."
},
"progressBytes": {
"description": "An estimate of the number of bytes processed.",
@@ -1420,34 +1116,30 @@
"type": "string"
},
"entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Description of which entities are being imported."
+ "description": "Description of which entities are being imported.",
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
},
"progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
+ "description": "An estimate of the number of entities processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
}
},
"id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata"
},
"Query": {
+ "id": "Query",
"description": "A query for entities.",
"type": "object",
"properties": {
- "endCursor": {
- "description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
- "format": "byte",
- "type": "string"
- },
- "filter": {
- "$ref": "Filter",
- "description": "The filter to apply."
- },
"limit": {
"description": "The maximum number of results to return. Applies after all other\nconstraints. Optional.\nUnspecified is interpreted as no limit.\nMust be \u003e= 0 if specified.",
"format": "int32",
"type": "integer"
},
+ "filter": {
+ "$ref": "Filter",
+ "description": "The filter to apply."
+ },
"startCursor": {
"description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
"format": "byte",
@@ -1485,43 +1177,346 @@
"items": {
"$ref": "Projection"
}
+ },
+ "endCursor": {
+ "description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
+ "format": "byte",
+ "type": "string"
}
- },
- "id": "Query"
+ }
},
"ReadOnly": {
+ "id": "ReadOnly",
"description": "Options specific to read-only transactions.",
"type": "object",
- "properties": {},
- "id": "ReadOnly"
+ "properties": {}
},
"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.",
- "format": "byte",
- "type": "string"
- },
"version": {
"description": "The version of the entity, a strictly positive number that monotonically\nincreases with changes to the entity.\n\nThis field is set for `FULL` entity\nresults.\n\nFor missing entities in `LookupResponse`, this\nis the version of the snapshot that was used to look up the entity, and it\nis always set except for eventually consistent reads.",
"format": "int64",
"type": "string"
},
"entity": {
- "$ref": "Entity",
- "description": "The resulting entity."
+ "description": "The resulting entity.",
+ "$ref": "Entity"
+ },
+ "cursor": {
+ "description": "A cursor that points to the position after the result entity.\nSet only when the `EntityResult` is part of a `QueryResultBatch` message.",
+ "format": "byte",
+ "type": "string"
}
},
"id": "EntityResult"
+ },
+ "Value": {
+ "id": "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": {
+ "enumDescriptions": [
+ "Null value."
+ ],
+ "enum": [
+ "NULL_VALUE"
+ ],
+ "description": "A null value.",
+ "type": "string"
+ },
+ "blobValue": {
+ "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
+ "format": "byte",
+ "type": "string"
+ },
+ "meaning": {
+ "description": "The `meaning` field should only be populated for backwards compatibility.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "arrayValue": {
+ "$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": {
+ "$ref": "Entity",
+ "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key."
+ },
+ "geoPointValue": {
+ "description": "A geo point value representing a point on the surface of Earth.",
+ "$ref": "LatLng"
+ },
+ "keyValue": {
+ "description": "A key value.",
+ "$ref": "Key"
+ },
+ "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"
+ }
+ }
+ },
+ "ReadWrite": {
+ "description": "Options specific to read / write transactions.",
+ "type": "object",
+ "properties": {
+ "previousTransaction": {
+ "description": "The transaction identifier of the transaction being retried.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "ReadWrite"
+ },
+ "LookupRequest": {
+ "description": "The request for Datastore.Lookup.",
+ "type": "object",
+ "properties": {
+ "readOptions": {
+ "$ref": "ReadOptions",
+ "description": "The options for this lookup request."
+ },
+ "keys": {
+ "description": "Keys of entities to look up.",
+ "type": "array",
+ "items": {
+ "$ref": "Key"
+ }
+ }
+ },
+ "id": "LookupRequest"
+ },
+ "ReserveIdsRequest": {
+ "id": "ReserveIdsRequest",
+ "description": "The request for Datastore.ReserveIds.",
+ "type": "object",
+ "properties": {
+ "keys": {
+ "description": "A list of keys with complete key paths whose numeric IDs should not be\nauto-allocated.",
+ "type": "array",
+ "items": {
+ "$ref": "Key"
+ }
+ },
+ "databaseId": {
+ "description": "If not empty, the ID of the database against which to make the request.",
+ "type": "string"
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "PropertyOrder": {
+ "id": "PropertyOrder",
+ "description": "The desired order for a specific property.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "PropertyReference",
+ "description": "The property to order by."
+ },
+ "direction": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Ascending.",
+ "Descending."
+ ],
+ "enum": [
+ "DIRECTION_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "description": "The direction to order by. Defaults to `ASCENDING`.",
+ "type": "string"
+ }
+ }
+ },
+ "ReserveIdsResponse": {
+ "description": "The response for Datastore.ReserveIds.",
+ "type": "object",
+ "properties": {},
+ "id": "ReserveIdsResponse"
+ },
+ "GoogleDatastoreAdminV1beta1EntityFilter": {
+ "id": "GoogleDatastoreAdminV1beta1EntityFilter",
+ "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ }
+ }
+ },
+ "PropertyReference": {
+ "id": "PropertyReference",
+ "description": "A reference to a property relative to the kind expressions.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
+ "type": "string"
+ }
+ }
+ },
+ "Projection": {
+ "id": "Projection",
+ "description": "A representation of a property in a projection.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "description": "The property to project.",
+ "$ref": "PropertyReference"
+ }
+ }
+ },
+ "Mutation": {
+ "description": "A mutation to apply to an entity.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "$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."
+ }
+ },
+ "id": "Mutation"
+ },
+ "ReadOptions": {
+ "id": "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"
+ }
+ }
+ },
+ "RollbackResponse": {
+ "id": "RollbackResponse",
+ "description": "The response for Datastore.Rollback.\n(an empty message).",
+ "type": "object",
+ "properties": {}
+ },
+ "MutationResult": {
+ "id": "MutationResult",
+ "description": "The result of applying a mutation.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "$ref": "Key",
+ "description": "The automatically allocated key.\nSet only when the mutation allocated a key."
+ },
+ "version": {
+ "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
+ "format": "int64",
+ "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"
+ }
+ }
}
},
- "protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"version": "v1",
"baseUrl": "https://datastore.googleapis.com/",
"auth": {
@@ -1538,5 +1533,10 @@
},
"kind": "discovery#restDescription",
"description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
- "servicePath": ""
+ "servicePath": "",
+ "rootUrl": "https://datastore.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "datastore",
+ "batchPath": "batch"
}
diff --git a/datastore/v1beta1/datastore-api.json b/datastore/v1beta1/datastore-api.json
index 2d9e0aa..7b07b46 100644
--- a/datastore/v1beta1/datastore-api.json
+++ b/datastore/v1beta1/datastore-api.json
@@ -1,23 +1,4 @@
{
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "protocol": "rest",
- "version": "v1beta1",
- "baseUrl": "https://datastore.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/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": "",
@@ -26,9 +7,9 @@
"ownerDomain": "google.com",
"name": "datastore",
"batchPath": "batch",
- "id": "datastore:v1beta1",
- "documentationLink": "https://cloud.google.com/datastore/",
"revision": "20180117",
+ "documentationLink": "https://cloud.google.com/datastore/",
+ "id": "datastore:v1beta1",
"title": "Google Cloud Datastore API",
"ownerName": "Google",
"discoveryVersion": "v1",
@@ -37,9 +18,6 @@
"projects": {
"methods": {
"export": {
- "flatPath": "v1beta1/projects/{projectId}: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"
@@ -57,45 +35,64 @@
],
"parameters": {
"projectId": {
+ "description": "Project ID against which to make the request.",
"required": true,
"type": "string",
- "location": "path",
- "description": "Project ID against which to make the request."
+ "location": "path"
}
- }
+ },
+ "flatPath": "v1beta1/projects/{projectId}:export",
+ "path": "v1beta1/projects/{projectId}:export",
+ "id": "datastore.projects.export"
},
"import": {
- "response": {
- "$ref": "GoogleLongrunningOperation"
+ "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.",
+ "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"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID against which to make the request."
- }
- },
"flatPath": "v1beta1/projects/{projectId}:import",
- "path": "v1beta1/projects/{projectId}:import",
"id": "datastore.projects.import",
- "description": "Imports entities into Google Cloud Datastore. Existing entities with the\nsame key are overwritten. The import occurs in the background and its\nprogress can be monitored and managed via the Operation resource that is\ncreated. If an ImportEntities operation is cancelled, it is possible\nthat a subset of the data has already been imported to Cloud Datastore.",
- "request": {
- "$ref": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest"
- }
+ "path": "v1beta1/projects/{projectId}:import"
}
}
}
},
"parameters": {
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -108,17 +105,16 @@
"default": "true"
},
"fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
+ "location": "query"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -128,65 +124,142 @@
"1",
"2"
],
- "description": "V1 error format."
+ "description": "V1 error format.",
+ "type": "string"
},
"callback": {
+ "description": "JSONP",
"type": "string",
- "location": "query",
- "description": "JSONP"
+ "location": "query"
},
"alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
- ]
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
},
"access_token": {
- "type": "string",
"location": "query",
- "description": "OAuth access token."
+ "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",
- "description": "API key. 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"
},
"quotaUser": {
- "type": "string",
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
+ "description": "Available to use 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": {
- "GoogleLongrunningOperation": {
+ "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": {
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
+ "description": "Description of which entities are being imported."
+ },
+ "progressEntities": {
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of entities processed."
+ },
+ "common": {
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
+ "description": "Metadata common to all Datastore Admin operations."
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata"
+ },
+ "GoogleDatastoreAdminV1beta1ImportEntitiesRequest": {
+ "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Client-assigned labels.",
+ "type": "object"
+ },
+ "inputUrl": {
+ "description": "The full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So input_url should be of the form:\n`gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where\n`BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is\nan optional Cloud Storage namespace path (this is not a Cloud Datastore\nnamespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written\nby the ExportEntities operation. For more information about Cloud Storage\nnamespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nFor more information, see\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
+ "type": "string"
+ },
+ "entityFilter": {
+ "description": "Optionally specify which kinds/namespaces are to be imported. If provided,\nthe list must be a subset of the EntityFilter used in creating the export,\notherwise a FAILED_PRECONDITION error will be returned. If no filter is\nspecified then all entities from the export are imported.",
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest"
+ },
+ "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": {
+ "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.",
@@ -204,51 +277,26 @@
"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": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any."
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- }
- },
- "id": "GoogleLongrunningOperation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
- },
- "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"
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
}
- },
- "namespaceIds": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "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."
}
},
- "id": "GoogleDatastoreAdminV1beta1EntityFilter"
+ "id": "GoogleLongrunningOperation"
},
"GoogleDatastoreAdminV1beta1CommonMetadata": {
+ "description": "Metadata common to all Datastore Admin operations.",
"type": "object",
"properties": {
"labels": {
+ "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
"type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels."
+ }
},
"endTime": {
"description": "The time the operation ended, either successfully or otherwise.",
@@ -256,30 +304,20 @@
"type": "string"
},
"operationType": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "ExportEntities.",
+ "ImportEntities."
+ ],
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"EXPORT_ENTITIES",
"IMPORT_ENTITIES"
],
"description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "ExportEntities.",
- "ImportEntities."
- ]
+ "type": "string"
},
"state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "INITIALIZING",
- "PROCESSING",
- "CANCELLING",
- "FINALIZING",
- "SUCCESSFUL",
- "FAILED",
- "CANCELLED"
- ],
"description": "The current state of the Operation.",
"type": "string",
"enumDescriptions": [
@@ -291,31 +329,40 @@
"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"
]
},
"startTime": {
- "type": "string",
"description": "The time that work began on the operation.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
+ "id": "GoogleDatastoreAdminV1beta1CommonMetadata"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
"details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"additionalProperties": {
- "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"
- },
- "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.",
@@ -323,12 +370,34 @@
"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"
},
+ "GoogleDatastoreAdminV1beta1ExportEntitiesRequest": {
+ "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
+ "type": "object",
+ "properties": {
+ "entityFilter": {
+ "description": "Description of what data from the project is included in the export.",
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
+ },
+ "outputUrlPrefix": {
+ "description": "Location for the export metadata and data files.\n\nThe full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So output_url_prefix should be of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the\nname of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud\nStorage namespace path (this is not a Cloud Datastore namespace). For more\ninformation about Cloud Storage namespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nThe resulting files will be nested deeper than the specified URL prefix.\nThe final output URL will be provided in the\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield. That value should be used for subsequent ImportEntities operations.\n\nBy nesting the data files deeper, the same Cloud Storage bucket can be used\nin multiple ExportEntities operations without conflict.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Client-assigned labels.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest"
+ },
"GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
"description": "Metadata for ExportEntities operations.",
"type": "object",
@@ -346,8 +415,8 @@
"description": "Description of which entities are being exported."
},
"outputUrlPrefix": {
- "type": "string",
- "description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url."
+ "description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
+ "type": "string"
},
"progressEntities": {
"$ref": "GoogleDatastoreAdminV1beta1Progress",
@@ -356,29 +425,8 @@
},
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
},
- "GoogleDatastoreAdminV1beta1ExportEntitiesRequest": {
- "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
- "type": "object",
- "properties": {
- "entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Description of what data from the project is included in the export."
- },
- "outputUrlPrefix": {
- "type": "string",
- "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."
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Client-assigned labels.",
- "type": "object"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest"
- },
"GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
+ "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
"type": "object",
"properties": {
"outputUrl": {
@@ -386,74 +434,26 @@
"type": "string"
}
},
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse",
- "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities."
- },
- "GoogleDatastoreAdminV1beta1ImportEntitiesRequest": {
- "type": "object",
- "properties": {
- "inputUrl": {
- "type": "string",
- "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."
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse"
+ }
+ },
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
+ "protocol": "rest",
+ "version": "v1beta1",
+ "baseUrl": "https://datastore.googleapis.com/",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/datastore": {
+ "description": "View and manage your Google Cloud Datastore data"
},
- "entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Optionally specify which kinds/namespaces are to be imported. If provided,\nthe list must be a subset of the EntityFilter used in creating the export,\notherwise a FAILED_PRECONDITION error will be returned. If no filter is\nspecified then all entities from the export are imported."
- },
- "labels": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Client-assigned labels."
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
- },
- "id": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest",
- "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities."
- },
- "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
- "type": "object",
- "properties": {
- "common": {
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
- },
- "progressBytes": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of bytes processed."
- },
- "inputUrl": {
- "type": "string",
- "description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield."
- },
- "entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Description of which entities are being imported."
- },
- "progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata",
- "description": "Metadata for ImportEntities operations."
- },
- "GoogleDatastoreAdminV1beta1Progress": {
- "description": "Measures the progress of a particular metric.",
- "type": "object",
- "properties": {
- "workEstimated": {
- "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.",
- "format": "int64",
- "type": "string"
- },
- "workCompleted": {
- "type": "string",
- "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.",
- "format": "int64"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1Progress"
+ }
}
}
}
diff --git a/datastore/v1beta3/datastore-api.json b/datastore/v1beta3/datastore-api.json
index 1811da7..47766f5 100644
--- a/datastore/v1beta3/datastore-api.json
+++ b/datastore/v1beta3/datastore-api.json
@@ -1,185 +1,10 @@
{
- "ownerDomain": "google.com",
- "name": "datastore",
- "batchPath": "batch",
- "revision": "20180117",
- "documentationLink": "https://cloud.google.com/datastore/",
- "id": "datastore:v1beta3",
- "title": "Google Cloud Datastore API",
"discoveryVersion": "v1",
"ownerName": "Google",
"version_module": true,
"resources": {
"projects": {
"methods": {
- "commit": {
- "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
- "request": {
- "$ref": "CommitRequest"
- },
- "response": {
- "$ref": "CommitResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta3/projects/{projectId}:commit",
- "path": "v1beta3/projects/{projectId}:commit",
- "id": "datastore.projects.commit"
- },
- "beginTransaction": {
- "path": "v1beta3/projects/{projectId}:beginTransaction",
- "id": "datastore.projects.beginTransaction",
- "request": {
- "$ref": "BeginTransactionRequest"
- },
- "description": "Begins a new transaction.",
- "response": {
- "$ref": "BeginTransactionResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta3/projects/{projectId}:beginTransaction"
- },
- "reserveIds": {
- "request": {
- "$ref": "ReserveIdsRequest"
- },
- "description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud\nDatastore.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "ReserveIdsResponse"
- },
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta3/projects/{projectId}:reserveIds",
- "id": "datastore.projects.reserveIds",
- "path": "v1beta3/projects/{projectId}:reserveIds"
- },
- "runQuery": {
- "request": {
- "$ref": "RunQueryRequest"
- },
- "description": "Queries for entities.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "RunQueryResponse"
- },
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta3/projects/{projectId}:runQuery",
- "id": "datastore.projects.runQuery",
- "path": "v1beta3/projects/{projectId}:runQuery"
- },
- "rollback": {
- "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",
- "request": {
- "$ref": "RollbackRequest"
- },
- "description": "Rolls back a transaction."
- },
- "lookup": {
- "flatPath": "v1beta3/projects/{projectId}:lookup",
- "id": "datastore.projects.lookup",
- "path": "v1beta3/projects/{projectId}: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"
- ]
- },
"allocateIds": {
"description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
"request": {
@@ -207,18 +32,251 @@
"flatPath": "v1beta3/projects/{projectId}:allocateIds",
"path": "v1beta3/projects/{projectId}:allocateIds",
"id": "datastore.projects.allocateIds"
+ },
+ "beginTransaction": {
+ "flatPath": "v1beta3/projects/{projectId}:beginTransaction",
+ "path": "v1beta3/projects/{projectId}:beginTransaction",
+ "id": "datastore.projects.beginTransaction",
+ "description": "Begins a new transaction.",
+ "request": {
+ "$ref": "BeginTransactionRequest"
+ },
+ "response": {
+ "$ref": "BeginTransactionResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
+ },
+ "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": "v1beta3/projects/{projectId}:commit",
+ "path": "v1beta3/projects/{projectId}:commit",
+ "id": "datastore.projects.commit"
+ },
+ "reserveIds": {
+ "response": {
+ "$ref": "ReserveIdsResponse"
+ },
+ "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}:reserveIds",
+ "path": "v1beta3/projects/{projectId}:reserveIds",
+ "id": "datastore.projects.reserveIds",
+ "description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud\nDatastore.",
+ "request": {
+ "$ref": "ReserveIdsRequest"
+ }
+ },
+ "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": "v1beta3/projects/{projectId}:runQuery",
+ "path": "v1beta3/projects/{projectId}:runQuery",
+ "id": "datastore.projects.runQuery",
+ "request": {
+ "$ref": "RunQueryRequest"
+ },
+ "description": "Queries for entities."
+ },
+ "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": {
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta3/projects/{projectId}:rollback",
+ "path": "v1beta3/projects/{projectId}:rollback",
+ "id": "datastore.projects.rollback"
+ },
+ "lookup": {
+ "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": "v1beta3/projects/{projectId}:lookup",
+ "path": "v1beta3/projects/{projectId}:lookup",
+ "id": "datastore.projects.lookup",
+ "description": "Looks up entities by key.",
+ "request": {
+ "$ref": "LookupRequest"
+ }
}
}
}
},
"parameters": {
- "oauth_token": {
+ "fields": {
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
"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"
},
@@ -232,74 +290,281 @@
"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": {
- "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": {
- "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": {
+ "ReserveIdsResponse": {
+ "description": "The response for Datastore.ReserveIds.",
+ "type": "object",
+ "properties": {},
+ "id": "ReserveIdsResponse"
+ },
+ "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"
+ },
+ "GoogleDatastoreAdminV1beta1CommonMetadata": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "type": "object",
+ "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": {
+ "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "ExportEntities.",
+ "ImportEntities."
+ ],
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "EXPORT_ENTITIES",
+ "IMPORT_ENTITIES"
+ ]
+ },
+ "state": {
+ "description": "The current state of the Operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Request is being prepared for processing.",
+ "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"
+ ]
+ },
+ "startTime": {
+ "description": "The time that work began on the operation.",
+ "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": {
+ "description": "An array value.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "Values in the array.\nThe order of this array may not be preserved if it contains a mix of\nindexed and unindexed values.",
+ "type": "array",
+ "items": {
+ "$ref": "Value"
+ }
+ }
+ },
+ "id": "ArrayValue"
+ },
+ "Mutation": {
+ "description": "A mutation to apply to an entity.",
+ "type": "object",
+ "properties": {
+ "delete": {
+ "$ref": "Key",
+ "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only."
+ },
+ "insert": {
+ "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete.",
+ "$ref": "Entity"
+ },
+ "baseVersion": {
+ "description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.",
+ "format": "int64",
+ "type": "string"
+ },
+ "update": {
+ "$ref": "Entity",
+ "description": "The entity to update. The entity must already exist.\nMust have a complete key path."
+ },
+ "upsert": {
+ "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete.",
+ "$ref": "Entity"
+ }
+ },
+ "id": "Mutation"
+ },
+ "ReadOptions": {
+ "description": "The options shared by read requests.",
+ "type": "object",
+ "properties": {
+ "readConsistency": {
+ "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Strong consistency.",
+ "Eventual consistency."
+ ],
+ "enum": [
+ "READ_CONSISTENCY_UNSPECIFIED",
+ "STRONG",
+ "EVENTUAL"
+ ]
+ },
+ "transaction": {
+ "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "ReadOptions"
+ },
+ "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"
+ },
+ "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"
+ },
+ "GqlQuery": {
+ "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "object",
+ "properties": {
+ "queryString": {
+ "description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "string"
+ },
+ "allowLiterals": {
+ "description": "When false, the query string must not contain any literals and instead must\nbind all values. For example,\n`SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while\n`SELECT * FROM Kind WHERE a = @value` is.",
+ "type": "boolean"
+ },
+ "namedBindings": {
+ "additionalProperties": {
+ "$ref": "GqlQueryParameter"
+ },
+ "description": "For each non-reserved named binding site in the query string, there must be\na named parameter with that name, but not necessarily the inverse.\n\nKey must match regex `A-Za-z_$*`, must not match regex\n`__.*__`, and must not be `\"\"`.",
+ "type": "object"
+ },
+ "positionalBindings": {
+ "description": "Numbered binding site @1 references the first numbered parameter,\neffectively using 1-based indexing, rather than the usual 0.\n\nFor each binding site numbered i in `query_string`, there must be an i-th\nnumbered parameter. The inverse must also be true.",
+ "type": "array",
+ "items": {
+ "$ref": "GqlQueryParameter"
+ }
+ }
+ },
+ "id": "GqlQuery"
+ },
+ "Filter": {
+ "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"
+ }
+ },
+ "id": "Filter"
+ },
+ "RollbackRequest": {
+ "description": "The request for Datastore.Rollback.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "RollbackRequest"
+ },
"RunQueryRequest": {
"description": "The request for Datastore.RunQuery.",
"type": "object",
@@ -313,74 +578,69 @@
"description": "The query to run."
},
"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.",
- "$ref": "PartitionId"
+ "$ref": "PartitionId",
+ "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID."
},
"gqlQuery": {
- "$ref": "GqlQuery",
- "description": "The GQL query to run."
+ "description": "The GQL query to run.",
+ "$ref": "GqlQuery"
}
},
"id": "RunQueryRequest"
},
- "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": {
"description": "Metadata for ExportEntities operations.",
"type": "object",
"properties": {
- "progressEntities": {
- "description": "An estimate of the number of entities processed.",
+ "progressBytes": {
+ "description": "An estimate of the number of bytes processed.",
"$ref": "GoogleDatastoreAdminV1beta1Progress"
},
- "common": {
- "description": "Metadata common to all Datastore Admin operations.",
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
- },
- "progressBytes": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of bytes processed."
- },
"entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Description of which entities are being exported."
+ "description": "Description of which entities are being exported.",
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
},
"outputUrlPrefix": {
"description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
"type": "string"
+ },
+ "progressEntities": {
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of entities processed."
+ },
+ "common": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
}
},
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
},
"TransactionOptions": {
+ "description": "Options for beginning a new transaction.\n\nTransactions can be created explicitly with calls to\nDatastore.BeginTransaction or implicitly by setting\nReadOptions.new_transaction in read requests.",
+ "type": "object",
"properties": {
"readWrite": {
- "description": "The transaction should allow both reads and writes.",
- "$ref": "ReadWrite"
+ "$ref": "ReadWrite",
+ "description": "The transaction should allow both reads and writes."
},
"readOnly": {
"description": "The transaction should only allow reads.",
"$ref": "ReadOnly"
}
},
- "id": "TransactionOptions",
- "description": "Options for beginning a new transaction.\n\nTransactions can be created explicitly with calls to\nDatastore.BeginTransaction or implicitly by setting\nReadOptions.new_transaction in read requests.",
- "type": "object"
+ "id": "TransactionOptions"
},
"CompositeFilter": {
"description": "A filter that merges multiple other filters using the given operator.",
"type": "object",
"properties": {
+ "filters": {
+ "description": "The list of filters to combine.\nMust contain at least one filter.",
+ "type": "array",
+ "items": {
+ "$ref": "Filter"
+ }
+ },
"op": {
"enumDescriptions": [
"Unspecified. This value must not be used.",
@@ -392,13 +652,6 @@
],
"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"
@@ -407,13 +660,9 @@
"description": "Metadata for ImportEntities operations.",
"type": "object",
"properties": {
- "common": {
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
- },
"progressBytes": {
- "description": "An estimate of the number of bytes processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of bytes processed."
},
"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.",
@@ -424,8 +673,12 @@
"description": "Description of which entities are being imported."
},
"progressEntities": {
- "description": "An estimate of the number of entities processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of entities processed."
+ },
+ "common": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
}
},
"id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata"
@@ -448,27 +701,6 @@
"description": "A query for entities.",
"type": "object",
"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",
@@ -490,15 +722,36 @@
"description": "The filter to apply.",
"$ref": "Filter"
},
+ "startCursor": {
+ "description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
+ "format": "byte",
+ "type": "string"
+ },
"offset": {
"description": "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be \u003e= 0 if specified.",
"format": "int32",
"type": "integer"
},
- "startCursor": {
- "description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
- "format": "byte",
- "type": "string"
+ "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"
@@ -510,12 +763,20 @@
"id": "ReadOnly"
},
"PropertyFilter": {
+ "description": "A filter on a specific property.",
+ "type": "object",
"properties": {
+ "value": {
+ "$ref": "Value",
+ "description": "The value to compare the property to."
+ },
"property": {
"description": "The property to filter by.",
"$ref": "PropertyReference"
},
"op": {
+ "description": "The operator to filter by.",
+ "type": "string",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Less than.",
@@ -533,18 +794,10 @@
"GREATER_THAN_OR_EQUAL",
"EQUAL",
"HAS_ANCESTOR"
- ],
- "description": "The operator to filter by.",
- "type": "string"
- },
- "value": {
- "description": "The value to compare the property to.",
- "$ref": "Value"
+ ]
}
},
- "id": "PropertyFilter",
- "description": "A filter on a specific property.",
- "type": "object"
+ "id": "PropertyFilter"
},
"EntityResult": {
"description": "The result of fetching an entity from Datastore.",
@@ -568,38 +821,9 @@
"id": "EntityResult"
},
"Value": {
+ "description": "A message that can hold any of the supported value types and associated\nmetadata.",
+ "type": "object",
"properties": {
- "blobValue": {
- "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
- "format": "byte",
- "type": "string"
- },
- "meaning": {
- "description": "The `meaning` field should only be populated for backwards compatibility.",
- "format": "int32",
- "type": "integer"
- },
- "arrayValue": {
- "$ref": "ArrayValue",
- "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`."
- },
- "entityValue": {
- "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key.",
- "$ref": "Entity"
- },
- "geoPointValue": {
- "$ref": "LatLng",
- "description": "A geo point value representing a point on the surface of Earth."
- },
- "keyValue": {
- "$ref": "Key",
- "description": "A key value."
- },
- "integerValue": {
- "description": "An integer value.",
- "format": "int64",
- "type": "string"
- },
"stringValue": {
"description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.",
"type": "string"
@@ -618,43 +842,72 @@
"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"
- ]
- }
- },
- "id": "Value",
- "description": "A message that can hold any of the supported value types and associated\nmetadata.",
- "type": "object"
- },
- "CommitResponse": {
- "properties": {
- "indexUpdates": {
- "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
+ ],
+ "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."
+ },
+ "keyValue": {
+ "description": "A key value.",
+ "$ref": "Key"
+ },
+ "integerValue": {
+ "description": "An integer value.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "Value"
+ },
+ "CommitResponse": {
+ "description": "The response for Datastore.Commit.",
+ "type": "object",
+ "properties": {
"mutationResults": {
"description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.",
"type": "array",
"items": {
"$ref": "MutationResult"
}
+ },
+ "indexUpdates": {
+ "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "CommitResponse",
- "description": "The response for Datastore.Commit.",
- "type": "object"
+ "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.",
@@ -701,34 +954,28 @@
},
"id": "ReadWrite"
},
- "GoogleDatastoreAdminV1beta1Progress": {
- "description": "Measures the progress of a particular metric.",
+ "LookupRequest": {
+ "description": "The request for Datastore.Lookup.",
"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"
+ "readOptions": {
+ "description": "The options for this lookup request.",
+ "$ref": "ReadOptions"
},
- "workCompleted": {
- "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.",
- "format": "int64",
- "type": "string"
+ "keys": {
+ "description": "Keys of entities to look up.",
+ "type": "array",
+ "items": {
+ "$ref": "Key"
+ }
}
},
- "id": "GoogleDatastoreAdminV1beta1Progress"
+ "id": "LookupRequest"
},
"QueryResultBatch": {
"description": "A batch of results produced by a query.",
"type": "object",
"properties": {
- "entityResults": {
- "description": "The results for this batch.",
- "type": "array",
- "items": {
- "$ref": "EntityResult"
- }
- },
"moreResults": {
"enumDescriptions": [
"Unspecified. This value is never used.",
@@ -782,27 +1029,33 @@
],
"description": "The result type for every entity in `entity_results`.",
"type": "string"
+ },
+ "entityResults": {
+ "description": "The results for this batch.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityResult"
+ }
}
},
"id": "QueryResultBatch"
},
- "LookupRequest": {
- "description": "The request for Datastore.Lookup.",
+ "GoogleDatastoreAdminV1beta1Progress": {
+ "description": "Measures the progress of a particular metric.",
"type": "object",
"properties": {
- "readOptions": {
- "description": "The options for this lookup request.",
- "$ref": "ReadOptions"
+ "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"
},
- "keys": {
- "description": "Keys of entities to look up.",
- "type": "array",
- "items": {
- "$ref": "Key"
- }
+ "workCompleted": {
+ "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.",
+ "format": "int64",
+ "type": "string"
}
},
- "id": "LookupRequest"
+ "id": "GoogleDatastoreAdminV1beta1Progress"
},
"ReserveIdsRequest": {
"description": "The request for Datastore.ReserveIds.",
@@ -826,10 +1079,6 @@
"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"
@@ -838,11 +1087,17 @@
"description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
"format": "int64",
"type": "string"
+ },
+ "name": {
+ "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
}
},
"id": "PathElement"
},
"GqlQueryParameter": {
+ "description": "A binding parameter for a GQL query.",
+ "type": "object",
"properties": {
"cursor": {
"description": "A query cursor. Query cursors are returned in query\nresult batches.",
@@ -854,9 +1109,7 @@
"description": "A value parameter."
}
},
- "id": "GqlQueryParameter",
- "description": "A binding parameter for a GQL query.",
- "type": "object"
+ "id": "GqlQueryParameter"
},
"BeginTransactionResponse": {
"description": "The response for Datastore.BeginTransaction.",
@@ -870,6 +1123,49 @@
},
"id": "BeginTransactionResponse"
},
+ "RunQueryResponse": {
+ "description": "The response for Datastore.RunQuery.",
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "The parsed form of the `GqlQuery` from the request, if it was set.",
+ "$ref": "Query"
+ },
+ "batch": {
+ "description": "A batch of query results (always present).",
+ "$ref": "QueryResultBatch"
+ }
+ },
+ "id": "RunQueryResponse"
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityResult"
+ }
+ },
+ "missing": {
+ "description": "Entities not found as `ResultType.KEY_ONLY` entities. The order of results\nin this field is undefined and has no relation to the order of the keys\nin the input.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityResult"
+ }
+ },
+ "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"
+ },
"AllocateIdsRequest": {
"description": "The request for Datastore.AllocateIds.",
"type": "object",
@@ -884,83 +1180,46 @@
},
"id": "AllocateIdsRequest"
},
- "LookupResponse": {
- "description": "The response for Datastore.Lookup.",
+ "PropertyOrder": {
+ "description": "The desired order for a specific property.",
"type": "object",
"properties": {
- "deferred": {
- "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.",
- "type": "array",
- "items": {
- "$ref": "Key"
- }
- },
- "found": {
- "description": "Entities found as `ResultType.FULL` entities. The order of results in this\nfield is undefined and has no relation to the order of the keys in the\ninput.",
- "type": "array",
- "items": {
- "$ref": "EntityResult"
- }
- },
- "missing": {
- "description": "Entities not found as `ResultType.KEY_ONLY` entities. The order of results\nin this field is undefined and has no relation to the order of the keys\nin the input.",
- "type": "array",
- "items": {
- "$ref": "EntityResult"
- }
- }
- },
- "id": "LookupResponse"
- },
- "RunQueryResponse": {
- "properties": {
- "query": {
- "$ref": "Query",
- "description": "The parsed form of the `GqlQuery` from the request, if it was set."
- },
- "batch": {
- "description": "A batch of query results (always present).",
- "$ref": "QueryResultBatch"
- }
- },
- "id": "RunQueryResponse",
- "description": "The response for Datastore.RunQuery.",
- "type": "object"
- },
- "PropertyOrder": {
- "properties": {
"property": {
- "$ref": "PropertyReference",
- "description": "The property to order by."
+ "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",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Ascending.",
- "Descending."
- ]
+ "type": "string"
}
},
- "id": "PropertyOrder",
- "description": "The desired order for a specific property.",
- "type": "object"
+ "id": "PropertyOrder"
+ },
+ "BeginTransactionRequest": {
+ "description": "The request for Datastore.BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "transactionOptions": {
+ "description": "Options for a new transaction.",
+ "$ref": "TransactionOptions"
+ }
+ },
+ "id": "BeginTransactionRequest"
},
"CommitRequest": {
+ "description": "The request for Datastore.Commit.",
+ "type": "object",
"properties": {
- "mutations": {
- "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.",
- "type": "array",
- "items": {
- "$ref": "Mutation"
- }
- },
"transaction": {
"description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
"format": "byte",
@@ -979,22 +1238,16 @@
],
"description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
"type": "string"
+ },
+ "mutations": {
+ "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.",
+ "type": "array",
+ "items": {
+ "$ref": "Mutation"
+ }
}
},
- "id": "CommitRequest",
- "description": "The request for Datastore.Commit.",
- "type": "object"
- },
- "BeginTransactionRequest": {
- "properties": {
- "transactionOptions": {
- "$ref": "TransactionOptions",
- "description": "Options for a new transaction."
- }
- },
- "id": "BeginTransactionRequest",
- "description": "The request for Datastore.BeginTransaction.",
- "type": "object"
+ "id": "CommitRequest"
},
"KindExpression": {
"description": "A representation of a kind.",
@@ -1007,24 +1260,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.",
- "type": "array",
- "items": {
- "$ref": "PathElement"
- }
- },
- "partitionId": {
- "$ref": "PartitionId",
- "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
- }
- },
- "id": "Key"
- },
"LatLng": {
"description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
"type": "object",
@@ -1042,270 +1277,28 @@
},
"id": "LatLng"
},
- "ReserveIdsResponse": {
- "description": "The response for Datastore.ReserveIds.",
+ "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": {},
- "id": "ReserveIdsResponse"
- },
- "PropertyReference": {
"properties": {
- "name": {
- "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
- "type": "string"
- }
- },
- "id": "PropertyReference",
- "description": "A reference to a property relative to the kind expressions.",
- "type": "object"
- },
- "GoogleDatastoreAdminV1beta1EntityFilter": {
- "properties": {
- "kinds": {
- "description": "If empty, then this represents all kinds.",
+ "partitionId": {
+ "$ref": "PartitionId",
+ "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
+ },
+ "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": {
- "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"
+ "$ref": "PathElement"
}
}
},
- "id": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
- "type": "object"
- },
- "GoogleDatastoreAdminV1beta1CommonMetadata": {
- "properties": {
- "labels": {
- "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "endTime": {
- "description": "The time the operation ended, either successfully or otherwise.",
- "format": "google-datetime",
- "type": "string"
- },
- "operationType": {
- "enumDescriptions": [
- "Unspecified.",
- "ExportEntities.",
- "ImportEntities."
- ],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "EXPORT_ENTITIES",
- "IMPORT_ENTITIES"
- ],
- "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
- "type": "string"
- },
- "state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "INITIALIZING",
- "PROCESSING",
- "CANCELLING",
- "FINALIZING",
- "SUCCESSFUL",
- "FAILED",
- "CANCELLED"
- ],
- "description": "The current state of the Operation.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Request is being prepared for processing.",
- "Request is actively being processed.",
- "Request is in the process of being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation on the operation.",
- "Request has been processed and is in its finalization stage.",
- "Request has completed successfully.",
- "Request has finished being processed, but encountered an error.",
- "Request has finished being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation."
- ]
- },
- "startTime": {
- "description": "The time that work began on the operation.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations.",
- "type": "object"
- },
- "Projection": {
- "description": "A representation of a property in a projection.",
- "type": "object",
- "properties": {
- "property": {
- "description": "The property to project.",
- "$ref": "PropertyReference"
- }
- },
- "id": "Projection"
- },
- "ArrayValue": {
- "description": "An array value.",
- "type": "object",
- "properties": {
- "values": {
- "description": "Values in the array.\nThe order of this array may not be preserved if it contains a mix of\nindexed and unindexed values.",
- "type": "array",
- "items": {
- "$ref": "Value"
- }
- }
- },
- "id": "ArrayValue"
- },
- "Mutation": {
- "description": "A mutation to apply to an entity.",
- "type": "object",
- "properties": {
- "delete": {
- "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only.",
- "$ref": "Key"
- },
- "insert": {
- "$ref": "Entity",
- "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete."
- },
- "baseVersion": {
- "description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.",
- "format": "int64",
- "type": "string"
- },
- "update": {
- "description": "The entity to update. The entity must already exist.\nMust have a complete key path.",
- "$ref": "Entity"
- },
- "upsert": {
- "$ref": "Entity",
- "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete."
- }
- },
- "id": "Mutation"
- },
- "ReadOptions": {
- "description": "The options shared by read requests.",
- "type": "object",
- "properties": {
- "readConsistency": {
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Strong consistency.",
- "Eventual consistency."
- ],
- "enum": [
- "READ_CONSISTENCY_UNSPECIFIED",
- "STRONG",
- "EVENTUAL"
- ],
- "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
- "type": "string"
- },
- "transaction": {
- "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "ReadOptions"
- },
- "RollbackResponse": {
- "properties": {},
- "id": "RollbackResponse",
- "description": "The response for Datastore.Rollback.\n(an empty message).",
- "type": "object"
- },
- "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
- "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
- "type": "object",
- "properties": {
- "outputUrl": {
- "description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.",
- "type": "string"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse"
- },
- "MutationResult": {
- "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."
- }
- },
- "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).",
- "type": "string"
- },
- "allowLiterals": {
- "description": "When false, the query string must not contain any literals and instead must\nbind all values. For example,\n`SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while\n`SELECT * FROM Kind WHERE a = @value` is.",
- "type": "boolean"
- },
- "namedBindings": {
- "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"
- }
- },
- "positionalBindings": {
- "description": "Numbered binding site @1 references the first numbered parameter,\neffectively using 1-based indexing, rather than the usual 0.\n\nFor each binding site numbered i in `query_string`, there must be an i-th\nnumbered parameter. The inverse must also be true.",
- "type": "array",
- "items": {
- "$ref": "GqlQueryParameter"
- }
- }
- },
- "id": "GqlQuery"
- },
- "Filter": {
- "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"
- }
- },
- "id": "Filter"
+ "id": "Key"
}
},
"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": "v1beta3",
@@ -1322,9 +1315,16 @@
}
}
},
+ "kind": "discovery#restDescription",
"description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
"servicePath": "",
- "kind": "discovery#restDescription",
"rootUrl": "https://datastore.googleapis.com/",
- "basePath": ""
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "datastore",
+ "batchPath": "batch",
+ "revision": "20180117",
+ "id": "datastore:v1beta3",
+ "documentationLink": "https://cloud.google.com/datastore/",
+ "title": "Google Cloud Datastore API"
}
diff --git a/dialogflow/v2beta1/dialogflow-api.json b/dialogflow/v2beta1/dialogflow-api.json
index 295b56b..e3da06d 100644
--- a/dialogflow/v2beta1/dialogflow-api.json
+++ b/dialogflow/v2beta1/dialogflow-api.json
@@ -1,15 +1,13 @@
{
- "rootUrl": "https://dialogflow.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "dialogflow",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Dialogflow API",
"ownerName": "Google",
"resources": {
"projects": {
"methods": {
"getAgent": {
+ "flatPath": "v2beta1/projects/{projectsId}/agent",
+ "path": "v2beta1/{+parent}/agent",
+ "id": "dialogflow.projects.getAgent",
+ "description": "Retrieves the specified agent.",
"response": {
"$ref": "Agent"
},
@@ -28,49 +26,13 @@
"type": "string",
"pattern": "^projects/[^/]+$"
}
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent",
- "path": "v2beta1/{+parent}/agent",
- "id": "dialogflow.projects.getAgent",
- "description": "Retrieves the specified agent."
+ }
}
},
"resources": {
- "operations": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/operations/{operationsId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- }
- }
- },
"agent": {
"methods": {
"search": {
- "flatPath": "v2beta1/projects/{projectsId}/agent:search",
- "path": "v2beta1/{+parent}/agent:search",
- "id": "dialogflow.projects.agent.search",
"description": "Returns the list of agents.\n\nSince there is at most one conversational agent per project, this method is\nuseful primarily for listing all agents across projects the caller has\naccess to. One can achieve that with a wildcard project collection id \"-\".\nRefer to [List\nSub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).",
"response": {
"$ref": "SearchAgentsResponse"
@@ -79,6 +41,9 @@
"parent"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"pageToken": {
"location": "query",
@@ -92,18 +57,22 @@
"location": "query"
},
"parent": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
"description": "Required. The project to list agents from.\nFormat: `projects/\u003cProject ID or '-'\u003e`.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ "flatPath": "v2beta1/projects/{projectsId}/agent:search",
+ "path": "v2beta1/{+parent}/agent:search",
+ "id": "dialogflow.projects.agent.search"
},
"train": {
+ "description": "Trains the specified agent.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
+ "request": {
+ "$ref": "TrainAgentRequest"
+ },
"response": {
"$ref": "Operation"
},
@@ -111,6 +80,9 @@
"parent"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"parent": {
"description": "Required. The project that the agent to train is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
@@ -120,50 +92,15 @@
"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",
- "request": {
- "$ref": "TrainAgentRequest"
- },
- "description": "Trains the specified agent.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e"
+ "id": "dialogflow.projects.agent.train"
},
"export": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The project that the agent to export is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "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": {
- "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"
},
@@ -171,40 +108,40 @@
"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`.",
+ "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:restore",
- "path": "v2beta1/{+parent}/agent:restore",
- "id": "dialogflow.projects.agent.restore"
+ "flatPath": "v2beta1/projects/{projectsId}/agent:export",
+ "path": "v2beta1/{+parent}/agent:export",
+ "id": "dialogflow.projects.agent.export"
},
- "import": {
- "flatPath": "v2beta1/projects/{projectsId}/agent:import",
- "path": "v2beta1/{+parent}/agent:import",
- "id": "dialogflow.projects.agent.import",
+ "restore": {
+ "flatPath": "v2beta1/projects/{projectsId}/agent:restore",
+ "id": "dialogflow.projects.agent.restore",
+ "path": "v2beta1/{+parent}/agent:restore",
"request": {
- "$ref": "ImportAgentRequest"
+ "$ref": "RestoreAgentRequest"
},
- "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"
- },
+ "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",
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"parent": {
- "description": "Required. The project that the agent to import is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
+ "description": "Required. The project that the agent to restore is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
@@ -214,48 +151,197 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
+ },
+ "import": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The project that the agent to import is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent:import",
+ "path": "v2beta1/{+parent}/agent:import",
+ "id": "dialogflow.projects.agent.import",
+ "description": "Imports the specified agent from a ZIP file.\n\nUploads new intents and entity types without deleting the existing ones.\nIntents and entity types with the same name are replaced with the new\nversions from ImportAgentRequest.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
+ "request": {
+ "$ref": "ImportAgentRequest"
+ }
}
},
"resources": {
"entityTypes": {
"methods": {
- "get": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the entity type to delete.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntityType ID\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.entityTypes.delete",
+ "description": "Deletes the specified entity type."
+ },
+ "list": {
"httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListEntityTypesResponse"
+ },
+ "parameters": {
+ "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": {
+ "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",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Optional. The next_page_token value returned from a previous list request.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes",
+ "id": "dialogflow.projects.agent.entityTypes.list",
+ "path": "v2beta1/{+parent}/entityTypes",
+ "description": "Returns the list of all entity types in the specified agent."
+ },
+ "create": {
+ "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",
+ "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": {
+ "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"
+ ]
+ },
+ "batchDelete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The name of the agent to delete all entities types for. Format:\n`projects/\u003cProject ID\u003e/agent`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent$"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchDelete",
+ "path": "v2beta1/{+parent}/entityTypes:batchDelete",
+ "id": "dialogflow.projects.agent.entityTypes.batchDelete",
+ "description": "Deletes entity types in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
+ "request": {
+ "$ref": "BatchDeleteEntityTypesRequest"
+ }
+ },
+ "get": {
+ "description": "Retrieves the specified entity type.",
"response": {
"$ref": "EntityType"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
"parameters": {
+ "name": {
+ "description": "Required. The name of the entity type.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntityType ID\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
+ "location": "path"
+ },
"languageCode": {
"location": "query",
"description": "Optional. The language to retrieve entity synonyms for. If not specified,\nthe agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
"type": "string"
- },
- "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/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
- "id": "dialogflow.projects.agent.entityTypes.get",
"path": "v2beta1/{+name}",
- "description": "Retrieves the specified entity type."
+ "id": "dialogflow.projects.agent.entityTypes.get"
},
"patch": {
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.entityTypes.patch",
- "request": {
- "$ref": "EntityType"
- },
- "description": "Updates the specified entity type.",
"response": {
"$ref": "EntityType"
},
@@ -270,29 +356,31 @@
"location": "query"
},
"updateMask": {
+ "location": "query",
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"name": {
- "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
- "location": "path",
"description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of the entity type. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}"
+ "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": {
- "request": {
- "$ref": "BatchUpdateEntityTypesRequest"
- },
- "description": "Updates/Creates multiple entity types in the specified agent.\n\nOperation \u003cresponse: BatchUpdateEntityTypesResponse,\n metadata: google.protobuf.Struct\u003e",
"httpMethod": "POST",
"parameterOrder": [
"parent"
@@ -314,144 +402,17 @@
],
"flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchUpdate",
"id": "dialogflow.projects.agent.entityTypes.batchUpdate",
- "path": "v2beta1/{+parent}/entityTypes:batchUpdate"
- },
- "delete": {
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.entityTypes.delete",
- "description": "Deletes the specified entity type.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the entity type to delete.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntityType ID\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
- "location": "path"
- }
- }
- },
- "list": {
- "description": "Returns the list of all entity types in the specified agent.",
- "response": {
- "$ref": "ListEntityTypesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "languageCode": {
- "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",
- "location": "query"
- },
- "pageToken": {
- "description": "Optional. The next_page_token value returned from a previous list request.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "location": "path",
- "description": "Required. The agent to list all entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/agent$"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes",
- "path": "v2beta1/{+parent}/entityTypes",
- "id": "dialogflow.projects.agent.entityTypes.list"
- },
- "batchDelete": {
- "description": "Deletes entity types in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
+ "path": "v2beta1/{+parent}/entityTypes:batchUpdate",
"request": {
- "$ref": "BatchDeleteEntityTypesRequest"
+ "$ref": "BatchUpdateEntityTypesRequest"
},
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The name of the agent to 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"
- },
- "create": {
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes",
- "id": "dialogflow.projects.agent.entityTypes.create",
- "path": "v2beta1/{+parent}/entityTypes",
- "request": {
- "$ref": "EntityType"
- },
- "description": "Creates an entity type in the specified agent.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "EntityType"
- },
- "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"
- ]
+ "description": "Updates/Creates multiple entity types in the specified agent.\n\nOperation \u003cresponse: BatchUpdateEntityTypesResponse,\n metadata: google.protobuf.Struct\u003e"
}
},
"resources": {
"entities": {
"methods": {
"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"
},
@@ -464,22 +425,28 @@
],
"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"
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchCreate",
"path": "v2beta1/{+parent}/entities:batchCreate",
- "id": "dialogflow.projects.agent.entityTypes.entities.batchCreate"
+ "id": "dialogflow.projects.agent.entityTypes.entities.batchCreate",
+ "description": "Creates multiple new entities in the specified entity type (extends the\nexisting collection of entries).\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
+ "request": {
+ "$ref": "BatchCreateEntitiesRequest"
+ }
},
"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"
},
- "description": "Updates entities in the specified entity type (replaces the existing\ncollection of entries).\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
"response": {
"$ref": "Operation"
},
@@ -487,25 +454,21 @@
"parent"
],
"httpMethod": "POST",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
- "location": "path",
- "description": "Required. The name of the entity type to update the entities in. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
- "required": true,
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate",
- "path": "v2beta1/{+parent}/entities:batchUpdate",
- "id": "dialogflow.projects.agent.entityTypes.entities.batchUpdate"
+ "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"
},
"batchDelete": {
- "path": "v2beta1/{+parent}/entities:batchDelete",
- "id": "dialogflow.projects.agent.entityTypes.entities.batchDelete",
"request": {
"$ref": "BatchDeleteEntitiesRequest"
},
@@ -519,17 +482,19 @@
"httpMethod": "POST",
"parameters": {
"parent": {
- "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",
- "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$"
+ "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete"
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete",
+ "path": "v2beta1/{+parent}/entities:batchDelete",
+ "id": "dialogflow.projects.agent.entityTypes.entities.batchDelete"
}
}
}
@@ -538,31 +503,35 @@
"intents": {
"methods": {
"delete": {
+ "id": "dialogflow.projects.agent.intents.delete",
+ "path": "v2beta1/{+name}",
+ "description": "Deletes the specified intent.",
+ "httpMethod": "DELETE",
"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",
- "pattern": "^projects/[^/]+/agent/intents/[^/]+$"
+ "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.delete",
- "description": "Deletes the specified intent."
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}"
},
"list": {
+ "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.",
"response": {
"$ref": "ListIntentsResponse"
},
@@ -570,9 +539,6 @@
"parent"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"pageSize": {
"location": "query",
@@ -597,70 +563,32 @@
"location": "path"
},
"languageCode": {
- "location": "query",
"description": "Optional. The language to list training phrases, parameters and rich\nmessages for. If not specified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent before they can be used.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. The next_page_token value returned from a previous list request.",
- "type": "string"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent/intents",
- "path": "v2beta1/{+parent}/intents",
- "id": "dialogflow.projects.agent.intents.list",
- "description": "Returns the list of all intents in the specified agent."
- },
- "batchDelete": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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",
- "id": "dialogflow.projects.agent.intents.batchDelete",
- "path": "v2beta1/{+parent}/intents:batchDelete",
- "request": {
- "$ref": "BatchDeleteIntentsRequest"
- },
- "description": "Deletes intents in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e"
- },
- "create": {
- "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": {
- "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"
},
+ "pageToken": {
+ "description": "Optional. The next_page_token value returned from a previous list request.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "create": {
+ "response": {
+ "$ref": "Intent"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
"intentView": {
"location": "query",
"enum": [
@@ -676,11 +604,48 @@
"type": "string",
"pattern": "^projects/[^/]+/agent$",
"location": "path"
+ },
+ "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"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/intents",
"path": "v2beta1/{+parent}/intents",
- "id": "dialogflow.projects.agent.intents.create"
+ "id": "dialogflow.projects.agent.intents.create",
+ "description": "Creates an intent in the specified agent.",
+ "request": {
+ "$ref": "Intent"
+ }
+ },
+ "batchDelete": {
+ "request": {
+ "$ref": "BatchDeleteIntentsRequest"
+ },
+ "description": "Deletes intents in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the agent to delete all entities types for. Format:\n`projects/\u003cProject ID\u003e/agent`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchDelete",
+ "id": "dialogflow.projects.agent.intents.batchDelete",
+ "path": "v2beta1/{+parent}/intents:batchDelete"
},
"get": {
"response": {
@@ -694,26 +659,26 @@
"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": {
"location": "path",
"description": "Required. The name of the intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/agent/intents/[^/]+$"
- },
- "intentView": {
- "location": "query",
- "enum": [
- "INTENT_VIEW_UNSPECIFIED",
- "INTENT_VIEW_FULL"
- ],
- "description": "Optional. The resource view to apply to the returned intent.",
- "type": "string"
- },
- "languageCode": {
- "location": "query",
- "description": "Optional. The language to retrieve training phrases, parameters and rich\nmessages for. If not specified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
- "type": "string"
}
},
"flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
@@ -722,9 +687,6 @@
"description": "Retrieves the specified intent."
},
"patch": {
- "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
- "id": "dialogflow.projects.agent.intents.patch",
- "path": "v2beta1/{+name}",
"request": {
"$ref": "Intent"
},
@@ -737,6 +699,13 @@
"$ref": "Intent"
},
"parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/agent/intents/[^/]+$",
+ "location": "path",
+ "description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of this intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
+ "required": true,
+ "type": "string"
+ },
"intentView": {
"location": "query",
"enum": [
@@ -756,20 +725,23 @@
"format": "google-fieldmask",
"type": "string",
"location": "query"
- },
- "name": {
- "description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of this intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/agent/intents/[^/]+$",
- "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
+ "id": "dialogflow.projects.agent.intents.patch",
+ "path": "v2beta1/{+name}"
},
"batchUpdate": {
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchUpdate",
+ "path": "v2beta1/{+parent}/intents:batchUpdate",
+ "id": "dialogflow.projects.agent.intents.batchUpdate",
+ "request": {
+ "$ref": "BatchUpdateIntentsRequest"
+ },
+ "description": "Updates/Creates multiple intents in the specified agent.\n\nOperation \u003cresponse: BatchUpdateIntentsResponse\u003e",
"response": {
"$ref": "Operation"
},
@@ -777,61 +749,27 @@
"parent"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"parent": {
+ "pattern": "^projects/[^/]+/agent$",
+ "location": "path",
"description": "Required. The name of the agent to update or create intents in.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/agent$",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchUpdate",
- "path": "v2beta1/{+parent}/intents:batchUpdate",
- "id": "dialogflow.projects.agent.intents.batchUpdate",
- "description": "Updates/Creates multiple intents in the specified agent.\n\nOperation \u003cresponse: BatchUpdateIntentsResponse\u003e",
- "request": {
- "$ref": "BatchUpdateIntentsRequest"
- }
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
},
"sessions": {
"resources": {
- "contexts": {
+ "entityTypes": {
"methods": {
- "create": {
- "description": "Creates a context.",
- "request": {
- "$ref": "Context"
- },
- "response": {
- "$ref": "Context"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "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"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
- "path": "v2beta1/{+parent}/contexts",
- "id": "dialogflow.projects.agent.sessions.contexts.create"
- },
"delete": {
+ "description": "Deletes the specified session entity type.",
"response": {
"$ref": "Empty"
},
@@ -839,27 +777,28 @@
"name"
],
"httpMethod": "DELETE",
+ "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"
],
- "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}",
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.sessions.contexts.delete",
- "description": "Deletes the specified context."
+ "id": "dialogflow.projects.agent.sessions.entityTypes.delete"
},
"list": {
- "description": "Returns the list of all contexts in the specified session.",
+ "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": "ListContextsResponse"
+ "$ref": "ListSessionEntityTypesResponse"
},
"parameterOrder": [
"parent"
@@ -870,60 +809,60 @@
],
"parameters": {
"parent": {
- "description": "Required. The session to list all contexts from.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
+ "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/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+$"
},
"pageToken": {
- "location": "query",
"description": "Optional. The next_page_token value returned from a previous list request.",
- "type": "string"
+ "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"
+ "type": "integer",
+ "location": "query"
}
},
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
- "path": "v2beta1/{+parent}/contexts",
- "id": "dialogflow.projects.agent.sessions.contexts.list"
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes"
},
"get": {
"response": {
- "$ref": "Context"
+ "$ref": "SessionEntityType"
},
"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}",
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
"path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.sessions.contexts.get",
- "description": "Retrieves the specified context."
+ "id": "dialogflow.projects.agent.sessions.entityTypes.get",
+ "description": "Retrieves the specified session entity type."
},
"patch": {
- "description": "Updates the specified context.",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.sessions.entityTypes.patch",
+ "description": "Updates the specified session entity type.",
"request": {
- "$ref": "Context"
+ "$ref": "SessionEntityType"
},
"response": {
- "$ref": "Context"
+ "$ref": "SessionEntityType"
},
"parameterOrder": [
"name"
@@ -940,25 +879,16 @@
"location": "query"
},
"name": {
- "location": "path",
- "description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.\nNote: The Context ID is always converted to lowercase.",
+ "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/[^/]+/contexts/[^/]+$"
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.sessions.contexts.patch"
- }
- }
- },
- "entityTypes": {
- "methods": {
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}"
+ },
"create": {
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes",
- "path": "v2beta1/{+parent}/entityTypes",
- "id": "dialogflow.projects.agent.sessions.entityTypes.create",
"description": "Creates a session entity type.",
"request": {
"$ref": "SessionEntityType"
@@ -981,47 +911,54 @@
"pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
"location": "path"
}
- }
- },
- "delete": {
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.sessions.entityTypes.delete",
- "description": "Deletes the specified session entity type.",
- "response": {
- "$ref": "Empty"
},
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes",
+ "path": "v2beta1/{+parent}/entityTypes",
+ "id": "dialogflow.projects.agent.sessions.entityTypes.create"
+ }
+ }
+ },
+ "contexts": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
+ "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`.",
+ "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/[^/]+/entityTypes/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
+ "id": "dialogflow.projects.agent.sessions.contexts.delete",
+ "path": "v2beta1/{+name}",
+ "description": "Deletes the specified context."
},
"list": {
- "description": "Returns the list of all session entity types in the specified session.",
- "httpMethod": "GET",
+ "description": "Returns the list of all contexts in the specified session.",
+ "response": {
+ "$ref": "ListContextsResponse"
+ },
"parameterOrder": [
"parent"
],
- "response": {
- "$ref": "ListSessionEntityTypesResponse"
- },
+ "httpMethod": "GET",
"parameters": {
"pageToken": {
+ "location": "query",
"description": "Optional. The next_page_token value returned from a previous list request.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -1030,7 +967,7 @@
"type": "integer"
},
"parent": {
- "description": "Required. The session to list all session entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
+ "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/[^/]+$",
@@ -1040,68 +977,96 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes",
- "id": "dialogflow.projects.agent.sessions.entityTypes.list",
- "path": "v2beta1/{+parent}/entityTypes"
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
+ "path": "v2beta1/{+parent}/contexts",
+ "id": "dialogflow.projects.agent.sessions.contexts.list"
},
"get": {
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.sessions.entityTypes.get",
- "description": "Retrieves the specified session entity type.",
"response": {
- "$ref": "SessionEntityType"
+ "$ref": "Context"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
+ "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"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "name": {
- "location": "path",
- "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/[^/]+$"
- }
- }
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.sessions.contexts.get",
+ "description": "Retrieves the specified context."
},
"patch": {
- "response": {
- "$ref": "SessionEntityType"
- },
+ "httpMethod": "PATCH",
"parameterOrder": [
"name"
],
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Context"
+ },
"parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
+ "location": "path",
+ "description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.\nNote: The Context ID is always converted to lowercase.",
+ "required": true,
+ "type": "string"
+ },
"updateMask": {
"location": "query",
"description": "Optional. The mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
- },
- "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}",
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
+ "id": "dialogflow.projects.agent.sessions.contexts.patch",
"path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.sessions.entityTypes.patch",
"request": {
- "$ref": "SessionEntityType"
+ "$ref": "Context"
},
- "description": "Updates the specified session entity type."
+ "description": "Updates the specified context."
+ },
+ "create": {
+ "response": {
+ "$ref": "Context"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "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"
+ }
}
}
}
@@ -1117,11 +1082,11 @@
},
"parameters": {
"session": {
- "location": "path",
"description": "Required. The name of the session this query is sent to. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.\nIt's up to the API caller to choose an appropriate session ID. It can be\na random number or some type of user identifier (preferably hashed).\nThe length of the session ID must not exceed 36 bytes.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/agent/sessions/[^/]+$"
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -1136,33 +1101,62 @@
"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."
},
"deleteContexts": {
+ "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.",
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "DELETE",
"parameterOrder": [
"parent"
],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "Empty"
+ },
"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",
- "pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
- "path": "v2beta1/{+parent}/contexts",
- "id": "dialogflow.projects.agent.sessions.deleteContexts"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
}
}
+ },
+ "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": "^projects/[^/]+/operations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/operations/{operationsId}",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ }
+ }
}
}
}
@@ -1174,20 +1168,20 @@
"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",
- "location": "query"
+ "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"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"location": "query",
@@ -1195,35 +1189,41 @@
"type": "boolean",
"default": "true"
},
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "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": {
+ "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": [
@@ -1231,12 +1231,11 @@
"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": {
@@ -1244,22 +1243,17 @@
"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"
+ "type": "string",
+ "location": "query"
}
},
"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": "",
+ "description": "An end-to-end development suite for conversational interfaces (e.g., chatbots, voice-powered apps and devices).",
+ "kind": "discovery#restDescription",
"basePath": "",
"id": "dialogflow:v2beta1",
"documentationLink": "https://cloud.google.com/dialogflow-enterprise/",
@@ -1267,25 +1261,887 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "IntentMessageBasicCardButton": {
+ "WebhookRequest": {
+ "description": "The request message for a webhook call.",
+ "type": "object",
"properties": {
- "title": {
- "description": "Required. The title of the button.",
+ "responseId": {
+ "description": "The unique identifier of the response. Contains the same value as\n`[Streaming]DetectIntentResponse.response_id`.",
"type": "string"
},
+ "session": {
+ "description": "The unique identifier of detectIntent request session.\nCan be used to identify end-user inside webhook implementation.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
+ "type": "string"
+ },
+ "queryResult": {
+ "$ref": "QueryResult",
+ "description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`."
+ },
+ "originalDetectIntentRequest": {
+ "description": "Optional. The contents of the original request that was passed to\n`[Streaming]DetectIntent` call.",
+ "$ref": "OriginalDetectIntentRequest"
+ }
+ },
+ "id": "WebhookRequest"
+ },
+ "IntentTrainingPhrase": {
+ "description": "Represents an example or template that the agent is trained on.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "name": {
+ "description": "Required. The unique identifier of this training phrase.",
+ "type": "string"
+ }
+ },
+ "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": {
+ "description": "Warning: Restoring agents from a URI is not implemented yet.\nThis feature is coming soon.\n\nThe URI to a Google Cloud Storage file containing the agent to restore.\nNote: The URI must start with \"gs://\".",
+ "type": "string"
+ }
+ },
+ "id": "RestoreAgentRequest"
+ },
+ "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": {
+ "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"
+ },
+ "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": {
+ "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",
+ "description": "The request message for Agents.ImportAgent.",
+ "type": "object"
+ },
+ "BatchUpdateIntentsResponse": {
+ "description": "The response message for Intents.BatchUpdateIntents.",
+ "type": "object",
+ "properties": {
+ "intents": {
+ "description": "The collection of updated or created intents.",
+ "type": "array",
+ "items": {
+ "$ref": "Intent"
+ }
+ }
+ },
+ "id": "BatchUpdateIntentsResponse"
+ },
+ "IntentParameter": {
+ "description": "Represents intent parameters.",
+ "type": "object",
+ "properties": {
+ "prompts": {
+ "description": "Optional. The collection of prompts that the agent can present to the\nuser in order to collect value for the parameter.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "defaultValue": {
+ "description": "Optional. The default value to use when the `value` yields an empty\nresult.\nDefault values can be extracted from contexts by using the following\nsyntax: `#context_name.parameter_name`.",
+ "type": "string"
+ },
+ "mandatory": {
+ "description": "Optional. Indicates whether the parameter is required. That is,\nwhether the intent cannot be completed without collecting the parameter\nvalue.",
+ "type": "boolean"
+ },
+ "isList": {
+ "description": "Optional. Indicates whether the parameter represents a list of values.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "The unique identifier of this parameter.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Optional. The definition of the parameter value. It can be:\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Required. The name of the parameter.",
+ "type": "string"
+ },
+ "entityTypeDisplayName": {
+ "description": "Optional. The name of the entity type, prefixed with `@`, that\ndescribes values of the parameter. If the parameter is\nrequired, this must be provided.",
+ "type": "string"
+ }
+ },
+ "id": "IntentParameter"
+ },
+ "ExportAgentResponse": {
+ "description": "The response message for Agents.ExportAgent.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "properties": {
+ "imageUri": {
+ "description": "Optional. The public URI to an image file.",
+ "type": "string"
+ },
+ "accessibilityText": {
+ "description": "Optional. A text description of the image to be used for accessibility,\ne.g., screen readers.",
+ "type": "string"
+ }
+ },
+ "id": "IntentMessageImage",
+ "description": "The image response message.",
+ "type": "object"
+ },
+ "BatchUpdateIntentsRequest": {
+ "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",
+ "description": "The request message for Intents.BatchUpdateIntents.",
+ "type": "object"
+ },
+ "TrainAgentRequest": {
+ "properties": {},
+ "id": "TrainAgentRequest",
+ "description": "The request message for Agents.TrainAgent.",
+ "type": "object"
+ },
+ "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": {
+ "enumDescriptions": [
+ "Not specified. This value should be never used.",
+ "The collection of session entities overrides the collection of entities\nin the corresponding developer entity type.",
+ "The collection of session entities extends the collection of entities in\nthe corresponding developer entity type.\nCalls to `ListSessionEntityTypes`, `GetSessionEntityType`,\n`CreateSessionEntityType` and `UpdateSessionEntityType` return the full\ncollection of entities from the developer entity type in the agent's\ndefault language and the session entity type."
+ ],
+ "enum": [
+ "ENTITY_OVERRIDE_MODE_UNSPECIFIED",
+ "ENTITY_OVERRIDE_MODE_OVERRIDE",
+ "ENTITY_OVERRIDE_MODE_SUPPLEMENT"
+ ],
+ "description": "Required. Indicates whether the additional data should override or\nsupplement the developer entity type definition.",
+ "type": "string"
+ },
+ "entities": {
+ "description": "Required. The collection of entities associated with this session entity\ntype.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityTypeEntity"
+ }
+ }
+ },
+ "id": "SessionEntityType"
+ },
+ "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"
+ },
+ "BatchUpdateEntitiesRequest": {
+ "properties": {
+ "languageCode": {
+ "description": "Optional. The language of entity synonyms defined in `entities`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Optional. The mask to control which fields get updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "entities": {
+ "description": "Required. The collection of new entities to replace the existing entities.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityTypeEntity"
+ }
+ }
+ },
+ "id": "BatchUpdateEntitiesRequest",
+ "description": "The response message for EntityTypes.BatchCreateEntities.",
+ "type": "object"
+ },
+ "IntentMessageText": {
+ "description": "The text response message.",
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "Optional. The collection of the agent's responses.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "IntentMessageText"
+ },
+ "WebhookResponse": {
+ "description": "The response message for a webhook call.",
+ "type": "object",
+ "properties": {
+ "fulfillmentMessages": {
+ "description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.",
+ "type": "array",
+ "items": {
+ "$ref": "IntentMessage"
+ }
+ },
+ "payload": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Optional. This value is passed directly to `QueryResult.webhook_payload`.",
+ "type": "object"
+ },
+ "source": {
+ "description": "Optional. This value is passed directly to `QueryResult.webhook_source`.",
+ "type": "string"
+ },
+ "followupEventInput": {
+ "description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input.",
+ "$ref": "EventInput"
+ },
+ "outputContexts": {
+ "description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.",
+ "type": "array",
+ "items": {
+ "$ref": "Context"
+ }
+ },
+ "fulfillmentText": {
+ "description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.",
+ "type": "string"
+ }
+ },
+ "id": "WebhookResponse"
+ },
+ "BatchDeleteIntentsRequest": {
+ "properties": {
+ "intents": {
+ "description": "Required. The collection of intents to delete. Only intent `name` must be\nfilled in.",
+ "type": "array",
+ "items": {
+ "$ref": "Intent"
+ }
+ }
+ },
+ "id": "BatchDeleteIntentsRequest",
+ "description": "The request message for Intents.BatchDeleteIntents.",
+ "type": "object"
+ },
+ "QueryInput": {
+ "properties": {
+ "event": {
+ "description": "The event to be processed.",
+ "$ref": "EventInput"
+ },
+ "text": {
+ "description": "The natural language text to be processed.",
+ "$ref": "TextInput"
+ },
+ "audioConfig": {
+ "description": "Instructs the speech recognizer how to process the speech audio.",
+ "$ref": "InputAudioConfig"
+ }
+ },
+ "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": {
+ "uri": {
+ "description": "Required. The URI of the app or site to open when the user taps the\nsuggestion chip.",
+ "type": "string"
+ },
+ "destinationName": {
+ "description": "Required. The name of the app or site this chip is linking to.",
+ "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": {
+ "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": {
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ }
+ },
+ "id": "Operation"
+ },
+ "IntentMessageSuggestions": {
+ "properties": {
+ "suggestions": {
+ "description": "Required. The list of suggested replies.",
+ "type": "array",
+ "items": {
+ "$ref": "IntentMessageSuggestion"
+ }
+ }
+ },
+ "id": "IntentMessageSuggestions",
+ "description": "The collection of suggestions.",
+ "type": "object"
+ },
+ "EventInput": {
+ "description": "Events allow for matching intents by event name instead of the natural\nlanguage input. For instance, input `\u003cevent: { name: “welcome_event”,\nparameters: { name: “Sam” } }\u003e` can trigger a personalized welcome response.\nThe parameter `name` may be used by the agent in the response:\n`“Hello #welcome_event.name! What can I do for you today?”`.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "EventInput"
+ },
+ "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": {
+ "description": "Required. Indicates the kind of entity type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. This value should be never used.",
+ "Map entity types allow mapping of a group of synonyms to a canonical\nvalue.",
+ "List entity types contain a set of entries that do not map to canonical\nvalues. However, list entity types can contain references to other entity\ntypes (with or without aliases)."
+ ],
+ "enum": [
+ "KIND_UNSPECIFIED",
+ "KIND_MAP",
+ "KIND_LIST"
+ ]
+ },
+ "autoExpansionMode": {
+ "enumDescriptions": [
+ "Auto expansion disabled for the entity.",
+ "Allows an agent to recognize values that have not been explicitly\nlisted in the entity."
+ ],
+ "enum": [
+ "AUTO_EXPANSION_MODE_UNSPECIFIED",
+ "AUTO_EXPANSION_MODE_DEFAULT"
+ ],
+ "description": "Optional. Indicates whether the entity type can be automatically\nexpanded.",
+ "type": "string"
+ },
+ "entities": {
+ "description": "Optional. The collection of entities associated with the entity type.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityTypeEntity"
+ }
+ }
+ },
+ "id": "EntityType"
+ },
+ "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"
+ },
+ "IntentMessage": {
+ "properties": {
+ "quickReplies": {
+ "description": "The quick replies response.",
+ "$ref": "IntentMessageQuickReplies"
+ },
+ "card": {
+ "description": "The card response.",
+ "$ref": "IntentMessageCard"
+ },
+ "basicCard": {
+ "$ref": "IntentMessageBasicCard",
+ "description": "The basic card response for Actions on Google."
+ },
+ "carouselSelect": {
+ "description": "The carousel card response for Actions on Google.",
+ "$ref": "IntentMessageCarouselSelect"
+ },
+ "linkOutSuggestion": {
+ "$ref": "IntentMessageLinkOutSuggestion",
+ "description": "The link out suggestion chip for Actions on Google."
+ },
+ "simpleResponses": {
+ "$ref": "IntentMessageSimpleResponses",
+ "description": "The voice and text-only responses for Actions on Google."
+ },
+ "image": {
+ "$ref": "IntentMessageImage",
+ "description": "The image response."
+ },
+ "payload": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The response containing a custom payload.",
+ "type": "object"
+ },
+ "text": {
+ "$ref": "IntentMessageText",
+ "description": "The text response."
+ },
+ "platform": {
+ "enum": [
+ "PLATFORM_UNSPECIFIED",
+ "FACEBOOK",
+ "SLACK",
+ "TELEGRAM",
+ "KIK",
+ "SKYPE",
+ "LINE",
+ "VIBER",
+ "ACTIONS_ON_GOOGLE"
+ ],
+ "description": "Optional. The platform that this message is intended for.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Facebook.",
+ "Slack.",
+ "Telegram.",
+ "Kik.",
+ "Skype.",
+ "Line.",
+ "Viber.",
+ "Actions on Google."
+ ]
+ },
+ "suggestions": {
+ "description": "The suggestion chips for Actions on Google.",
+ "$ref": "IntentMessageSuggestions"
+ },
+ "listSelect": {
+ "$ref": "IntentMessageListSelect",
+ "description": "The list card response for Actions on Google."
+ }
+ },
+ "id": "IntentMessage",
+ "description": "Corresponds to the `Response` field in API.AI console.",
+ "type": "object"
+ },
+ "ListContextsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
+ "type": "string"
+ },
+ "contexts": {
+ "description": "The list of contexts. There will be a maximum number of items\nreturned based on the page_size field in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Context"
+ }
+ }
+ },
+ "id": "ListContextsResponse",
+ "description": "The response message for Contexts.ListContexts.",
+ "type": "object"
+ },
+ "Agent": {
+ "properties": {
+ "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"
+ ]
+ },
+ "supportedLanguageCodes": {
+ "description": "Optional. The list of all languages supported by this agent (except for the\n`default_language_code`).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "enableLogging": {
+ "description": "Optional. Determines whether this agent should log conversation queries.",
+ "type": "boolean"
+ },
+ "avatarUri": {
+ "description": "Optional. The URI of the agent's avatar.\nAvatars are used throughout API.AI console and in the self-hosted\n[Web Demo](https://dialogflow.com/docs/integrations/web-demo) integration.",
+ "type": "string"
+ },
+ "classificationThreshold": {
+ "description": "Optional. To filter out false positive results and still get variety in\nmatched natural language inputs for your agent, you can tune the machine\nlearning classification threshold. If the returned score value is less than\nthe threshold value, then a fallback intent is be triggered or, if there\nare no fallback intents defined, no intent will be triggered. The score\nvalues range from 0.0 (completely uncertain) to 1.0 (completely certain).\nIf set to 0.0, the default of 0.3 is used.",
+ "format": "float",
+ "type": "number"
+ },
+ "defaultLanguageCode": {
+ "description": "Required. The default language of the agent as a language tag. See\n[Language Support](https://dialogflow.com/docs/reference/language) for a\nlist of the currently supported language codes.\nThis field cannot be set by the `Update` method.",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "Required. The time zone of this agent from the\n[time zone database](https://www.iana.org/time-zones), e.g.,\nAmerica/New_York, Europe/Paris.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. The description of this agent.\nThe maximum length is 500 characters. If exceeded, the request is rejected.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Required. The name of this agent.",
+ "type": "string"
+ }
+ },
+ "id": "Agent",
+ "description": "Represents a conversational agent.",
+ "type": "object"
+ },
+ "EntityTypeBatch": {
+ "description": "This message is a wrapper around a collection of entity types.",
+ "type": "object",
+ "properties": {
+ "entityTypes": {
+ "description": "A collection of entity types.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityType"
+ }
+ }
+ },
+ "id": "EntityTypeBatch"
+ },
+ "OriginalDetectIntentRequest": {
+ "description": "Represents the contents of the original request that was passed to\nthe `[Streaming]DetectIntent` call.",
+ "type": "object",
+ "properties": {
+ "payload": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Optional. This field is set to the value of `QueryParameters.payload` field\npassed in the request.",
+ "type": "object"
+ },
+ "source": {
+ "description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set\nby Dialogflow-owned servers. Possible values of this field correspond to\nIntent.Message.Platform.",
+ "type": "string"
+ }
+ },
+ "id": "OriginalDetectIntentRequest"
+ },
+ "IntentMessageBasicCardButton": {
+ "description": "The button object that appears at the bottom of a card.",
+ "type": "object",
+ "properties": {
"openUriAction": {
"$ref": "IntentMessageBasicCardButtonOpenUriAction",
"description": "Required. Action to take when a user taps on the button."
+ },
+ "title": {
+ "description": "Required. The title of the button.",
+ "type": "string"
}
},
- "id": "IntentMessageBasicCardButton",
- "description": "The button object that appears at the bottom of a card.",
- "type": "object"
+ "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"
@@ -1293,10 +2149,6 @@
"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"
@@ -1305,6 +2157,14 @@
"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"
@@ -1312,14 +2172,6 @@
"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"
@@ -1328,14 +2180,6 @@
"description": "The basic card message. Useful for displaying information.",
"type": "object",
"properties": {
- "title": {
- "description": "Optional. The title of the card.",
- "type": "string"
- },
- "image": {
- "$ref": "IntentMessageImage",
- "description": "Optional. The image for the card."
- },
"formattedText": {
"description": "Required, unless image is present. The body text of the card.",
"type": "string"
@@ -1350,57 +2194,18 @@
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
+ },
+ "title": {
+ "description": "Optional. The title of the card.",
+ "type": "string"
+ },
+ "image": {
+ "description": "Optional. The image for the card.",
+ "$ref": "IntentMessageImage"
}
},
"id": "IntentMessageBasicCard"
},
- "InputAudioConfig": {
- "description": "Instructs the speech recognizer how to process the audio content.",
- "type": "object",
- "properties": {
- "sampleRateHertz": {
- "description": "Required. Sample rate (in Hertz) of the audio content sent in the query.\nRefer to [Cloud Speech API documentation](/speech/docs/basics) for more\ndetails.",
- "format": "int32",
- "type": "integer"
- },
- "languageCode": {
- "description": "Required. The language of the supplied audio. Dialogflow does not do\ntranslations. See [Language\nSupport](https://dialogflow.com/docs/languages) for a list of the\ncurrently supported language codes. Note that queries in the same session\ndo not necessarily need to specify the same language.",
- "type": "string"
- },
- "phraseHints": {
- "description": "Optional. The collection of phrase hints which are used to boost accuracy\nof speech recognition.\nRefer to [Cloud Speech API documentation](/speech/docs/basics#phrase-hints)\nfor more details.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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"
- }
- },
- "id": "InputAudioConfig"
- },
"EntityTypeEntity": {
"description": "Optional. Represents an entity.",
"type": "object",
@@ -1419,6 +2224,53 @@
},
"id": "EntityTypeEntity"
},
+ "InputAudioConfig": {
+ "description": "Instructs the speech recognizer how to process the audio content.",
+ "type": "object",
+ "properties": {
+ "languageCode": {
+ "description": "Required. The language of the supplied audio. Dialogflow does not do\ntranslations. See [Language\nSupport](https://dialogflow.com/docs/languages) for a list of the\ncurrently supported language codes. Note that queries in the same session\ndo not necessarily need to specify the same language.",
+ "type": "string"
+ },
+ "phraseHints": {
+ "description": "Optional. The collection of phrase hints which are used to boost accuracy\nof speech recognition.\nRefer to [Cloud Speech API documentation](/speech/docs/basics#phrase-hints)\nfor more details.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "audioEncoding": {
+ "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."
+ ],
+ "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"
+ ]
+ },
+ "sampleRateHertz": {
+ "description": "Required. Sample rate (in Hertz) of the audio content sent in the query.\nRefer to [Cloud Speech API documentation](/speech/docs/basics) for more\ndetails.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "InputAudioConfig"
+ },
"ListSessionEntityTypesResponse": {
"description": "The response message for SessionEntityTypes.ListSessionEntityTypes.",
"type": "object",
@@ -1437,6 +2289,20 @@
},
"id": "ListSessionEntityTypesResponse"
},
+ "IntentMessageCarouselSelect": {
+ "description": "The card for presenting a carousel of options to select from.",
+ "type": "object",
+ "properties": {
+ "items": {
+ "description": "Required. Carousel items.",
+ "type": "array",
+ "items": {
+ "$ref": "IntentMessageCarouselSelectItem"
+ }
+ }
+ },
+ "id": "IntentMessageCarouselSelect"
+ },
"SearchAgentsResponse": {
"description": "The response message for Agents.SearchAgents.",
"type": "object",
@@ -1455,20 +2321,6 @@
},
"id": "SearchAgentsResponse"
},
- "IntentMessageCarouselSelect": {
- "description": "The card for presenting a carousel of options to select from.",
- "type": "object",
- "properties": {
- "items": {
- "description": "Required. Carousel items.",
- "type": "array",
- "items": {
- "$ref": "IntentMessageCarouselSelectItem"
- }
- }
- },
- "id": "IntentMessageCarouselSelect"
- },
"BatchCreateEntitiesRequest": {
"description": "The request message for EntityTypes.BatchCreateEntities.",
"type": "object",
@@ -1488,8 +2340,6 @@
"id": "BatchCreateEntitiesRequest"
},
"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.",
@@ -1499,7 +2349,9 @@
}
}
},
- "id": "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"
},
"TextInput": {
"description": "Represents the natural language text to be processed.",
@@ -1582,26 +2434,26 @@
"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"
},
- "queryText": {
- "description": "The original conversational query text:\n- If natural language text was provided as input, `query_text` contains\n a copy of the input.\n- If natural language speech audio was provided as input, `query_text`\n contains the speech recognition result. If speech recognizer produced\n multiple alternatives, a particular one is picked.\n- If an event was provided as input, `query_text` is not set.",
- "type": "string"
- },
"speechRecognitionConfidence": {
"description": "The Speech recognition confidence between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. The default of 0.0 is a sentinel value indicating that confidence\nwas not set.\n\nYou should not rely on this field as it isn't guaranteed to be accurate, or\neven set. In particular this field isn't set in Webhook calls and for\nStreamingDetectIntent since the streaming endpoint has separate confidence\nestimates per portion of the audio in StreamingRecognitionResult.",
"format": "float",
"type": "number"
},
+ "queryText": {
+ "description": "The original conversational query text:\n- If natural language text was provided as input, `query_text` contains\n a copy of the input.\n- If natural language speech audio was provided as input, `query_text`\n contains the speech recognition result. If speech recognizer produced\n multiple alternatives, a particular one is picked.\n- If an event was provided as input, `query_text` is not set.",
+ "type": "string"
+ },
"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"
- },
- "description": "The free-form diagnostic info. For example, this field\ncould contain webhook call latency.",
- "type": "object"
+ }
},
"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`."
+ "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"
},
"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.",
@@ -1614,6 +2466,14 @@
"$ref": "Context"
}
},
+ "webhookPayload": {
+ "description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `payload` field returned in the webhook response.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
"fulfillmentMessages": {
"description": "The collection of rich messages to present to the user.",
"type": "array",
@@ -1621,14 +2481,6 @@
"$ref": "IntentMessage"
}
},
- "webhookPayload": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `payload` field returned in the webhook response.",
- "type": "object"
- },
"action": {
"description": "The action name from the matched intent.",
"type": "string"
@@ -1642,33 +2494,17 @@
"type": "string"
},
"parameters": {
+ "description": "The collection of extracted parameters.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- },
- "description": "The collection of extracted parameters.",
- "type": "object"
+ }
}
},
"id": "QueryResult"
},
- "BatchUpdateEntityTypesResponse": {
- "properties": {
- "entityTypes": {
- "description": "The collection of updated or created entity types.",
- "type": "array",
- "items": {
- "$ref": "EntityType"
- }
- }
- },
- "id": "BatchUpdateEntityTypesResponse",
- "description": "The response message for EntityTypes.BatchUpdateEntityTypes.",
- "type": "object"
- },
"BatchDeleteEntityTypesRequest": {
- "description": "The request message for EntityTypes.BatchDeleteEntityTypes.",
- "type": "object",
"properties": {
"entityTypeNames": {
"description": "Required. The names entity types to delete. All names must point to the\nsame agent as `parent`.",
@@ -1678,12 +2514,70 @@
}
}
},
- "id": "BatchDeleteEntityTypesRequest"
+ "id": "BatchDeleteEntityTypesRequest",
+ "description": "The request message for EntityTypes.BatchDeleteEntityTypes.",
+ "type": "object"
+ },
+ "BatchUpdateEntityTypesResponse": {
+ "description": "The response message for EntityTypes.BatchUpdateEntityTypes.",
+ "type": "object",
+ "properties": {
+ "entityTypes": {
+ "description": "The collection of updated or created entity types.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityType"
+ }
+ }
+ },
+ "id": "BatchUpdateEntityTypesResponse"
+ },
+ "IntentMessageCard": {
+ "description": "The card response message.",
+ "type": "object",
+ "properties": {
+ "buttons": {
+ "description": "Optional. The collection of card buttons.",
+ "type": "array",
+ "items": {
+ "$ref": "IntentMessageCardButton"
+ }
+ },
+ "subtitle": {
+ "description": "Optional. The subtitle of the card.",
+ "type": "string"
+ },
+ "imageUri": {
+ "description": "Optional. The public URI to an image file for the card.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Optional. The title of the card.",
+ "type": "string"
+ }
+ },
+ "id": "IntentMessageCard"
},
"QueryParameters": {
"description": "Represents the parameters of the conversational query.",
"type": "object",
"properties": {
+ "payload": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "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"
+ },
+ "geoLocation": {
+ "description": "Optional. The geo location of this conversational query.",
+ "$ref": "LatLng"
+ },
+ "resetContexts": {
+ "description": "Optional. Specifies whether to delete all contexts in the current session\nbefore the new ones are activated.",
+ "type": "boolean"
+ },
"contexts": {
"description": "Optional. The collection of contexts to be activated before this query is\nexecuted.",
"type": "array",
@@ -1701,90 +2595,38 @@
"items": {
"$ref": "SessionEntityType"
}
- },
- "payload": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "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"
- },
- "geoLocation": {
- "$ref": "LatLng",
- "description": "Optional. The geo location of this conversational query."
- },
- "resetContexts": {
- "description": "Optional. Specifies whether to delete all contexts in the current session\nbefore the new ones are activated.",
- "type": "boolean"
}
},
"id": "QueryParameters"
},
- "IntentMessageCard": {
+ "BatchUpdateEntityTypesRequest": {
+ "description": "The request message for EntityTypes.BatchUpdateEntityTypes.",
+ "type": "object",
"properties": {
- "title": {
- "description": "Optional. The title of the card.",
+ "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"
},
- "buttons": {
- "description": "Optional. The collection of card buttons.",
- "type": "array",
- "items": {
- "$ref": "IntentMessageCardButton"
- }
- },
- "subtitle": {
- "description": "Optional. The subtitle of the card.",
+ "updateMask": {
+ "description": "Optional. The mask to control which fields get updated.",
+ "format": "google-fieldmask",
"type": "string"
},
- "imageUri": {
- "description": "Optional. The public URI to an image file for the card.",
+ "entityTypeBatchUri": {
+ "description": "Warning: Importing entity types from a URI is not implemented yet.\nThis feature is coming soon.\nThe URI to a Google Cloud Storage file containing entity types to update\nor create. The file format can either be a serialized proto (of\nEntityBatch type) or a JSON object. Note: The URI must start with\n\"gs://\".",
"type": "string"
+ },
+ "entityTypeBatchInline": {
+ "$ref": "EntityTypeBatch",
+ "description": "The collection of entity type to update or create."
}
},
- "id": "IntentMessageCard",
- "description": "The card response message.",
- "type": "object"
+ "id": "BatchUpdateEntityTypesRequest"
},
"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": {
- "inputContextNames": {
- "description": "Optional. The list of context names required for this intent to be\ntriggered.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "webhookState": {
- "description": "Required. Indicates whether webhooks are enabled for the intent.",
- "type": "string",
- "enumDescriptions": [
- "Webhook is disabled in the agent and in the intent.",
- "Webhook is enabled in the agent and in the intent.",
- "Webhook is enabled in the agent and in the intent. Also, each slot\nfilling prompt is forwarded to the webhook."
- ],
- "enum": [
- "WEBHOOK_STATE_UNSPECIFIED",
- "WEBHOOK_STATE_ENABLED",
- "WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING"
- ]
- },
- "followupIntentInfo": {
- "description": "Optional. Collection of information about all followup intents that have\nname of this intent as a root_name.",
- "type": "array",
- "items": {
- "$ref": "IntentFollowupIntentInfo"
- }
- },
- "displayName": {
- "description": "Required. The name of this intent.",
- "type": "string"
- },
- "rootFollowupIntentName": {
- "description": "The unique identifier of the root intent in the chain of followup intents.\nIt identifies the correct followup intents chain for this intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
- "type": "string"
- },
"isFallback": {
"description": "Optional. Indicates whether this is a fallback intent.",
"type": "boolean"
@@ -1793,22 +2635,22 @@
"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.",
+ "parameters": {
+ "description": "Optional. The collection of parameters associated with the intent.",
"type": "array",
"items": {
- "$ref": "IntentTrainingPhrase"
+ "$ref": "IntentParameter"
}
},
"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.",
+ "trainingPhrases": {
+ "description": "Optional. The collection of examples/templates that the agent is\ntrained on.",
"type": "array",
"items": {
- "$ref": "IntentParameter"
+ "$ref": "IntentTrainingPhrase"
}
},
"parentFollowupIntentName": {
@@ -1838,6 +2680,7 @@
"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",
@@ -1848,8 +2691,7 @@
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE"
- ],
- "type": "string"
+ ]
},
"enumDescriptions": [
"Not specified.",
@@ -1877,35 +2719,45 @@
"items": {
"$ref": "IntentMessage"
}
+ },
+ "inputContextNames": {
+ "description": "Optional. The list of context names required for this intent to be\ntriggered.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "webhookState": {
+ "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"
+ },
+ "followupIntentInfo": {
+ "description": "Optional. Collection of information about all followup intents that have\nname of this intent as a root_name.",
+ "type": "array",
+ "items": {
+ "$ref": "IntentFollowupIntentInfo"
+ }
+ },
+ "displayName": {
+ "description": "Required. The name of this intent.",
+ "type": "string"
+ },
+ "rootFollowupIntentName": {
+ "description": "The unique identifier of the root intent in the chain of followup intents.\nIt identifies the correct followup intents chain for this intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
+ "type": "string"
}
},
- "id": "Intent",
- "description": "Represents an intent.\nIntents convert a number of user expressions or patterns into an action. An\naction is an extraction of a user command or sentence semantics.",
- "type": "object"
- },
- "BatchUpdateEntityTypesRequest": {
- "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."
- }
- },
- "id": "BatchUpdateEntityTypesRequest",
- "description": "The request message for EntityTypes.BatchUpdateEntityTypes.",
- "type": "object"
+ "id": "Intent"
},
"IntentBatch": {
"description": "This message is a wrapper around a collection of intents.",
@@ -1925,10 +2777,6 @@
"description": "Represents a part of a training phrase.",
"type": "object",
"properties": {
- "entityType": {
- "description": "Optional. The entity type name prefixed with `@`. This field is\nrequired for the annotated part of the text and applies only to\nexamples.",
- "type": "string"
- },
"alias": {
"description": "Optional. The parameter name for the value extracted from the\nannotated part of the example.",
"type": "string"
@@ -1940,42 +2788,46 @@
"text": {
"description": "Required. The text corresponding to the example or template,\nif there are no annotations. For\nannotated examples, it is the text for one of the example's parts.",
"type": "string"
+ },
+ "entityType": {
+ "description": "Optional. The entity type name prefixed with `@`. This field is\nrequired for the annotated part of the text and applies only to\nexamples.",
+ "type": "string"
}
},
"id": "IntentTrainingPhrasePart"
},
"BatchDeleteEntitiesRequest": {
+ "description": "The request message for EntityTypes.BatchDeleteEntities.",
+ "type": "object",
"properties": {
- "languageCode": {
- "description": "Optional. The language of entity synonyms defined in `entities`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
- "type": "string"
- },
"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"
+ "id": "BatchDeleteEntitiesRequest"
},
"IntentMessageListSelect": {
"description": "The card for presenting a list of options to select from.",
"type": "object",
"properties": {
- "title": {
- "description": "Optional. The overall title of the list.",
- "type": "string"
- },
"items": {
"description": "Required. List items.",
"type": "array",
"items": {
"$ref": "IntentMessageListSelectItem"
}
+ },
+ "title": {
+ "description": "Optional. The overall title of the list.",
+ "type": "string"
}
},
"id": "IntentMessageListSelect"
@@ -1991,6 +2843,24 @@
},
"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": {
"description": "An item in the carousel.",
"type": "object",
@@ -2000,8 +2870,8 @@
"type": "string"
},
"image": {
- "description": "Optional. The image to display.",
- "$ref": "IntentMessageImage"
+ "$ref": "IntentMessageImage",
+ "description": "Optional. The image to display."
},
"description": {
"description": "Optional. The body text of the card.",
@@ -2013,888 +2883,12 @@
}
},
"id": "IntentMessageCarouselSelectItem"
- },
- "IntentMessageQuickReplies": {
- "description": "The quick replies response message.",
- "type": "object",
- "properties": {
- "title": {
- "description": "Optional. The title of the collection of quick replies.",
- "type": "string"
- },
- "quickReplies": {
- "description": "Optional. The collection of quick replies.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "IntentMessageQuickReplies"
- },
- "WebhookRequest": {
- "description": "The request message for a webhook call.",
- "type": "object",
- "properties": {
- "responseId": {
- "description": "The unique identifier of the response. Contains the same value as\n`[Streaming]DetectIntentResponse.response_id`.",
- "type": "string"
- },
- "session": {
- "description": "The unique identifier of detectIntent request session.\nCan be used to identify end-user inside webhook implementation.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
- "type": "string"
- },
- "queryResult": {
- "$ref": "QueryResult",
- "description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`."
- },
- "originalDetectIntentRequest": {
- "description": "Optional. The contents of the original request that was passed to\n`[Streaming]DetectIntent` call.",
- "$ref": "OriginalDetectIntentRequest"
- }
- },
- "id": "WebhookRequest"
- },
- "RestoreAgentRequest": {
- "properties": {
- "agentUri": {
- "description": "Warning: Restoring agents from a URI is not implemented yet.\nThis feature is coming soon.\n\nThe URI to a Google Cloud Storage file containing the agent to restore.\nNote: The URI must start with \"gs://\".",
- "type": "string"
- },
- "agentContent": {
- "description": "The agent to restore.\n\nExample for how to restore an agent via the command line:\n\ncurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:restore\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary \"{\n 'agentContent': '$(cat \u003cagent zip file\u003e | base64 -w 0)'\n }\" \\",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "RestoreAgentRequest",
- "description": "The request message for Agents.RestoreAgent.",
- "type": "object"
- },
- "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": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "EXAMPLE",
- "TEMPLATE"
- ],
- "description": "Required. The type of the training phrase.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. This value should never be used.",
- "Examples do not contain @-prefixed entity type names, but example parts\ncan be annotated with entity types.",
- "Templates are not annotated with entity types, but they can contain\n@-prefixed entity type names as substrings."
- ]
- }
- },
- "id": "IntentTrainingPhrase"
- },
- "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": {
- "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"
- }
- },
- "id": "Context",
- "description": "Represents a context.",
- "type": "object"
- },
- "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": {
- "description": "The response message for Intents.BatchUpdateIntents.",
- "type": "object",
- "properties": {
- "intents": {
- "description": "The collection of updated or created intents.",
- "type": "array",
- "items": {
- "$ref": "Intent"
- }
- }
- },
- "id": "BatchUpdateIntentsResponse"
- },
- "IntentParameter": {
- "description": "Represents intent parameters.",
- "type": "object",
- "properties": {
- "prompts": {
- "description": "Optional. The collection of prompts that the agent can present to the\nuser in order to collect value for the parameter.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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": {
- "description": "Optional. Indicates whether the parameter represents a list of values.",
- "type": "boolean"
- },
- "name": {
- "description": "The unique identifier of this parameter.",
- "type": "string"
- },
- "value": {
- "description": "Optional. The definition of the parameter value. It can be:\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.",
- "type": "string"
- },
- "displayName": {
- "description": "Required. The name of the parameter.",
- "type": "string"
- },
- "entityTypeDisplayName": {
- "description": "Optional. The name of the entity type, prefixed with `@`, that\ndescribes values of the parameter. If the parameter is\nrequired, this must be provided.",
- "type": "string"
- }
- },
- "id": "IntentParameter"
- },
- "ExportAgentResponse": {
- "description": "The response message for Agents.ExportAgent.",
- "type": "object",
- "properties": {
- "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"
- },
- "accessibilityText": {
- "description": "Optional. A text description of the image to be used for accessibility,\ne.g., screen readers.",
- "type": "string"
- }
- },
- "id": "IntentMessageImage"
- },
- "BatchUpdateIntentsRequest": {
- "description": "The request message for Intents.BatchUpdateIntents.",
- "type": "object",
- "properties": {
- "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": {
- "enum": [
- "INTENT_VIEW_UNSPECIFIED",
- "INTENT_VIEW_FULL"
- ],
- "description": "Optional. The resource view to apply to the returned intent.",
- "type": "string",
- "enumDescriptions": [
- "Training phrases field is not populated in the response.",
- "All fields are populated."
- ]
- },
- "intentBatchInline": {
- "$ref": "IntentBatch",
- "description": "The collection of intents to update or create."
- }
- },
- "id": "BatchUpdateIntentsRequest"
- },
- "TrainAgentRequest": {
- "description": "The request message for Agents.TrainAgent.",
- "type": "object",
- "properties": {},
- "id": "TrainAgentRequest"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "SessionEntityType": {
- "description": "Represents a session entity type.\n\nExtends or replaces a developer entity type at the user session level (we\nrefer to the entity types defined at the agent level as \"developer entity\ntypes\").\n\nNote: session entity types apply to all queries, regardless of the language.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Required. The unique identifier of this session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.",
- "type": "string"
- },
- "entityOverrideMode": {
- "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"
- },
- "BatchUpdateEntitiesRequest": {
- "properties": {
- "entities": {
- "description": "Required. The collection of new entities to replace the existing entities.",
- "type": "array",
- "items": {
- "$ref": "EntityTypeEntity"
- }
- },
- "languageCode": {
- "description": "Optional. The language of entity synonyms defined in `entities`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
- "type": "string"
- },
- "updateMask": {
- "description": "Optional. The mask to control which fields get updated.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "BatchUpdateEntitiesRequest",
- "description": "The response message for EntityTypes.BatchCreateEntities.",
- "type": "object"
- },
- "IntentMessageText": {
- "properties": {
- "text": {
- "description": "Optional. The collection of the agent's responses.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "IntentMessageText",
- "description": "The text response message.",
- "type": "object"
- },
- "WebhookResponse": {
- "description": "The response message for a webhook call.",
- "type": "object",
- "properties": {
- "source": {
- "description": "Optional. This value is passed directly to `QueryResult.webhook_source`.",
- "type": "string"
- },
- "followupEventInput": {
- "$ref": "EventInput",
- "description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input."
- },
- "outputContexts": {
- "description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.",
- "type": "array",
- "items": {
- "$ref": "Context"
- }
- },
- "fulfillmentText": {
- "description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.",
- "type": "string"
- },
- "fulfillmentMessages": {
- "description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.",
- "type": "array",
- "items": {
- "$ref": "IntentMessage"
- }
- },
- "payload": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Optional. This value is passed directly to `QueryResult.webhook_payload`.",
- "type": "object"
- }
- },
- "id": "WebhookResponse"
- },
- "BatchDeleteIntentsRequest": {
- "description": "The request message for Intents.BatchDeleteIntents.",
- "type": "object",
- "properties": {
- "intents": {
- "description": "Required. The collection of intents to delete. Only intent `name` must be\nfilled in.",
- "type": "array",
- "items": {
- "$ref": "Intent"
- }
- }
- },
- "id": "BatchDeleteIntentsRequest"
- },
- "QueryInput": {
- "description": "Represents the query input. It can contain either:\n\n1. An audio config which\n instructs the speech recognizer how to process the speech audio.\n\n2. A conversational query in the form of text,.\n\n3. An event that specifies which intent to trigger.",
- "type": "object",
- "properties": {
- "event": {
- "$ref": "EventInput",
- "description": "The event to be processed."
- },
- "text": {
- "$ref": "TextInput",
- "description": "The natural language text to be processed."
- },
- "audioConfig": {
- "$ref": "InputAudioConfig",
- "description": "Instructs the speech recognizer how to process the speech audio."
- }
- },
- "id": "QueryInput"
- },
- "DetectIntentResponse": {
- "description": "The message returned from the DetectIntent method.",
- "type": "object",
- "properties": {
- "queryResult": {
- "description": "The results of the conversational query or event processing.",
- "$ref": "QueryResult"
- },
- "webhookStatus": {
- "description": "Specifies the status of the webhook request. `webhook_status`\nis never populated in webhook requests.",
- "$ref": "Status"
- },
- "responseId": {
- "description": "The unique identifier of the response. It can be used to\nlocate a response in the training example set or for reporting issues.",
- "type": "string"
- }
- },
- "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"
- },
- "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": {
- "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": {
- "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"
- },
- "IntentMessageSuggestions": {
- "description": "The collection of suggestions.",
- "type": "object",
- "properties": {
- "suggestions": {
- "description": "Required. The list of suggested replies.",
- "type": "array",
- "items": {
- "$ref": "IntentMessageSuggestion"
- }
- }
- },
- "id": "IntentMessageSuggestions"
- },
- "EventInput": {
- "properties": {
- "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"
- },
- "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"
- }
- },
- "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"
- },
- "EntityType": {
- "description": "Represents an entity type.\nEntity types serve as a tool for extracting parameter values from natural\nlanguage queries.",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "Required. The name of the entity.",
- "type": "string"
- },
- "kind": {
- "enum": [
- "KIND_UNSPECIFIED",
- "KIND_MAP",
- "KIND_LIST"
- ],
- "description": "Required. Indicates the kind of entity type.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. This value should be never used.",
- "Map entity types allow mapping of a group of synonyms to a canonical\nvalue.",
- "List entity types contain a set of entries that do not map to canonical\nvalues. However, list entity types can contain references to other entity\ntypes (with or without aliases)."
- ]
- },
- "autoExpansionMode": {
- "enumDescriptions": [
- "Auto expansion disabled for the entity.",
- "Allows an agent to recognize values that have not been explicitly\nlisted in the entity."
- ],
- "enum": [
- "AUTO_EXPANSION_MODE_UNSPECIFIED",
- "AUTO_EXPANSION_MODE_DEFAULT"
- ],
- "description": "Optional. Indicates whether the entity type can be automatically\nexpanded.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "EntityType"
- },
- "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"
- },
- "IntentMessage": {
- "description": "Corresponds to the `Response` field in API.AI console.",
- "type": "object",
- "properties": {
- "card": {
- "$ref": "IntentMessageCard",
- "description": "The card response."
- },
- "basicCard": {
- "$ref": "IntentMessageBasicCard",
- "description": "The basic card response for Actions on Google."
- },
- "carouselSelect": {
- "description": "The carousel card response for Actions on Google.",
- "$ref": "IntentMessageCarouselSelect"
- },
- "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."
- },
- "image": {
- "$ref": "IntentMessageImage",
- "description": "The image response."
- },
- "payload": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The response containing a custom payload.",
- "type": "object"
- },
- "text": {
- "$ref": "IntentMessageText",
- "description": "The text response."
- },
- "suggestions": {
- "description": "The suggestion chips for Actions on Google.",
- "$ref": "IntentMessageSuggestions"
- },
- "platform": {
- "enumDescriptions": [
- "Not specified.",
- "Facebook.",
- "Slack.",
- "Telegram.",
- "Kik.",
- "Skype.",
- "Line.",
- "Viber.",
- "Actions on Google."
- ],
- "enum": [
- "PLATFORM_UNSPECIFIED",
- "FACEBOOK",
- "SLACK",
- "TELEGRAM",
- "KIK",
- "SKYPE",
- "LINE",
- "VIBER",
- "ACTIONS_ON_GOOGLE"
- ],
- "description": "Optional. The platform that this message is intended for.",
- "type": "string"
- },
- "listSelect": {
- "$ref": "IntentMessageListSelect",
- "description": "The list card response for Actions on Google."
- },
- "quickReplies": {
- "description": "The quick replies response.",
- "$ref": "IntentMessageQuickReplies"
- }
- },
- "id": "IntentMessage"
- },
- "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"
- }
- }
- },
- "id": "ListContextsResponse"
- },
- "EntityTypeBatch": {
- "description": "This message is a wrapper around a collection of entity types.",
- "type": "object",
- "properties": {
- "entityTypes": {
- "description": "A collection of entity types.",
- "type": "array",
- "items": {
- "$ref": "EntityType"
- }
- }
- },
- "id": "EntityTypeBatch"
- },
- "OriginalDetectIntentRequest": {
- "description": "Represents the contents of the original request that was passed to\nthe `[Streaming]DetectIntent` call.",
- "type": "object",
- "properties": {
- "payload": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Optional. This field is set to the value of `QueryParameters.payload` field\npassed in the request.",
- "type": "object"
- },
- "source": {
- "description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set\nby Dialogflow-owned servers. Possible values of this field correspond to\nIntent.Message.Platform.",
- "type": "string"
- }
- },
- "id": "OriginalDetectIntentRequest"
- },
- "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"
- },
- "supportedLanguageCodes": {
- "description": "Optional. The list of all languages supported by this agent (except for the\n`default_language_code`).",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "enableLogging": {
- "description": "Optional. Determines whether this agent should log conversation queries.",
- "type": "boolean"
- },
- "avatarUri": {
- "description": "Optional. The URI of the agent's avatar.\nAvatars are used throughout API.AI console and in the self-hosted\n[Web Demo](https://dialogflow.com/docs/integrations/web-demo) integration.",
- "type": "string"
- },
- "classificationThreshold": {
- "description": "Optional. To filter out false positive results and still get variety in\nmatched natural language inputs for your agent, you can tune the machine\nlearning classification threshold. If the returned score value is less than\nthe threshold value, then a fallback intent is be triggered or, if there\nare no fallback intents defined, no intent will be triggered. The score\nvalues range from 0.0 (completely uncertain) to 1.0 (completely certain).\nIf set to 0.0, the default of 0.3 is used.",
- "format": "float",
- "type": "number"
- },
- "timeZone": {
- "description": "Required. The time zone of this agent from the\n[time zone database](https://www.iana.org/time-zones), e.g.,\nAmerica/New_York, Europe/Paris.",
- "type": "string"
- },
- "defaultLanguageCode": {
- "description": "Required. The default language of the agent as a language tag. See\n[Language Support](https://dialogflow.com/docs/reference/language) for a\nlist of the currently supported language codes.\nThis field cannot be set by the `Update` method.",
- "type": "string"
- },
- "description": {
- "description": "Optional. The description of this agent.\nThe maximum length is 500 characters. If exceeded, the request is rejected.",
- "type": "string"
- },
- "displayName": {
- "description": "Required. The name of this agent.",
- "type": "string"
- }
- },
- "id": "Agent"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"canonicalName": "Dialogflow",
"auth": {
@@ -2905,5 +2899,11 @@
}
}
}
- }
+ },
+ "rootUrl": "https://dialogflow.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "dialogflow",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Dialogflow API"
}
diff --git a/digitalassetlinks/v1/digitalassetlinks-api.json b/digitalassetlinks/v1/digitalassetlinks-api.json
index 9509271..b6544fb 100644
--- a/digitalassetlinks/v1/digitalassetlinks-api.json
+++ b/digitalassetlinks/v1/digitalassetlinks-api.json
@@ -1,4 +1,9 @@
{
+ "name": "digitalassetlinks",
+ "batchPath": "batch",
+ "revision": "20180115",
+ "documentationLink": "https://developers.google.com/digital-asset-links/",
+ "id": "digitalassetlinks:v1",
"title": "Digital Asset Links API",
"ownerName": "Google",
"discoveryVersion": "v1",
@@ -7,7 +12,6 @@
"statements": {
"methods": {
"list": {
- "flatPath": "v1/statements:list",
"id": "digitalassetlinks.statements.list",
"path": "v1/statements:list",
"description": "Retrieves a list of all statements from a given source that match the\nspecified target and statement string.\n\nThe API guarantees that all statements with secure source assets, such as\nHTTPS websites or Android apps, have been made in a secure way by the owner\nof those assets, as described in the [Digital Asset Links technical design\nspecification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md).\nSpecifically, you should consider that for insecure websites (that is,\nwhere the URL starts with `http://` instead of `https://`), this guarantee\ncannot be made.\n\nThe `List` command is most useful in cases where the API client wants to\nknow all the ways in which two assets are related, or enumerate all the\nrelationships from a particular source asset. Example: a feature that\nhelps users navigate to related items. When a mobile app is running on a\ndevice, the feature would make it easy to navigate to the corresponding web\nsite or Google+ profile.",
@@ -17,17 +21,46 @@
"$ref": "ListResponse"
},
"parameters": {
- "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"
- },
"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",
- "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"
+ "location": "query"
},
"source.androidApp.packageName": {
+ "description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED",
+ "type": "string",
+ "location": "query"
+ },
+ "source.androidApp.certificate.sha256Fingerprint": {
+ "description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM\n certificate, it can be acquired like this:\n\n $ keytool -printcert -file $CERTFILE | grep SHA256:\n SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\\n 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nor like this:\n\n $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256\n SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\\n 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nIn this example, the contents of this field would be `14:6D:E9:83:C5:73:\n06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:\n44:E5`.\n\nIf these tools are not available to you, you can convert the PEM\ncertificate into the DER format, compute the SHA-256 hash of that string\nand represent the result as a hexstring (that is, uppercase hexadecimal\nrepresentations of each octet, separated by colons).",
+ "type": "string",
+ "location": "query"
+ },
+ "relation": {
+ "description": "Use only associations that match the specified relation.\n\nSee the [`Statement`](#Statement) message for a detailed definition of\nrelation strings.\n\nFor a query to match a statement, one of the following must be true:\n\n* both the query's and the statement's relation strings match exactly,\n or\n* the query's relation string is empty or missing.\n\nExample: A query with relation `delegate_permission/common.handle_all_urls`\nmatches an asset link with relation\n`delegate_permission/common.handle_all_urls`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/statements:list"
+ }
+ }
+ },
+ "assetlinks": {
+ "methods": {
+ "check": {
+ "parameters": {
+ "source.androidApp.packageName": {
+ "description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED",
+ "type": "string",
+ "location": "query"
+ },
+ "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": {
"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"
@@ -36,14 +69,23 @@
"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"
+ },
+ "target.web.site": {
+ "location": "query",
+ "description": "Web assets are identified by a URL that contains only the scheme, hostname\nand port parts. The format is\n\n http[s]://\u003chostname\u003e[:\u003cport\u003e]\n\nHostnames must be fully qualified: they must end in a single period\n(\"`.`\").\n\nOnly the schemes \"http\" and \"https\" are currently allowed.\n\nPort numbers are given as a decimal number, and they must be omitted if the\nstandard port numbers are used: 80 for http and 443 for https.\n\nWe call this limited URL the \"site\". All URLs that share the same scheme,\nhostname and port are considered to be a part of the site and thus belong\nto the web asset.\n\nExample: the asset with the site `https://www.google.com` contains all\nthese URLs:\n\n * `https://www.google.com/`\n * `https://www.google.com:443/`\n * `https://www.google.com/foo`\n * `https://www.google.com/foo?bar`\n * `https://www.google.com/foo#bar`\n * `https://user@password:www.google.com/`\n\nBut it does not contain these URLs:\n\n * `http://www.google.com/` (wrong scheme)\n * `https://google.com/` (hostname does not match)\n * `https://www.google.com:444/` (port does not match)\nREQUIRED",
+ "type": "string"
+ },
+ "target.androidApp.certificate.sha256Fingerprint": {
+ "location": "query",
+ "description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM\n certificate, it can be acquired like this:\n\n $ keytool -printcert -file $CERTFILE | grep SHA256:\n SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\\n 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nor like this:\n\n $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256\n SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\\n 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nIn this example, the contents of this field would be `14:6D:E9:83:C5:73:\n06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:\n44:E5`.\n\nIf these tools are not available to you, you can convert the PEM\ncertificate into the DER format, compute the SHA-256 hash of that string\nand represent the result as a hexstring (that is, uppercase hexadecimal\nrepresentations of each octet, separated by colons).",
+ "type": "string"
}
- }
- }
- }
- },
- "assetlinks": {
- "methods": {
- "check": {
+ },
"flatPath": "v1/assetlinks:check",
"path": "v1/assetlinks:check",
"id": "digitalassetlinks.assetlinks.check",
@@ -52,69 +94,26 @@
"$ref": "CheckResponse"
},
"parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "target.androidApp.certificate.sha256Fingerprint": {
- "type": "string",
- "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)."
- },
- "source.androidApp.packageName": {
- "location": "query",
- "description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED",
- "type": "string"
- },
- "source.web.site": {
- "type": "string",
- "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"
- },
- "target.androidApp.packageName": {
- "type": "string",
- "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"
- },
- "source.androidApp.certificate.sha256Fingerprint": {
- "type": "string",
- "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)."
- },
- "relation": {
- "location": "query",
- "description": "Query string for the relation.\n\nWe identify relations with strings of the format `\u003ckind\u003e/\u003cdetail\u003e`, where\n`\u003ckind\u003e` must be one of a set of pre-defined purpose categories, and\n`\u003cdetail\u003e` is a free-form lowercase alphanumeric string that describes the\nspecific use case of the statement.\n\nRefer to [our API documentation](/digital-asset-links/v1/relation-strings)\nfor the current list of supported relations.\n\nFor a query to match an asset link, both the query's and the asset link's\nrelation strings must match exactly.\n\nExample: A query with relation `delegate_permission/common.handle_all_urls`\nmatches an asset link with relation\n`delegate_permission/common.handle_all_urls`.",
- "type": "string"
- },
- "target.web.site": {
- "type": "string",
- "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"
- }
- }
+ "httpMethod": "GET"
}
}
}
},
"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."
+ "description": "OAuth bearer token.",
+ "type": "string"
},
"upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ "location": "query"
},
"prettyPrint": {
"location": "query",
@@ -133,24 +132,30 @@
"type": "string"
},
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
"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",
@@ -158,12 +163,6 @@
"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": {
@@ -172,103 +171,23 @@
"type": "string"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
}
},
"schemas": {
- "WebAsset": {
- "description": "Describes a web asset.",
- "type": "object",
- "properties": {
- "site": {
- "type": "string",
- "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"
- }
- },
- "id": "WebAsset"
- },
- "ListResponse": {
- "description": "Response message for the List call.",
- "type": "object",
- "properties": {
- "debugString": {
- "type": "string",
- "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."
- },
- "maxAge": {
- "type": "string",
- "description": "From serving time, how much longer the response should be considered valid\nbarring further updates.\nREQUIRED",
- "format": "google-duration"
- },
- "errorCode": {
- "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"
- ]
- },
- "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",
@@ -281,19 +200,19 @@
"id": "CertificateInfo"
},
"AndroidAppAsset": {
+ "id": "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"
+ },
+ "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"
+ }
},
"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.",
@@ -311,8 +230,47 @@
"id": "Asset"
},
"CheckResponse": {
+ "description": "Response message for the CheckAssetLinks call.",
"type": "object",
"properties": {
+ "maxAge": {
+ "description": "From serving time, how much longer the response should be considered valid\nbarring further updates.\nREQUIRED",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "errorCode": {
+ "enumDescriptions": [
+ "",
+ "Unable to parse query.",
+ "Unable to fetch the asset links data.",
+ "Invalid HTTPS certificate .",
+ "HTTP redirects (e.g, 301) are not allowed.",
+ "Asset links data exceeds maximum size.",
+ "Can't parse HTTP response.",
+ "HTTP Content-type should be application/json.",
+ "JSON content is malformed.",
+ "A secure asset includes an insecure asset (security downgrade).",
+ "Too many includes (maybe a loop)."
+ ],
+ "description": "Error codes that describe the result of the Check operation.",
+ "type": "array",
+ "items": {
+ "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"
+ }
+ },
"linked": {
"description": "Set to true if the assets specified in the request are linked by the\nrelation specified in the request.",
"type": "boolean"
@@ -320,13 +278,44 @@
"debugString": {
"description": "Human-readable message containing information intended to help end users\nunderstand, reproduce and debug the result.\n\n\nThe message will be in English and we are currently not planning to offer\nany translations.\n\nPlease note that no guarantees are made about the contents or format of\nthis string. Any aspect of it may be subject to change without notice.\nYou should not attempt to programmatically parse this data. For\nprogrammatic access, use the error_code field below.",
"type": "string"
+ }
+ },
+ "id": "CheckResponse"
+ },
+ "WebAsset": {
+ "id": "WebAsset",
+ "description": "Describes a web asset.",
+ "type": "object",
+ "properties": {
+ "site": {
+ "description": "Web assets are identified by a URL that contains only the scheme, hostname\nand port parts. The format is\n\n http[s]://\u003chostname\u003e[:\u003cport\u003e]\n\nHostnames must be fully qualified: they must end in a single period\n(\"`.`\").\n\nOnly the schemes \"http\" and \"https\" are currently allowed.\n\nPort numbers are given as a decimal number, and they must be omitted if the\nstandard port numbers are used: 80 for http and 443 for https.\n\nWe call this limited URL the \"site\". All URLs that share the same scheme,\nhostname and port are considered to be a part of the site and thus belong\nto the web asset.\n\nExample: the asset with the site `https://www.google.com` contains all\nthese URLs:\n\n * `https://www.google.com/`\n * `https://www.google.com:443/`\n * `https://www.google.com/foo`\n * `https://www.google.com/foo?bar`\n * `https://www.google.com/foo#bar`\n * `https://user@password:www.google.com/`\n\nBut it does not contain these URLs:\n\n * `http://www.google.com/` (wrong scheme)\n * `https://google.com/` (hostname does not match)\n * `https://www.google.com:444/` (port does not match)\nREQUIRED",
+ "type": "string"
+ }
+ }
+ },
+ "ListResponse": {
+ "id": "ListResponse",
+ "description": "Response message for the List call.",
+ "type": "object",
+ "properties": {
+ "statements": {
+ "description": "A list of all the matching statements that have been found.",
+ "type": "array",
+ "items": {
+ "$ref": "Statement"
+ }
+ },
+ "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": {
- "type": "string",
"description": "From serving time, how much longer the response should be considered valid\nbarring further updates.\nREQUIRED",
- "format": "google-duration"
+ "format": "google-duration",
+ "type": "string"
},
"errorCode": {
+ "description": "Error codes that describe the result of the List operation.",
"type": "array",
"items": {
"enum": [
@@ -356,18 +345,34 @@
"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."
+ ]
+ }
+ }
+ },
+ "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": {
+ "description": "Every statement has a target asset.\nREQUIRED",
+ "$ref": "Asset"
+ },
+ "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": "CheckResponse",
- "description": "Response message for the CheckAssetLinks call."
+ "id": "Statement"
}
},
"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://digitalassetlinks.googleapis.com/",
@@ -376,10 +381,5 @@
"servicePath": "",
"rootUrl": "https://digitalassetlinks.googleapis.com/",
"basePath": "",
- "ownerDomain": "google.com",
- "name": "digitalassetlinks",
- "batchPath": "batch",
- "revision": "20180115",
- "documentationLink": "https://developers.google.com/digital-asset-links/",
- "id": "digitalassetlinks:v1"
+ "ownerDomain": "google.com"
}
diff --git a/dlp/v2beta1/dlp-api.json b/dlp/v2beta1/dlp-api.json
index f068a0d..79e9837 100644
--- a/dlp/v2beta1/dlp-api.json
+++ b/dlp/v2beta1/dlp-api.json
@@ -1,4 +1,6 @@
{
+ "ownerDomain": "google.com",
+ "name": "dlp",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "DLP API",
@@ -6,66 +8,65 @@
"resources": {
"content": {
"methods": {
- "deidentify": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/content:deidentify",
- "path": "v2beta1/content:deidentify",
- "id": "dlp.content.deidentify",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentRequest"
- },
- "description": "De-identifies potentially sensitive info from a list of strings.\nThis method has limits on input size and output size."
- },
"inspect": {
"response": {
"$ref": "GooglePrivacyDlpV2beta1InspectContentResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
+ "parameters": {},
"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"
- }
+ },
+ "description": "Finds potentially sensitive info in a list of strings.\nThis method has limits on input size, processing time, and output size."
},
"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.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1RedactContentResponse"
- },
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/content:redact",
+ "path": "v2beta1/content:redact",
"id": "dlp.content.redact",
- "path": "v2beta1/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.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1RedactContentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST"
+ },
+ "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": {
- "description": "Returns the list of root categories of sensitive information.",
"response": {
"$ref": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse"
},
@@ -76,27 +77,21 @@
],
"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",
- "location": "query"
+ "type": "string"
}
},
"flatPath": "v2beta1/rootCategories",
"path": "v2beta1/rootCategories",
- "id": "dlp.rootCategories.list"
+ "id": "dlp.rootCategories.list",
+ "description": "Returns the list of root categories of sensitive information."
}
},
"resources": {
"infoTypes": {
"methods": {
"list": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1ListInfoTypesResponse"
- },
- "parameterOrder": [
- "category"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -109,15 +104,22 @@
"location": "path"
},
"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"
+ "type": "string",
+ "location": "query"
}
},
"flatPath": "v2beta1/rootCategories/{rootCategoriesId}/infoTypes",
"path": "v2beta1/rootCategories/{+category}/infoTypes",
"id": "dlp.rootCategories.infoTypes.list",
- "description": "Returns sensitive information types for given category."
+ "description": "Returns sensitive information types for given category.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1ListInfoTypesResponse"
+ },
+ "parameterOrder": [
+ "category"
+ ],
+ "httpMethod": "GET"
}
}
}
@@ -127,46 +129,15 @@
"resources": {
"operations": {
"methods": {
- "cancel": {
- "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}:cancel",
- "path": "v2beta1/{+name}:cancel",
- "id": "dlp.riskAnalysis.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.",
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^riskAnalysis/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"
- ]
- },
"delete": {
- "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}",
- "id": "dlp.riskAnalysis.operations.delete",
- "path": "v2beta1/{+name}",
"description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
- "httpMethod": "DELETE",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "DELETE",
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
@@ -178,18 +149,18 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}",
+ "path": "v2beta1/{+name}",
+ "id": "dlp.riskAnalysis.operations.delete"
},
"list": {
- "description": "Fetches the list of long running operations.",
- "httpMethod": "GET",
- "response": {
- "$ref": "GoogleLongrunningListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
"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,
@@ -198,20 +169,15 @@
"location": "path"
},
"pageToken": {
+ "location": "query",
"description": "The standard list page token.",
- "type": "string",
- "location": "query"
+ "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",
- "location": "query"
- },
- "filter": {
- "description": "Filters by `done`. That is, `done=true` or `done=false`.",
- "type": "string",
- "location": "query"
+ "type": "integer"
}
},
"scopes": [
@@ -219,32 +185,68 @@
],
"flatPath": "v2beta1/riskAnalysis/operations",
"id": "dlp.riskAnalysis.operations.list",
- "path": "v2beta1/{+name}"
- },
- "get": {
- "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.",
+ "description": "Fetches the list of long running operations.",
"httpMethod": "GET",
- "response": {
- "$ref": "GoogleLongrunningOperation"
- },
"parameterOrder": [
"name"
],
+ "response": {
+ "$ref": "GoogleLongrunningListOperationsResponse"
+ }
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunningOperation"
+ },
"parameters": {
"name": {
- "location": "path",
"description": "The name of the operation resource.",
"required": true,
"type": "string",
- "pattern": "^riskAnalysis/operations/[^/]+$"
+ "pattern": "^riskAnalysis/operations/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}"
+ "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": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^riskAnalysis/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}:cancel",
+ "path": "v2beta1/{+name}:cancel",
+ "id": "dlp.riskAnalysis.operations.cancel",
+ "description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation.",
+ "request": {
+ "$ref": "GoogleLongrunningCancelOperationRequest"
+ },
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST"
}
}
}
@@ -253,22 +255,22 @@
"dataSource": {
"methods": {
"analyze": {
+ "description": "Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest"
+ },
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {},
"flatPath": "v2beta1/dataSource:analyze",
"path": "v2beta1/dataSource:analyze",
- "id": "dlp.dataSource.analyze",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest"
- },
- "description": "Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository."
+ "id": "dlp.dataSource.analyze"
}
}
},
@@ -279,34 +281,30 @@
"findings": {
"methods": {
"list": {
- "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"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse"
+ },
"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"
+ "type": "string",
+ "location": "query"
},
"name": {
- "location": "path",
"description": "Identifier of the results set returned as metadata of\nthe longrunning operation created by a call to InspectDataSource.\nShould be in the format of `inspect/results/{id}`.",
"required": true,
"type": "string",
- "pattern": "^inspect/results/[^/]+$"
+ "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",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"description": "Maximum number of results to return.\nIf 0, the implementation selects a reasonable value.",
@@ -317,7 +315,11 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v2beta1/inspect/results/{resultsId}/findings",
+ "id": "dlp.inspect.results.findings.list",
+ "path": "v2beta1/{+name}/findings",
+ "description": "Returns list of results for given inspect operation result set id."
}
}
}
@@ -325,15 +327,40 @@
},
"operations": {
"methods": {
- "list": {
- "description": "Fetches the list of long running operations.",
+ "delete": {
+ "path": "v2beta1/{+name}",
+ "id": "dlp.inspect.operations.delete",
+ "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
"response": {
- "$ref": "GoogleLongrunningListOperationsResponse"
+ "$ref": "GoogleProtobufEmpty"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^inspect/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/inspect/operations/{operationsId}"
+ },
+ "list": {
+ "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`.",
@@ -341,11 +368,11 @@
"location": "query"
},
"name": {
- "pattern": "^inspect/operations$",
- "location": "path",
"description": "The name of the operation's parent resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^inspect/operations$",
+ "location": "path"
},
"pageToken": {
"description": "The standard list page token.",
@@ -363,33 +390,33 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/inspect/operations",
- "path": "v2beta1/{+name}",
- "id": "dlp.inspect.operations.list"
+ "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",
- "pattern": "^inspect/operations/[^/]+$"
+ "type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v2beta1/inspect/operations/{operationsId}",
- "path": "v2beta1/{+name}",
"id": "dlp.inspect.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ "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"
+ }
},
"create": {
"response": {
@@ -410,6 +437,12 @@
}
},
"cancel": {
+ "id": "dlp.inspect.operations.cancel",
+ "path": "v2beta1/{+name}:cancel",
+ "request": {
+ "$ref": "GoogleLongrunningCancelOperationRequest"
+ },
+ "description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation.",
"httpMethod": "POST",
"parameterOrder": [
"name"
@@ -419,36 +452,8 @@
},
"parameters": {
"name": {
- "pattern": "^inspect/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": "v2beta1/inspect/operations/{operationsId}:cancel",
- "id": "dlp.inspect.operations.cancel",
- "path": "v2beta1/{+name}:cancel",
- "request": {
- "$ref": "GoogleLongrunningCancelOperationRequest"
- },
- "description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation."
- },
- "delete": {
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
- "required": true,
"type": "string",
"pattern": "^inspect/operations/[^/]+$",
"location": "path"
@@ -457,10 +462,7 @@
"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`."
+ "flatPath": "v2beta1/inspect/operations/{operationsId}:cancel"
}
}
}
@@ -468,16 +470,47 @@
}
},
"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"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "default": "true"
},
"fields": {
"location": "query",
@@ -489,6 +522,11 @@
"type": "string",
"location": "query"
},
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
@@ -502,11 +540,6 @@
"description": "V1 error format.",
"type": "string"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"alt": {
"description": "Data format for response.",
"default": "json",
@@ -522,44 +555,13 @@
"Responses with Content-Type of application/x-protobuf"
],
"location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "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": "v2beta1",
"baseUrl": "https://dlp.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "The Google Data Loss Prevention API provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.",
"servicePath": "",
+ "description": "The Google Data Loss Prevention API provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.",
+ "kind": "discovery#restDescription",
"basePath": "",
"id": "dlp:v2beta1",
"documentationLink": "https://cloud.google.com/dlp/docs/",
@@ -567,25 +569,79 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "GooglePrivacyDlpV2beta1BigQueryOptions": {
- "description": "Options defining BigQuery table and row identifiers.",
+ "GooglePrivacyDlpV2beta1DeidentifyConfig": {
+ "id": "GooglePrivacyDlpV2beta1DeidentifyConfig",
+ "description": "The configuration that controls how the data will change.",
"type": "object",
"properties": {
- "tableReference": {
- "description": "Complete BigQuery table reference.",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
+ "recordTransformations": {
+ "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table.",
+ "$ref": "GooglePrivacyDlpV2beta1RecordTransformations"
},
- "identifyingFields": {
- "description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.",
+ "infoTypeTransformations": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformations",
+ "description": "Treat the dataset as free-form text and apply the same free text\ntransformation everywhere."
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1LDiversityConfig": {
+ "description": "l-diversity metric, used for analysis of reidentification risk.",
+ "type": "object",
+ "properties": {
+ "sensitiveAttribute": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "Sensitive field for computing the l-value."
+ },
+ "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": "GooglePrivacyDlpV2beta1BigQueryOptions"
+ "id": "GooglePrivacyDlpV2beta1LDiversityConfig"
+ },
+ "GooglePrivacyDlpV2beta1StorageConfig": {
+ "id": "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."
+ },
+ "bigQueryOptions": {
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions",
+ "description": "BigQuery options specification."
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1BigQueryOptions": {
+ "id": "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": {
+ "description": "Complete BigQuery table reference.",
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
+ }
+ }
},
"GooglePrivacyDlpV2beta1OperationConfig": {
+ "description": "Additional configuration for inspect long running operations.",
+ "type": "object",
"properties": {
"maxItemFindings": {
"description": "Max number of findings per file, Datastore entity, or database row.",
@@ -593,9 +649,7 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1OperationConfig",
- "description": "Additional configuration for inspect long running operations.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1OperationConfig"
},
"GooglePrivacyDlpV2beta1PrivacyMetric": {
"description": "Privacy metric to compute for reidentification risk analysis.",
@@ -620,20 +674,21 @@
"id": "GooglePrivacyDlpV2beta1PrivacyMetric"
},
"GooglePrivacyDlpV2beta1ReplaceConfig": {
+ "id": "GooglePrivacyDlpV2beta1ReplaceConfig",
"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."
- },
"replaceWith": {
"description": "Content replacing sensitive information of given type. Max 256 chars.",
"type": "string"
+ },
+ "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."
}
- },
- "id": "GooglePrivacyDlpV2beta1ReplaceConfig"
+ }
},
"GooglePrivacyDlpV2beta1LDiversityEquivalenceClass": {
+ "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass",
"description": "The set of columns' values that share the same l-diversity value.",
"type": "object",
"properties": {
@@ -661,45 +716,25 @@
"format": "int64",
"type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass"
+ }
},
"GooglePrivacyDlpV2beta1NumericalStatsConfig": {
+ "id": "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"
+ "$ref": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "Field to compute numerical stats on. Supported types are\ninteger, float, date, datetime, timestamp, time."
}
- },
- "id": "GooglePrivacyDlpV2beta1NumericalStatsConfig"
- },
- "GooglePrivacyDlpV2beta1DeidentificationSummary": {
- "description": "High level summary of deidentification.",
- "type": "object",
- "properties": {
- "transformedBytes": {
- "description": "Total size in bytes that were transformed in some way.",
- "format": "int64",
- "type": "string"
- },
- "transformationSummaries": {
- "description": "Transformations applied to the dataset.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1TransformationSummary"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1DeidentificationSummary"
+ }
},
"GooglePrivacyDlpV2beta1TimePartConfig": {
+ "id": "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]",
@@ -717,10 +752,10 @@
"DAY_OF_WEEK",
"WEEK_OF_YEAR",
"HOUR_OF_DAY"
- ]
+ ],
+ "type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1TimePartConfig"
+ }
},
"GooglePrivacyDlpV2beta1RecordCondition": {
"description": "A condition for determining whether a transformation should be applied to\na field.",
@@ -732,7 +767,29 @@
},
"id": "GooglePrivacyDlpV2beta1RecordCondition"
},
+ "GooglePrivacyDlpV2beta1DeidentificationSummary": {
+ "id": "GooglePrivacyDlpV2beta1DeidentificationSummary",
+ "description": "High level summary of deidentification.",
+ "type": "object",
+ "properties": {
+ "transformedBytes": {
+ "description": "Total size in bytes that were transformed in some way.",
+ "format": "int64",
+ "type": "string"
+ },
+ "transformationSummaries": {
+ "description": "Transformations applied to the dataset.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1TransformationSummary"
+ }
+ }
+ }
+ },
"GooglePrivacyDlpV2beta1ListInfoTypesResponse": {
+ "id": "GooglePrivacyDlpV2beta1ListInfoTypesResponse",
+ "description": "Response to the ListInfoTypes request.",
+ "type": "object",
"properties": {
"infoTypes": {
"description": "Set of sensitive info types belonging to a category.",
@@ -741,12 +798,11 @@
"$ref": "GooglePrivacyDlpV2beta1InfoTypeDescription"
}
}
- },
- "id": "GooglePrivacyDlpV2beta1ListInfoTypesResponse",
- "description": "Response to the ListInfoTypes request.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta1CloudStorageKey": {
+ "description": "Record key for a finding in a Cloud Storage file.",
+ "type": "object",
"properties": {
"filePath": {
"description": "Path to the file.",
@@ -758,12 +814,16 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1CloudStorageKey",
- "description": "Record key for a finding in a Cloud Storage file.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1CloudStorageKey"
},
"GooglePrivacyDlpV2beta1NumericalStatsResult": {
+ "description": "Result of the numerical stats computation.",
+ "type": "object",
"properties": {
+ "minValue": {
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "Minimum value appearing in the column."
+ },
"maxValue": {
"$ref": "GooglePrivacyDlpV2beta1Value",
"description": "Maximum value appearing in the column."
@@ -774,23 +834,17 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1Value"
}
- },
- "minValue": {
- "description": "Minimum value appearing in the column.",
- "$ref": "GooglePrivacyDlpV2beta1Value"
}
},
- "id": "GooglePrivacyDlpV2beta1NumericalStatsResult",
- "description": "Result of the numerical stats computation.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1NumericalStatsResult"
},
"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"
+ "$ref": "GooglePrivacyDlpV2beta1WordList",
+ "description": "List of words or phrases to search for."
}
},
"id": "GooglePrivacyDlpV2beta1Dictionary"
@@ -821,19 +875,19 @@
"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": "GooglePrivacyDlpV2beta1RecordSuppression"
- }
- },
"fieldTransformations": {
"description": "Transform the record by applying various field transformations.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1FieldTransformation"
}
+ },
+ "recordSuppressions": {
+ "description": "Configuration defining which records get suppressed entirely. Records that\nmatch any suppression rule are omitted from the output [optional].",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1RecordSuppression"
+ }
}
},
"id": "GooglePrivacyDlpV2beta1RecordTransformations"
@@ -842,18 +896,13 @@
"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.",
@@ -869,14 +918,7 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ],
- "description": "Only returns findings equal or above this threshold.",
- "type": "string"
- },
- "maxFindings": {
- "description": "Limits the number of findings per content item or long running operation.",
- "format": "int32",
- "type": "integer"
+ ]
},
"infoTypeLimits": {
"description": "Configuration of findings limit given for specified info types.",
@@ -885,6 +927,11 @@
"$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",
@@ -895,11 +942,19 @@
"includeQuote": {
"description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.",
"type": "boolean"
+ },
+ "customInfoTypes": {
+ "description": "Custom info types provided by the user.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1CustomInfoType"
+ }
}
},
"id": "GooglePrivacyDlpV2beta1InspectConfig"
},
"GooglePrivacyDlpV2beta1Projection": {
+ "id": "GooglePrivacyDlpV2beta1Projection",
"description": "A representation of a Datastore property in a projection.",
"type": "object",
"properties": {
@@ -907,8 +962,7 @@
"$ref": "GooglePrivacyDlpV2beta1PropertyReference",
"description": "The property to project."
}
- },
- "id": "GooglePrivacyDlpV2beta1Projection"
+ }
},
"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 '.",
@@ -917,15 +971,15 @@
"id": "GooglePrivacyDlpV2beta1RedactConfig"
},
"GooglePrivacyDlpV2beta1CryptoHashConfig": {
+ "id": "GooglePrivacyDlpV2beta1CryptoHashConfig",
"description": "Pseudonymization method that generates surrogates via cryptographic hashing.\nUses SHA-256.\nOutputs a 32 byte digest as an uppercase hex string\n(for example, 41D1567F7F99F1DC2A5FAB886DEE5BEE).\nCurrently, only string and integer values can be hashed.",
"type": "object",
"properties": {
"cryptoKey": {
- "$ref": "GooglePrivacyDlpV2beta1CryptoKey",
- "description": "The key used by the hash function."
+ "description": "The key used by the hash function.",
+ "$ref": "GooglePrivacyDlpV2beta1CryptoKey"
}
- },
- "id": "GooglePrivacyDlpV2beta1CryptoHashConfig"
+ }
},
"GooglePrivacyDlpV2beta1Key": {
"description": "A unique identifier for a Datastore entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
@@ -939,8 +993,8 @@
}
},
"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."
+ "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"
@@ -986,19 +1040,16 @@
"id": "GoogleTypeDate"
},
"GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig": {
+ "id": "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig",
"description": "Replace each matching finding with the name of the info_type.",
"type": "object",
- "properties": {},
- "id": "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig"
+ "properties": {}
},
"GooglePrivacyDlpV2beta1ImageRedactionConfig": {
+ "id": "GooglePrivacyDlpV2beta1ImageRedactionConfig",
"description": "Configuration for determining how redaction of images should occur.",
"type": "object",
"properties": {
- "redactionColor": {
- "description": "The color to use when redacting content from an image. If not specified,\nthe default is black.",
- "$ref": "GooglePrivacyDlpV2beta1Color"
- },
"redactAllText": {
"description": "If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted.",
"type": "boolean"
@@ -1006,55 +1057,59 @@
"infoType": {
"$ref": "GooglePrivacyDlpV2beta1InfoType",
"description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig."
+ },
+ "redactionColor": {
+ "description": "The color to use when redacting content from an image. If not specified,\nthe default is black.",
+ "$ref": "GooglePrivacyDlpV2beta1Color"
}
- },
- "id": "GooglePrivacyDlpV2beta1ImageRedactionConfig"
+ }
},
"GooglePrivacyDlpV2beta1Location": {
+ "id": "GooglePrivacyDlpV2beta1Location",
"description": "Specifies the location of the finding.",
"type": "object",
"properties": {
- "imageBoxes": {
- "description": "The area within the image that contained the finding.\nProvided when the content is an image.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ImageLocation"
- }
- },
"byteRange": {
- "$ref": "GooglePrivacyDlpV2beta1Range",
- "description": "Zero-based byte offsets delimiting the finding.\nThese are relative to the finding's containing element.\nNote that when the content is not textual, this references\nthe UTF-8 encoded textual representation of the content.\nOmitted if content is an image."
+ "description": "Zero-based byte offsets delimiting the finding.\nThese are relative to the finding's containing element.\nNote that when the content is not textual, this references\nthe UTF-8 encoded textual representation of the content.\nOmitted if content is an image.",
+ "$ref": "GooglePrivacyDlpV2beta1Range"
},
"recordKey": {
- "$ref": "GooglePrivacyDlpV2beta1RecordKey",
- "description": "The pointer to the record in storage that contained the field the\nfinding was found in.\nProvided when the finding's containing element is a property\nof a storage object."
+ "description": "The pointer to the record in storage that contained the field the\nfinding was found in.\nProvided when the finding's containing element is a property\nof a storage object.",
+ "$ref": "GooglePrivacyDlpV2beta1RecordKey"
},
"tableLocation": {
"description": "The pointer to the row of the table that contained the finding.\nProvided when the finding's containing element is a cell of a table.",
"$ref": "GooglePrivacyDlpV2beta1TableLocation"
},
"codepointRange": {
- "$ref": "GooglePrivacyDlpV2beta1Range",
- "description": "Unicode character offsets delimiting the finding.\nThese are relative to the finding's containing element.\nProvided when the content is text."
+ "description": "Unicode character offsets delimiting the finding.\nThese are relative to the finding's containing element.\nProvided when the content is text.",
+ "$ref": "GooglePrivacyDlpV2beta1Range"
},
"fieldId": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "The pointer to the property or cell that contained the finding.\nProvided when the finding's containing element is a cell in a table\nor a property of storage object."
+ "description": "The pointer to the property or cell that contained the finding.\nProvided when the finding's containing element is a cell in a table\nor a property of storage object.",
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ },
+ "imageBoxes": {
+ "description": "The area within the image that contained the finding.\nProvided when the content is an image.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ImageLocation"
+ }
}
- },
- "id": "GooglePrivacyDlpV2beta1Location"
+ }
},
"GooglePrivacyDlpV2beta1RecordSuppression": {
+ "description": "Configuration to suppress records whose suppression conditions evaluate to\ntrue.",
+ "type": "object",
"properties": {
"condition": {
"$ref": "GooglePrivacyDlpV2beta1RecordCondition"
}
},
- "id": "GooglePrivacyDlpV2beta1RecordSuppression",
- "description": "Configuration to suppress records whose suppression conditions evaluate to\ntrue.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1RecordSuppression"
},
"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": {
@@ -1062,10 +1117,11 @@
"$ref": "GooglePrivacyDlpV2beta1FieldId",
"description": "Composite key indicating which field contains the entity identifier."
}
- },
- "id": "GooglePrivacyDlpV2beta1EntityId"
+ }
},
"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]",
@@ -1073,9 +1129,7 @@
"type": "string"
}
},
- "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"
+ "id": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey"
},
"GooglePrivacyDlpV2beta1CustomInfoType": {
"description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.",
@@ -1086,8 +1140,8 @@
"description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types."
},
"dictionary": {
- "description": "Dictionary-based custom info type.",
- "$ref": "GooglePrivacyDlpV2beta1Dictionary"
+ "$ref": "GooglePrivacyDlpV2beta1Dictionary",
+ "description": "Dictionary-based custom info type."
},
"surrogateType": {
"description": "Surrogate info type.",
@@ -1097,9 +1151,14 @@
"id": "GooglePrivacyDlpV2beta1CustomInfoType"
},
"GooglePrivacyDlpV2beta1InfoTypeDescription": {
+ "id": "GooglePrivacyDlpV2beta1InfoTypeDescription",
"description": "Description of the information type (infoType).",
"type": "object",
"properties": {
+ "name": {
+ "description": "Internal name of the infoType.",
+ "type": "string"
+ },
"displayName": {
"description": "Human readable form of the infoType name.",
"type": "string"
@@ -1110,16 +1169,17 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1CategoryDescription"
}
- },
- "name": {
- "description": "Internal name of the infoType.",
- "type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1InfoTypeDescription"
+ }
},
"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": {
+ "description": "Auxiliary table location. [required]",
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
+ },
"quasiIds": {
"description": "Quasi-identifier columns. [required]",
"type": "array",
@@ -1130,34 +1190,19 @@
"relativeFrequency": {
"description": "The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero.\n[required]",
"$ref": "GooglePrivacyDlpV2beta1FieldId"
- },
- "table": {
- "description": "Auxiliary table location. [required]",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
}
},
- "id": "GooglePrivacyDlpV2beta1AuxiliaryTable",
- "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"
- },
- "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"
+ "id": "GooglePrivacyDlpV2beta1AuxiliaryTable"
},
"GoogleRpcStatus": {
+ "id": "GoogleRpcStatus",
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "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",
@@ -1173,37 +1218,51 @@
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
}
- },
- "id": "GoogleRpcStatus"
+ }
+ },
+ "GooglePrivacyDlpV2beta1KMapEstimationResult": {
+ "id": "GooglePrivacyDlpV2beta1KMapEstimationResult",
+ "description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.",
+ "type": "object",
+ "properties": {
+ "kMapEstimationHistogram": {
+ "description": "The intervals [min_anonymity, max_anonymity] do not overlap. If a value\ndoesn't correspond to any such interval, the associated frequency is\nzero. For example, the following records:\n {min_anonymity: 1, max_anonymity: 1, frequency: 17}\n {min_anonymity: 2, max_anonymity: 3, frequency: 42}\n {min_anonymity: 5, max_anonymity: 10, frequency: 99}\nmean that there are no record with an estimated anonymity of 4, 5, or\nlarger than 10.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket"
+ }
+ }
+ }
},
"GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues": {
+ "id": "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"
}
+ },
+ "estimatedAnonymity": {
+ "description": "The estimated anonymity for these quasi-identifier values.",
+ "format": "int64",
+ "type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues",
- "description": "A tuple of values for the quasi-identifier columns.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta1PathElement": {
"description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
"type": "object",
"properties": {
+ "id": {
+ "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
+ "format": "int64",
+ "type": "string"
+ },
"name": {
"description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
"type": "string"
@@ -1211,11 +1270,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": "GooglePrivacyDlpV2beta1PathElement"
@@ -1224,10 +1278,6 @@
"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"
@@ -1244,6 +1294,10 @@
"ERROR"
],
"type": "string"
+ },
+ "details": {
+ "description": "A place for warnings or errors to show up if a transformation didn't\nwork as expected.",
+ "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta1SummaryResult"
@@ -1252,6 +1306,10 @@
"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"
@@ -1259,10 +1317,6 @@
"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"
@@ -1296,15 +1350,15 @@
"id": "GooglePrivacyDlpV2beta1InfoTypeTransformations"
},
"GooglePrivacyDlpV2beta1KindExpression": {
+ "id": "GooglePrivacyDlpV2beta1KindExpression",
+ "description": "A representation of a Datastore kind.",
+ "type": "object",
"properties": {
"name": {
"description": "The name of the kind.",
"type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1KindExpression",
- "description": "A representation of a Datastore kind.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta1FileSet": {
"description": "Set of files to scan.",
@@ -1317,40 +1371,60 @@
},
"id": "GooglePrivacyDlpV2beta1FileSet"
},
- "GooglePrivacyDlpV2beta1InfoTypeTransformation": {
+ "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest": {
+ "id": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest",
+ "description": "Request for creating a risk analysis operation.",
+ "type": "object",
"properties": {
- "primitiveTransformation": {
- "description": "Primitive transformation to apply to the info type. [required]",
- "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation"
+ "sourceTable": {
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
+ "description": "Input dataset to compute metrics over."
},
+ "privacyMetric": {
+ "description": "Privacy metric to compute.",
+ "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1InfoTypeTransformation": {
+ "id": "GooglePrivacyDlpV2beta1InfoTypeTransformation",
+ "description": "A transformation to apply to text that is identified as a specific\ninfo_type.",
+ "type": "object",
+ "properties": {
"infoTypes": {
"description": "Info types to apply the transformation to. Empty list will match all\navailable info types for this transformation.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1InfoType"
}
+ },
+ "primitiveTransformation": {
+ "description": "Primitive transformation to apply to the info type. [required]",
+ "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation"
}
- },
- "id": "GooglePrivacyDlpV2beta1InfoTypeTransformation",
- "description": "A transformation to apply to text that is identified as a specific\ninfo_type.",
- "type": "object"
+ }
},
- "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest": {
- "description": "Request for creating a risk analysis operation.",
+ "GooglePrivacyDlpV2beta1Bucket": {
+ "description": "Buckets represented as ranges, along with replacement values. Ranges must\nbe non-overlapping.",
"type": "object",
"properties": {
- "sourceTable": {
- "description": "Input dataset to compute metrics over.",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
+ "min": {
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused."
},
- "privacyMetric": {
- "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric",
- "description": "Privacy metric to compute."
+ "max": {
+ "description": "Upper bound of the range, exclusive; type must match min.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
+ },
+ "replacementValue": {
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range."
}
},
- "id": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest"
+ "id": "GooglePrivacyDlpV2beta1Bucket"
},
"GooglePrivacyDlpV2beta1KAnonymityResult": {
+ "id": "GooglePrivacyDlpV2beta1KAnonymityResult",
"description": "Result of the k-anonymity computation.",
"type": "object",
"properties": {
@@ -1361,30 +1435,18 @@
"$ref": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket"
}
}
- },
- "id": "GooglePrivacyDlpV2beta1KAnonymityResult"
- },
- "GooglePrivacyDlpV2beta1Bucket": {
- "description": "Buckets represented as ranges, along with replacement values. Ranges must\nbe non-overlapping.",
- "type": "object",
- "properties": {
- "min": {
- "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused.",
- "$ref": "GooglePrivacyDlpV2beta1Value"
- },
- "max": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Upper bound of the range, exclusive; type must match min."
- },
- "replacementValue": {
- "description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range.",
- "$ref": "GooglePrivacyDlpV2beta1Value"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Bucket"
+ }
},
"GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket": {
+ "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",
@@ -1401,18 +1463,11 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1ValueFrequency"
}
- },
- "bucketSize": {
- "description": "Total number of records in this bucket.",
- "format": "int64",
- "type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket",
- "description": "Histogram bucket of value frequencies in the column.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta1TableLocation": {
+ "id": "GooglePrivacyDlpV2beta1TableLocation",
"description": "Location of a finding within a table.",
"type": "object",
"properties": {
@@ -1421,10 +1476,10 @@
"format": "int64",
"type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1TableLocation"
+ }
},
"GooglePrivacyDlpV2beta1DatastoreKey": {
+ "id": "GooglePrivacyDlpV2beta1DatastoreKey",
"description": "Record key for a finding in Cloud Datastore.",
"type": "object",
"properties": {
@@ -1432,28 +1487,28 @@
"description": "Datastore entity key.",
"$ref": "GooglePrivacyDlpV2beta1Key"
}
- },
- "id": "GooglePrivacyDlpV2beta1DatastoreKey"
+ }
},
"GooglePrivacyDlpV2beta1KAnonymityConfig": {
+ "id": "GooglePrivacyDlpV2beta1KAnonymityConfig",
+ "description": "k-anonymity metric, used for analysis of reidentification risk.",
+ "type": "object",
"properties": {
+ "entityId": {
+ "description": "Optional message indicating that each distinct entity_id should not\ncontribute to the k-anonymity count more than once per equivalence class.\nIf an entity_id appears on several rows with different quasi-identifier\ntuples, it will contribute to each count exactly once.\n\nThis can lead to unexpected results. Consider a table where ID 1 is\nassociated to quasi-identifier \"foo\", ID 2 to \"bar\", and ID 3 to *both*\nquasi-identifiers \"foo\" and \"bar\" (on separate rows), and where this ID\nis used as entity_id. Then, the anonymity value associated to ID 3 will\nbe 2, even if it is the only ID to be associated to both values \"foo\" and\n\"bar\".",
+ "$ref": "GooglePrivacyDlpV2beta1EntityId"
+ },
"quasiIds": {
"description": "Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1FieldId"
}
- },
- "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\"."
}
- },
- "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": {
@@ -1463,10 +1518,10 @@
"datastoreKey": {
"$ref": "GooglePrivacyDlpV2beta1DatastoreKey"
}
- },
- "id": "GooglePrivacyDlpV2beta1RecordKey"
+ }
},
"GooglePrivacyDlpV2beta1DeidentifyContentRequest": {
+ "id": "GooglePrivacyDlpV2beta1DeidentifyContentRequest",
"description": "Request to de-identify a list of items.",
"type": "object",
"properties": {
@@ -1475,8 +1530,8 @@
"$ref": "GooglePrivacyDlpV2beta1DeidentifyConfig"
},
"inspectConfig": {
- "description": "Configuration for the inspector.",
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
+ "description": "Configuration for the inspector."
},
"items": {
"description": "The list of items to inspect. Up to 100 are allowed per request.\nAll items will be treated as text/*.",
@@ -1485,10 +1540,10 @@
"$ref": "GooglePrivacyDlpV2beta1ContentItem"
}
}
- },
- "id": "GooglePrivacyDlpV2beta1DeidentifyContentRequest"
+ }
},
"GooglePrivacyDlpV2beta1InspectResult": {
+ "id": "GooglePrivacyDlpV2beta1InspectResult",
"description": "All the findings for a single scanned item.",
"type": "object",
"properties": {
@@ -1503,10 +1558,11 @@
"description": "If true, then this item might have more findings than were returned,\nand the findings returned are an arbitrary subset of all findings.\nThe findings list might be truncated because the input items were too\nlarge, or because the server reached the maximum amount of resources\nallowed for a single API call. For best results, divide the input into\nsmaller batches.",
"type": "boolean"
}
- },
- "id": "GooglePrivacyDlpV2beta1InspectResult"
+ }
},
"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"
@@ -1515,17 +1571,12 @@
"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"
+ "id": "GooglePrivacyDlpV2beta1QuasiIdField"
},
"GooglePrivacyDlpV2beta1ImageLocation": {
+ "description": "Bounding box encompassing detected text within an image.",
+ "type": "object",
"properties": {
- "width": {
- "description": "Width of the bounding box in pixels.",
- "format": "int32",
- "type": "integer"
- },
"height": {
"description": "Height of the bounding box in pixels.",
"format": "int32",
@@ -1540,11 +1591,14 @@
"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",
- "description": "Bounding box encompassing detected text within an image.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1ImageLocation"
},
"GooglePrivacyDlpV2beta1ReplaceValueConfig": {
"description": "Replace each input value with a given `Value`.",
@@ -1561,6 +1615,10 @@
"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"
@@ -1573,21 +1631,30 @@
"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"
},
"GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig": {
+ "id": "GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig",
"description": "Replaces an identifier with a surrogate using FPE with the FFX\nmode of operation.\nThe identifier must be representable by the US-ASCII character set.\nFor a given crypto key and context, the same identifier will be\nreplaced with the same surrogate.\nIdentifiers must be at least two characters long.\nIn the case that the identifier is the empty string, it will be skipped.",
"type": "object",
"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": {
- "description": "The custom info type to annotate the surrogate with.\nThis annotation will be applied to the surrogate by prefixing it with\nthe name of the custom info type followed by the number of\ncharacters comprising the surrogate. The following scheme defines the\nformat: info_type_name(surrogate_character_count):surrogate\n\nFor example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and\nthe surrogate is 'abc', the full replacement value\nwill be: 'MY_TOKEN_INFO_TYPE(3):abc'\n\nThis annotation identifies the surrogate when inspecting content using the\ncustom info type\n[`SurrogateType`](/dlp/docs/reference/rest/v2beta1/InspectConfig#surrogatetype).\nThis facilitates reversal of the surrogate when it occurs in free text.\n\nIn order for inspection to work properly, the name of this info type must\nnot occur naturally anywhere in your data; otherwise, inspection may\nfind a surrogate that does not correspond to an actual identifier.\nTherefore, choose your custom info type name carefully after considering\nwhat your data looks like. One way to select a name that has a high chance\nof yielding reliable detection is to include one or more unicode characters\nthat are highly improbable to exist in your data.\nFor example, assuming your data is entered from a regular ASCII keyboard,\nthe symbol with the hex code point 29DD might be used like so:\n⧝MY_TOKEN_TYPE",
- "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ "$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",
@@ -1610,23 +1677,11 @@
"description": "The native way to select the alphabet. Must be in the range [2, 62].",
"format": "int32",
"type": "integer"
- },
- "customAlphabet": {
- "description": "This is supported by mapping these to the alphanumeric characters\nthat the FFX mode natively supports. This happens before/after\nencryption/decryption.\nEach character listed must appear only once.\nNumber of characters must be in the range [2, 62].\nThis must be encoded as ASCII.\nThe order of characters does not matter.",
- "type": "string"
- },
- "cryptoKey": {
- "$ref": "GooglePrivacyDlpV2beta1CryptoKey",
- "description": "The key used by the encryption algorithm. [required]"
- },
- "context": {
- "$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."
}
- },
- "id": "GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig"
+ }
},
"GooglePrivacyDlpV2beta1Color": {
+ "id": "GooglePrivacyDlpV2beta1Color",
"description": "Represents a color in the RGB color space.",
"type": "object",
"properties": {
@@ -1645,30 +1700,7 @@
"format": "float",
"type": "number"
}
- },
- "id": "GooglePrivacyDlpV2beta1Color"
- },
- "GooglePrivacyDlpV2beta1ValueFrequency": {
- "description": "A value of a field, including its frequency.",
- "type": "object",
- "properties": {
- "value": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "A value contained in the field in question."
- },
- "count": {
- "description": "How many times the value is contained in the field.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1ValueFrequency"
- },
- "GooglePrivacyDlpV2beta1SurrogateType": {
- "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": {
"description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed.",
@@ -1689,23 +1721,32 @@
},
"id": "GooglePrivacyDlpV2beta1Table"
},
- "GooglePrivacyDlpV2beta1InfoTypeLimit": {
- "description": "Max findings configuration per info type, per content item or long running\noperation.",
+ "GooglePrivacyDlpV2beta1SurrogateType": {
+ "id": "GooglePrivacyDlpV2beta1SurrogateType",
+ "description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.",
+ "type": "object",
+ "properties": {}
+ },
+ "GooglePrivacyDlpV2beta1ValueFrequency": {
+ "id": "GooglePrivacyDlpV2beta1ValueFrequency",
+ "description": "A value of a field, including its frequency.",
"type": "object",
"properties": {
- "maxFindings": {
- "description": "Max findings limit for the given infoType.",
- "format": "int32",
- "type": "integer"
+ "count": {
+ "description": "How many times the value is contained in the field.",
+ "format": "int64",
+ "type": "string"
},
- "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."
+ "value": {
+ "description": "A value contained in the field in question.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
}
- },
- "id": "GooglePrivacyDlpV2beta1InfoTypeLimit"
+ }
},
"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": {
"unwrapped": {
"$ref": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey"
@@ -1716,12 +1757,26 @@
"kmsWrapped": {
"$ref": "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey"
}
- },
- "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"
+ }
+ },
+ "GooglePrivacyDlpV2beta1InfoTypeLimit": {
+ "id": "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"
+ }
+ }
},
"GooglePrivacyDlpV2beta1LDiversityHistogramBucket": {
+ "id": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket",
"description": "Histogram bucket of sensitive value frequencies in the table.",
"type": "object",
"properties": {
@@ -1747,11 +1802,26 @@
"$ref": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass"
}
}
- },
- "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": {
+ "booleanValue": {
+ "type": "boolean"
+ },
+ "floatValue": {
+ "format": "double",
+ "type": "number"
+ },
+ "integerValue": {
+ "format": "int64",
+ "type": "string"
+ },
+ "timeValue": {
+ "$ref": "GoogleTypeTimeOfDay"
+ },
"stringValue": {
"type": "string"
},
@@ -1761,33 +1831,33 @@
"timestampValue": {
"format": "google-datetime",
"type": "string"
- },
- "booleanValue": {
- "type": "boolean"
- },
- "floatValue": {
- "format": "double",
- "type": "number"
- },
- "timeValue": {
- "$ref": "GoogleTypeTimeOfDay"
- },
- "integerValue": {
- "format": "int64",
- "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1Value",
- "description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.",
- "type": "object"
+ "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": {
+ "value": {
+ "description": "Value to compare against. [Required, except for `EXISTS` tests.]",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
+ },
"field": {
- "description": "Field within the record this condition is evaluated against. [required]",
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ "$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",
@@ -1799,41 +1869,25 @@
"EXISTS"
],
"description": "Operator used to compare the field or info type to the value. [required]",
- "type": "string",
- "enumDescriptions": [
- "",
- "Equal.",
- "Not equal to.",
- "Greater than.",
- "Less than.",
- "Greater than or equals.",
- "Less than or equals.",
- "Exists"
- ]
- },
- "value": {
- "description": "Value to compare against. [Required, except for `EXISTS` tests.]",
- "$ref": "GooglePrivacyDlpV2beta1Value"
+ "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1Condition",
- "description": "The field type of `value` and `field` do not need to match to be\nconsidered equal, but not all comparisons are possible.\n\nA `value` of type:\n\n- `string` can be compared against all other types\n- `boolean` can only be compared against other booleans\n- `integer` can be compared against doubles or a string if the string value\ncan be parsed as an integer.\n- `double` can be compared against integers or a string if the string can\nbe parsed as a double.\n- `Timestamp` can be compared against strings in RFC 3339 date string\nformat.\n- `TimeOfDay` can be compared against timestamps and strings in the format\nof 'HH:mm:ss'.\n\nIf we fail to compare do to type mismatch, a warning will be given and\nthe condition will evaluate to false.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1Condition"
},
"GooglePrivacyDlpV2beta1PartitionId": {
+ "id": "GooglePrivacyDlpV2beta1PartitionId",
"description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.",
"type": "object",
"properties": {
- "namespaceId": {
- "description": "If not empty, the ID of the namespace to which the entities belong.",
- "type": "string"
- },
"projectId": {
"description": "The ID of the project to which the entities belong.",
"type": "string"
+ },
+ "namespaceId": {
+ "description": "If not empty, the ID of the namespace to which the entities belong.",
+ "type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1PartitionId"
+ }
},
"GooglePrivacyDlpV2beta1InspectContentResponse": {
"description": "Results of inspecting a list of items.",
@@ -1853,6 +1907,13 @@
"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": {
+ "imageRedactionConfigs": {
+ "description": "The configuration for specifying what content to redact from images.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ImageRedactionConfig"
+ }
+ },
"inspectConfig": {
"description": "Configuration for the inspector.",
"$ref": "GooglePrivacyDlpV2beta1InspectConfig"
@@ -1870,13 +1931,6 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1ReplaceConfig"
}
- },
- "imageRedactionConfigs": {
- "description": "The configuration for specifying what content to redact from images.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ImageRedactionConfig"
- }
}
},
"id": "GooglePrivacyDlpV2beta1RedactContentRequest"
@@ -1896,6 +1950,7 @@
"id": "GooglePrivacyDlpV2beta1WordList"
},
"GooglePrivacyDlpV2beta1FieldId": {
+ "id": "GooglePrivacyDlpV2beta1FieldId",
"description": "General identifier of a data field in a storage service.",
"type": "object",
"properties": {
@@ -1903,18 +1958,20 @@
"description": "Name describing the field.",
"type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1FieldId"
+ }
},
"GooglePrivacyDlpV2beta1TransformationSummary": {
+ "id": "GooglePrivacyDlpV2beta1TransformationSummary",
+ "description": "Summary of a single tranformation.\nOnly one of 'transformation', 'field_transformation', or 'record_suppress'\nwill be set.",
+ "type": "object",
"properties": {
"infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "Set if the transformation was limited to a specific info_type."
+ "description": "Set if the transformation was limited to a specific info_type.",
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
},
"transformation": {
- "description": "The specific transformation these stats apply to.",
- "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation"
+ "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation",
+ "description": "The specific transformation these stats apply to."
},
"results": {
"type": "array",
@@ -1923,8 +1980,8 @@
}
},
"field": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "Set if the transformation was limited to a specific FieldId."
+ "description": "Set if the transformation was limited to a specific FieldId.",
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
},
"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.",
@@ -1942,21 +1999,26 @@
"$ref": "GooglePrivacyDlpV2beta1RecordSuppression",
"description": "The specific suppression option these stats apply to."
}
- },
- "id": "GooglePrivacyDlpV2beta1TransformationSummary",
- "description": "Summary of a single tranformation.\nOnly one of 'transformation', 'field_transformation', or 'record_suppress'\nwill be set.",
- "type": "object"
+ }
},
"GoogleLongrunningCancelOperationRequest": {
+ "id": "GoogleLongrunningCancelOperationRequest",
"description": "The request message for Operations.CancelOperation.",
"type": "object",
- "properties": {},
- "id": "GoogleLongrunningCancelOperationRequest"
+ "properties": {}
},
"GooglePrivacyDlpV2beta1CharacterMaskConfig": {
+ "id": "GooglePrivacyDlpV2beta1CharacterMaskConfig",
"description": "Partially mask a string by replacing a given number of characters with a\nfixed character. Masking can start from the beginning or end of the string.\nThis can be used on data of any type (numbers, longs, and so on) and when\nde-identifying structured data we'll attempt to preserve the original data's\ntype. (This allows you to take a long like 123 and modify it to a string like\n**3.",
"type": "object",
"properties": {
+ "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"
@@ -1969,18 +2031,11 @@
"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"
- }
}
- },
- "id": "GooglePrivacyDlpV2beta1CharacterMaskConfig"
+ }
},
"GooglePrivacyDlpV2beta1TransientCryptoKey": {
+ "id": "GooglePrivacyDlpV2beta1TransientCryptoKey",
"description": "Use this to have a random data crypto key generated.\nIt will be discarded after the operation/request finishes.",
"type": "object",
"properties": {
@@ -1988,17 +2043,13 @@
"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": {
+ "id": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest",
"description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
"type": "object",
"properties": {
- "storageConfig": {
- "description": "Specification of the data set to process.",
- "$ref": "GooglePrivacyDlpV2beta1StorageConfig"
- },
"outputConfig": {
"$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig",
"description": "Optional location to store findings."
@@ -2008,20 +2059,20 @@
"$ref": "GooglePrivacyDlpV2beta1OperationConfig"
},
"inspectConfig": {
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
- "description": "Configuration for the inspector."
+ "description": "Configuration for the inspector.",
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
+ },
+ "storageConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1StorageConfig",
+ "description": "Specification of the data set to process."
}
- },
- "id": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest"
+ }
},
"GooglePrivacyDlpV2beta1TaggedField": {
+ "id": "GooglePrivacyDlpV2beta1TaggedField",
"description": "A column with a semantic tag attached.",
"type": "object",
"properties": {
- "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"
@@ -2031,29 +2082,17 @@
"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"
- }
- },
- "id": "GooglePrivacyDlpV2beta1TaggedField"
- },
- "GooglePrivacyDlpV2beta1InfoTypeStatistics": {
- "properties": {
- "infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "The type of finding this stat is for."
+ "description": "If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data",
+ "$ref": "GoogleProtobufEmpty"
},
- "count": {
- "description": "Number of findings for this info type.",
- "format": "int64",
- "type": "string"
+ "field": {
+ "description": "Identifies the column. [required]",
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
}
- },
- "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics",
- "description": "Statistics regarding a specific InfoType.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta1RedactContentResponse": {
+ "id": "GooglePrivacyDlpV2beta1RedactContentResponse",
"description": "Results of redacting a list of items.",
"type": "object",
"properties": {
@@ -2064,42 +2103,42 @@
"$ref": "GooglePrivacyDlpV2beta1ContentItem"
}
}
- },
- "id": "GooglePrivacyDlpV2beta1RedactContentResponse"
+ }
+ },
+ "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"
+ }
+ }
},
"GooglePrivacyDlpV2beta1PropertyReference": {
+ "id": "GooglePrivacyDlpV2beta1PropertyReference",
+ "description": "A reference to a property relative to the Datastore kind expressions.",
+ "type": "object",
"properties": {
"name": {
"description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
"type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1PropertyReference",
- "description": "A reference to a property relative to the Datastore kind expressions.",
- "type": "object"
- },
- "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"
- }
- },
- "id": "GooglePrivacyDlpV2beta1OutputStorageConfig"
+ }
},
"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"
+ "$ref": "GooglePrivacyDlpV2beta1RecordCondition",
+ "description": "Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85."
},
"infoTypeTransformations": {
"$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformations",
@@ -2119,7 +2158,24 @@
},
"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": {
+ "description": "Store findings in a new table in the dataset.",
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
+ }
+ }
+ },
"GooglePrivacyDlpV2beta1BucketingConfig": {
+ "description": "Generalization function that buckets values based on ranges. The ranges and\nreplacement values are dynamically provided by the user for custom behavior,\nsuch as 1-30 -\u003e LOW 31-65 -\u003e MEDIUM 66-100 -\u003e HIGH\nThis can be used on\ndata of type: number, long, string, timestamp.\nIf the bound `Value` type differs from the type of data being transformed, we\nwill first attempt converting the type of the data to be transformed to match\nthe type of the bound before comparing.",
+ "type": "object",
"properties": {
"buckets": {
"type": "array",
@@ -2128,11 +2184,10 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta1BucketingConfig",
- "description": "Generalization function that buckets values based on ranges. The ranges and\nreplacement values are dynamically provided by the user for custom behavior,\nsuch as 1-30 -\u003e LOW 31-65 -\u003e MEDIUM 66-100 -\u003e HIGH\nThis can be used on\ndata of type: number, long, string, timestamp.\nIf the bound `Value` type differs from the type of data being transformed, we\nwill first attempt converting the type of the data to be transformed to match\nthe type of the bound before comparing.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1BucketingConfig"
},
"GooglePrivacyDlpV2beta1DeidentifyContentResponse": {
+ "id": "GooglePrivacyDlpV2beta1DeidentifyContentResponse",
"description": "Results of de-identifying a list of items.",
"type": "object",
"properties": {
@@ -2149,8 +2204,7 @@
"$ref": "GooglePrivacyDlpV2beta1ContentItem"
}
}
- },
- "id": "GooglePrivacyDlpV2beta1DeidentifyContentResponse"
+ }
},
"GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass": {
"description": "The set of columns' values that share the same k-anonymity value.",
@@ -2172,17 +2226,10 @@
"id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass"
},
"GoogleLongrunningOperation": {
+ "id": "GoogleLongrunningOperation",
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
- "response": {
- "description": "This field will contain an InspectOperationResult object for `inspect.operations.create` or a RiskAnalysisOperationResult object for `dataSource.analyze`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
"name": {
"description": "The server-assigned name. The `name` should have the format of `inspect/operations/\u003cidentifier\u003e`.",
"type": "string"
@@ -2192,37 +2239,31 @@
"$ref": "GoogleRpcStatus"
},
"metadata": {
+ "description": "This field will contain an InspectOperationMetadata object for `inspect.operations.create` or a RiskAnalysisOperationMetadata object for `dataSource.analyze`. This will always be returned with the Operation.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "This field will contain an InspectOperationMetadata object for `inspect.operations.create` or a RiskAnalysisOperationMetadata object for `dataSource.analyze`. This will always be returned with the Operation.",
- "type": "object"
+ }
},
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
- }
- },
- "id": "GoogleLongrunningOperation"
- },
- "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": {
- "description": "The resource name of the KMS CryptoKey to use for unwrapping. [required]",
- "type": "string"
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "This field will contain an InspectOperationResult object for `inspect.operations.create` or a RiskAnalysisOperationResult object for `dataSource.analyze`.",
+ "type": "object"
}
- },
- "id": "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey"
+ }
},
"GooglePrivacyDlpV2beta1InspectOperationMetadata": {
+ "id": "GooglePrivacyDlpV2beta1InspectOperationMetadata",
+ "description": "Metadata returned within GetOperation for an inspect request.",
+ "type": "object",
"properties": {
"requestStorageConfig": {
"description": "The storage config used to create the Operation.",
@@ -2245,8 +2286,8 @@
"type": "string"
},
"requestInspectConfig": {
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
- "description": "The inspect config used to create the Operation."
+ "description": "The inspect config used to create the Operation.",
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
},
"requestOutputConfig": {
"description": "Optional location to store findings.",
@@ -2257,41 +2298,34 @@
"format": "google-datetime",
"type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1InspectOperationMetadata",
- "description": "Metadata returned within GetOperation for an inspect request.",
- "type": "object"
+ }
+ },
+ "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey": {
+ "id": "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey",
+ "description": "Include to use an existing data crypto key wrapped by KMS.\nAuthorization requires the following IAM permissions when sending a request\nto perform a crypto transformation using a kms-wrapped crypto key:\ndlp.kms.encrypt",
+ "type": "object",
+ "properties": {
+ "cryptoKeyName": {
+ "description": "The resource name of the KMS CryptoKey to use for unwrapping. [required]",
+ "type": "string"
+ },
+ "wrappedKey": {
+ "description": "The wrapped data crypto key. [required]",
+ "format": "byte",
+ "type": "string"
+ }
+ }
},
"GooglePrivacyDlpV2beta1InfoType": {
+ "id": "GooglePrivacyDlpV2beta1InfoType",
+ "description": "Type of information detected by the API.",
+ "type": "object",
"properties": {
"name": {
"description": "Name of the information type.",
"type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1InfoType",
- "description": "Type of information detected by the API.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig": {
- "description": "Buckets values based on fixed size ranges. The\nBucketing transformation can provide all of this functionality,\nbut requires more configuration. This message is provided as a convenience to\nthe user for simple bucketing strategies.\nThe resulting value will be a hyphenated string of\nlower_bound-upper_bound.\nThis can be used on data of type: double, long.\nIf the bound Value type differs from the type of data\nbeing transformed, we will first attempt converting the type of the data to\nbe transformed to match the type of the bound before comparing.",
- "type": "object",
- "properties": {
- "lowerBound": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Lower bound value of buckets. All values less than `lower_bound` are\ngrouped together into a single bucket; for example if `lower_bound` = 10,\nthen all values less than 10 are replaced with the value “-10”. [Required]."
- },
- "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": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Upper bound value of buckets. All values greater than upper_bound are\ngrouped together into a single bucket; for example if `upper_bound` = 89,\nthen all values greater than 89 are replaced with the value “89+”.\n[Required]."
- }
- },
- "id": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig"
+ }
},
"GooglePrivacyDlpV2beta1CharsToIgnore": {
"description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.",
@@ -2301,6 +2335,7 @@
"type": "string"
},
"commonCharactersToIgnore": {
+ "type": "string",
"enumDescriptions": [
"",
"0-9",
@@ -2316,22 +2351,36 @@
"ALPHA_LOWER_CASE",
"PUNCTUATION",
"WHITESPACE"
- ],
- "type": "string"
+ ]
}
},
"id": "GooglePrivacyDlpV2beta1CharsToIgnore"
},
+ "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig": {
+ "id": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig",
+ "description": "Buckets values based on fixed size ranges. The\nBucketing transformation can provide all of this functionality,\nbut requires more configuration. This message is provided as a convenience to\nthe user for simple bucketing strategies.\nThe resulting value will be a hyphenated string of\nlower_bound-upper_bound.\nThis can be used on data of type: double, long.\nIf the bound Value type differs from the type of data\nbeing transformed, we will first attempt converting the type of the data to\nbe transformed to match the type of the bound before comparing.",
+ "type": "object",
+ "properties": {
+ "upperBound": {
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "Upper bound value of buckets. All values greater than upper_bound are\ngrouped together into a single bucket; for example if `upper_bound` = 89,\nthen all values greater than 89 are replaced with the value “89+”.\n[Required]."
+ },
+ "lowerBound": {
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "Lower bound value of buckets. All values less than `lower_bound` are\ngrouped together into a single bucket; for example if `lower_bound` = 10,\nthen all values less than 10 are replaced with the value “-10”. [Required]."
+ },
+ "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"
+ }
+ }
+ },
"GooglePrivacyDlpV2beta1RiskAnalysisOperationResult": {
+ "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult",
"description": "Result of a risk analysis\n[`Operation`](/dlp/docs/reference/rest/v2beta1/inspect.operations)\nrequest.",
"type": "object",
"properties": {
- "numericalStatsResult": {
- "$ref": "GooglePrivacyDlpV2beta1NumericalStatsResult"
- },
- "kMapEstimationResult": {
- "$ref": "GooglePrivacyDlpV2beta1KMapEstimationResult"
- },
"kAnonymityResult": {
"$ref": "GooglePrivacyDlpV2beta1KAnonymityResult"
},
@@ -2340,9 +2389,29 @@
},
"categoricalStatsResult": {
"$ref": "GooglePrivacyDlpV2beta1CategoricalStatsResult"
+ },
+ "numericalStatsResult": {
+ "$ref": "GooglePrivacyDlpV2beta1NumericalStatsResult"
+ },
+ "kMapEstimationResult": {
+ "$ref": "GooglePrivacyDlpV2beta1KMapEstimationResult"
}
- },
- "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult"
+ }
+ },
+ "GooglePrivacyDlpV2beta1CategoryDescription": {
+ "id": "GooglePrivacyDlpV2beta1CategoryDescription",
+ "description": "Info Type Category description.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Internal name of the category.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Human readable form of the category name.",
+ "type": "string"
+ }
+ }
},
"GooglePrivacyDlpV2beta1Conditions": {
"type": "object",
@@ -2356,34 +2425,11 @@
},
"id": "GooglePrivacyDlpV2beta1Conditions"
},
- "GooglePrivacyDlpV2beta1CategoryDescription": {
- "description": "Info Type Category description.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Internal name of the category.",
- "type": "string"
- },
- "displayName": {
- "description": "Human readable form of the category name.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1CategoryDescription"
- },
"GooglePrivacyDlpV2beta1PrimitiveTransformation": {
+ "id": "GooglePrivacyDlpV2beta1PrimitiveTransformation",
"description": "A rule for transforming a value.",
"type": "object",
"properties": {
- "timePartConfig": {
- "$ref": "GooglePrivacyDlpV2beta1TimePartConfig"
- },
- "fixedSizeBucketingConfig": {
- "$ref": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig"
- },
- "characterMaskConfig": {
- "$ref": "GooglePrivacyDlpV2beta1CharacterMaskConfig"
- },
"redactConfig": {
"$ref": "GooglePrivacyDlpV2beta1RedactConfig"
},
@@ -2401,22 +2447,76 @@
},
"replaceConfig": {
"$ref": "GooglePrivacyDlpV2beta1ReplaceValueConfig"
+ },
+ "fixedSizeBucketingConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig"
+ },
+ "timePartConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1TimePartConfig"
+ },
+ "characterMaskConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1CharacterMaskConfig"
}
- },
- "id": "GooglePrivacyDlpV2beta1PrimitiveTransformation"
+ }
},
"GooglePrivacyDlpV2beta1CategoricalStatsConfig": {
+ "id": "GooglePrivacyDlpV2beta1CategoricalStatsConfig",
+ "description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.",
+ "type": "object",
"properties": {
"field": {
"description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data.",
"$ref": "GooglePrivacyDlpV2beta1FieldId"
}
+ }
+ },
+ "GooglePrivacyDlpV2beta1Finding": {
+ "description": "Represents a piece of potentially sensitive content.",
+ "type": "object",
+ "properties": {
+ "likelihood": {
+ "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."
+ ],
+ "enum": [
+ "LIKELIHOOD_UNSPECIFIED",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ]
+ },
+ "infoType": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoType",
+ "description": "The type of content that might have been found.\nProvided if requested by the `InspectConfig`."
+ },
+ "createTime": {
+ "description": "Timestamp when finding was detected.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "quote": {
+ "description": "The content that was found. Even if the content is not textual, it\nmay be converted to a textual representation here.\nProvided if requested by the `InspectConfig`.",
+ "type": "string"
+ },
+ "location": {
+ "$ref": "GooglePrivacyDlpV2beta1Location",
+ "description": "Where the content was found."
+ }
},
- "id": "GooglePrivacyDlpV2beta1CategoricalStatsConfig",
- "description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.",
- "type": "object"
+ "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": {
"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.",
@@ -2437,55 +2537,12 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1KMapEstimationConfig",
- "description": "Reidentifiability metric. This corresponds to a risk model similar to what\nis called \"journalist risk\" in the literature, except the attack dataset is\nstatistically modeled instead of being perfectly known. This can be done\nusing publicly available data (like the US Census), or using a custom\nstatistical model (indicated as one or several BigQuery tables), or by\nextrapolating from the distribution of values in the input dataset.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1Finding": {
- "description": "Represents a piece of potentially sensitive content.",
- "type": "object",
- "properties": {
- "infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "The type of content that might have been found.\nProvided if requested by the `InspectConfig`."
- },
- "createTime": {
- "description": "Timestamp when finding was detected.",
- "format": "google-datetime",
- "type": "string"
- },
- "quote": {
- "description": "The content that was found. Even if the content is not textual, it\nmay be converted to a textual representation here.\nProvided if requested by the `InspectConfig`.",
- "type": "string"
- },
- "location": {
- "description": "Where the content was found.",
- "$ref": "GooglePrivacyDlpV2beta1Location"
- },
- "likelihood": {
- "enumDescriptions": [
- "Default value; information with all likelihoods is included.",
- "Few matching elements.",
- "",
- "Some matching elements.",
- "",
- "Many matching elements."
- ],
- "enum": [
- "LIKELIHOOD_UNSPECIFIED",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Estimate of how likely it is that the `info_type` is correct.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Finding"
+ "id": "GooglePrivacyDlpV2beta1KMapEstimationConfig"
},
"GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata": {
+ "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata",
+ "description": "Metadata returned within the\n[`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis.operations/get)\nfor risk analysis.",
+ "type": "object",
"properties": {
"createTime": {
"description": "The time which this request was started.",
@@ -2493,19 +2550,17 @@
"type": "string"
},
"requestedSourceTable": {
- "description": "Input dataset to compute metrics over.",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
+ "description": "Input dataset to compute metrics over."
},
"requestedPrivacyMetric": {
- "description": "Privacy metric to compute.",
- "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric"
+ "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric",
+ "description": "Privacy metric to compute."
}
- },
- "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata",
- "description": "Metadata returned within the\n[`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis.operations/get)\nfor risk analysis.",
- "type": "object"
+ }
},
"GoogleLongrunningListOperationsResponse": {
+ "id": "GoogleLongrunningListOperationsResponse",
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
@@ -2520,10 +2575,10 @@
"$ref": "GoogleLongrunningOperation"
}
}
- },
- "id": "GoogleLongrunningListOperationsResponse"
+ }
},
"GooglePrivacyDlpV2beta1Row": {
+ "id": "GooglePrivacyDlpV2beta1Row",
"type": "object",
"properties": {
"values": {
@@ -2532,16 +2587,16 @@
"$ref": "GooglePrivacyDlpV2beta1Value"
}
}
- },
- "id": "GooglePrivacyDlpV2beta1Row"
+ }
},
"GoogleProtobufEmpty": {
+ "id": "GoogleProtobufEmpty",
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
- "properties": {},
- "id": "GoogleProtobufEmpty"
+ "properties": {}
},
"GooglePrivacyDlpV2beta1ListInspectFindingsResponse": {
+ "id": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse",
"description": "Response to the ListInspectFindings request.",
"type": "object",
"properties": {
@@ -2553,13 +2608,22 @@
"$ref": "GooglePrivacyDlpV2beta1InspectResult",
"description": "The results."
}
- },
- "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": {
+ "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",
@@ -2571,27 +2635,16 @@
"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": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket"
},
"GooglePrivacyDlpV2beta1Expressions": {
+ "id": "GooglePrivacyDlpV2beta1Expressions",
"description": "A collection of expressions",
"type": "object",
"properties": {
"logicalOperator": {
- "description": "The operator to apply to the result of conditions. Default and currently\nonly supported value is `AND`.",
- "type": "string",
"enumDescriptions": [
"",
""
@@ -2599,23 +2652,24 @@
"enum": [
"LOGICAL_OPERATOR_UNSPECIFIED",
"AND"
- ]
+ ],
+ "description": "The operator to apply to the result of conditions. Default and currently\nonly supported value is `AND`.",
+ "type": "string"
},
"conditions": {
"$ref": "GooglePrivacyDlpV2beta1Conditions"
}
- },
- "id": "GooglePrivacyDlpV2beta1Expressions"
+ }
},
"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"
}
- },
- "id": "GooglePrivacyDlpV2beta1CloudStorageOptions"
+ }
},
"GooglePrivacyDlpV2beta1CloudStoragePath": {
"description": "A location in Cloud Storage.",
@@ -2628,21 +2682,18 @@
},
"id": "GooglePrivacyDlpV2beta1CloudStoragePath"
},
- "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"
- },
"GooglePrivacyDlpV2beta1KAnonymityHistogramBucket": {
+ "id": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket",
"description": "Histogram bucket of equivalence class sizes in the table.",
"type": "object",
"properties": {
+ "bucketValues": {
+ "description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass"
+ }
+ },
"equivalenceClassSizeLowerBound": {
"description": "Lower bound on the size of the equivalence classes in this bucket.",
"format": "int64",
@@ -2657,49 +2708,23 @@
"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"
+ }
},
- "GooglePrivacyDlpV2beta1Range": {
- "description": "Generic half-open interval [start, end)",
+ "GooglePrivacyDlpV2beta1InspectOperationResult": {
+ "description": "The operational data.",
"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",
+ "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": "GooglePrivacyDlpV2beta1Range"
- },
- "GooglePrivacyDlpV2beta1CategoricalStatsResult": {
- "properties": {
- "valueFrequencyHistogramBuckets": {
- "description": "Histogram of value frequencies in the column.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1CategoricalStatsResult",
- "description": "Result of the categorical stats computation.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1InspectOperationResult"
},
"GooglePrivacyDlpV2beta1LDiversityResult": {
+ "description": "Result of the l-diversity computation.",
+ "type": "object",
"properties": {
"sensitiveValueFrequencyHistogramBuckets": {
"description": "Histogram of l-diversity equivalence class sensitive value frequencies.",
@@ -2709,9 +2734,38 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta1LDiversityResult",
- "description": "Result of the l-diversity computation.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1LDiversityResult"
+ },
+ "GooglePrivacyDlpV2beta1CategoricalStatsResult": {
+ "id": "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"
+ }
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1Range": {
+ "id": "GooglePrivacyDlpV2beta1Range",
+ "description": "Generic half-open interval [start, end)",
+ "type": "object",
+ "properties": {
+ "end": {
+ "description": "Index of the last character of the range (exclusive).",
+ "format": "int64",
+ "type": "string"
+ },
+ "start": {
+ "description": "Index of the first character of the range (inclusive).",
+ "format": "int64",
+ "type": "string"
+ }
+ }
},
"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`.",
@@ -2739,58 +2793,6 @@
}
},
"id": "GoogleTypeTimeOfDay"
- },
- "GooglePrivacyDlpV2beta1DeidentifyConfig": {
- "description": "The configuration that controls how the data will change.",
- "type": "object",
- "properties": {
- "recordTransformations": {
- "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table.",
- "$ref": "GooglePrivacyDlpV2beta1RecordTransformations"
- },
- "infoTypeTransformations": {
- "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformations",
- "description": "Treat the dataset as free-form text and apply the same free text\ntransformation everywhere."
- }
- },
- "id": "GooglePrivacyDlpV2beta1DeidentifyConfig"
- },
- "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"
- },
- "GooglePrivacyDlpV2beta1StorageConfig": {
- "description": "Shared message indicating Cloud storage type.",
- "type": "object",
- "properties": {
- "datastoreOptions": {
- "description": "Google Cloud Datastore options specification.",
- "$ref": "GooglePrivacyDlpV2beta1DatastoreOptions"
- },
- "bigQueryOptions": {
- "description": "BigQuery options specification.",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions"
- },
- "cloudStorageOptions": {
- "description": "Google Cloud Storage options specification.",
- "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions"
- }
- },
- "id": "GooglePrivacyDlpV2beta1StorageConfig"
}
},
"icons": {
@@ -2808,7 +2810,5 @@
}
}
},
- "rootUrl": "https://dlp.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "dlp"
+ "rootUrl": "https://dlp.googleapis.com/"
}
diff --git a/dlp/v2beta2/dlp-api.json b/dlp/v2beta2/dlp-api.json
index 340fee7..0a16fb4 100644
--- a/dlp/v2beta2/dlp-api.json
+++ b/dlp/v2beta2/dlp-api.json
@@ -1,181 +1,58 @@
{
- "kind": "discovery#restDescription",
- "description": "The Google Data Loss Prevention API provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.",
- "servicePath": "",
- "basePath": "",
- "revision": "20180123",
- "documentationLink": "https://cloud.google.com/dlp/docs/",
"id": "dlp:v2beta2",
+ "documentationLink": "https://cloud.google.com/dlp/docs/",
+ "revision": "20180123",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "GooglePrivacyDlpV2beta2InfoTypeDescription": {
- "properties": {
- "name": {
- "description": "Internal name of the infoType.",
- "type": "string"
- },
- "displayName": {
- "description": "Human readable form of the infoType name.",
- "type": "string"
- },
- "supportedBy": {
- "enumDescriptions": [
- "",
- "Supported by the inspect operations.",
- "Supported by the risk analysis operations."
- ],
- "description": "Which parts of the API supports this InfoType.",
- "type": "array",
- "items": {
- "enum": [
- "ENUM_TYPE_UNSPECIFIED",
- "INSPECT",
- "RISK_ANALYSIS"
- ],
- "type": "string"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2InfoTypeDescription",
- "description": "InfoType description.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2InspectDataSourceDetails": {
- "properties": {
- "requestedOptions": {
- "$ref": "GooglePrivacyDlpV2beta2RequestedOptions",
- "description": "The configuration used for this job."
- },
- "result": {
- "$ref": "GooglePrivacyDlpV2beta2Result",
- "description": "A summary of the outcome of this inspect job."
- }
- },
- "id": "GooglePrivacyDlpV2beta2InspectDataSourceDetails",
- "description": "The results of an inspect DataSource job.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2ReidentifyContentRequest": {
- "properties": {
- "reidentifyConfig": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig",
- "description": "Configuration for the re-identification of the content item.\nThis field shares the same proto message type that is used for\nde-identification, however its usage here is for the reversal of the\nprevious de-identification. Re-identification is performed by examining\nthe transformations used to de-identify the items and executing the\nreverse. This requires that only reversible transformations\nbe provided here. The reversible transformations are:\n\n - `CryptoReplaceFfxFpeConfig`"
- },
- "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"
- }
- },
- "id": "GooglePrivacyDlpV2beta2ReidentifyContentRequest",
- "description": "Request to re-identify an item.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2LDiversityResult": {
- "properties": {
- "sensitiveValueFrequencyHistogramBuckets": {
- "description": "Histogram of l-diversity equivalence class sensitive value frequencies.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2LDiversityHistogramBucket"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2LDiversityResult",
- "description": "Result of the l-diversity computation.",
- "type": "object"
- },
- "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",
- "type": "number"
- },
- "blue": {
- "description": "The amount of blue in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- }
- },
- "id": "GooglePrivacyDlpV2beta2Color"
- },
- "GooglePrivacyDlpV2beta2InspectContentResponse": {
- "description": "Results of inspecting an item.",
- "type": "object",
- "properties": {
- "result": {
- "description": "The findings.",
- "$ref": "GooglePrivacyDlpV2beta2InspectResult"
- }
- },
- "id": "GooglePrivacyDlpV2beta2InspectContentResponse"
- },
"GooglePrivacyDlpV2beta1OutputStorageConfig": {
+ "description": "Cloud repository for storing output.",
+ "type": "object",
"properties": {
"storagePath": {
- "description": "The path to a Google Cloud Storage location to store output.\nThe bucket must already exist and\nthe Google APIs service account for DLP must have write permission to\nwrite to the given bucket.\nResults are split over multiple csv files with each file name matching\nthe pattern \"[operation_id]_[count].csv\", for example\n`3094877188788974909_1.csv`. The `operation_id` matches the\nidentifier for the Operation, and the `count` is a counter used for\ntracking the number of files written.\n\nThe CSV file(s) contain the following columns regardless of storage type\nscanned:\n- id\n- info_type\n- likelihood\n- byte size of finding\n- quote\n- timestamp\n\nFor Cloud Storage the next columns are:\n\n- file_path\n- start_offset\n\nFor Cloud Datastore the next columns are:\n\n- project_id\n- namespace_id\n- path\n- column_name\n- offset\n\nFor BigQuery the next columns are:\n\n- row_number\n- project_id\n- dataset_id\n- table_id",
- "$ref": "GooglePrivacyDlpV2beta1CloudStoragePath"
+ "$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"
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
+ "description": "Store findings in a new table in the dataset."
}
},
- "id": "GooglePrivacyDlpV2beta1OutputStorageConfig",
- "description": "Cloud repository for storing output.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1OutputStorageConfig"
},
"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"
+ "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass"
},
"GooglePrivacyDlpV2beta2DatastoreKey": {
+ "description": "Record key for a finding in Cloud Datastore.",
+ "type": "object",
"properties": {
"entityKey": {
"description": "Datastore entity key.",
"$ref": "GooglePrivacyDlpV2beta2Key"
}
},
- "id": "GooglePrivacyDlpV2beta2DatastoreKey",
- "description": "Record key for a finding in Cloud Datastore.",
- "type": "object"
+ "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.",
@@ -190,9 +67,7 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2BigQueryTable",
- "description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2BigQueryTable"
},
"GooglePrivacyDlpV2beta2RedactImageResponse": {
"description": "Results of redacting an image.",
@@ -226,12 +101,12 @@
"type": "string"
},
"requestInspectConfig": {
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
- "description": "The inspect config used to create the Operation."
+ "description": "The inspect config used to create the Operation.",
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
},
"requestOutputConfig": {
- "description": "Optional location to store findings.",
- "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig"
+ "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig",
+ "description": "Optional location to store findings."
},
"createTime": {
"description": "The time which this request was started.",
@@ -239,8 +114,8 @@
"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.",
@@ -250,6 +125,19 @@
},
"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",
@@ -261,26 +149,13 @@
},
"id": "GooglePrivacyDlpV2beta1InfoType"
},
- "GooglePrivacyDlpV2beta2RecordKey": {
- "properties": {
- "cloudStorageKey": {
- "$ref": "GooglePrivacyDlpV2beta2CloudStorageKey"
- },
- "datastoreKey": {
- "$ref": "GooglePrivacyDlpV2beta2DatastoreKey"
- }
- },
- "id": "GooglePrivacyDlpV2beta2RecordKey",
- "description": "Message for a unique key indicating a record that contains a finding.",
- "type": "object"
- },
"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": {
- "$ref": "GooglePrivacyDlpV2beta2FieldId",
- "description": "Composite key indicating which field contains the entity identifier."
+ "description": "Composite key indicating which field contains the entity identifier.",
+ "$ref": "GooglePrivacyDlpV2beta2FieldId"
}
},
"id": "GooglePrivacyDlpV2beta2EntityId"
@@ -289,43 +164,21 @@
"description": "Bucket is represented as a range, along with replacement values.",
"type": "object",
"properties": {
+ "min": {
+ "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused.",
+ "$ref": "GooglePrivacyDlpV2beta2Value"
+ },
"max": {
"description": "Upper bound of the range, exclusive; type must match min.",
"$ref": "GooglePrivacyDlpV2beta2Value"
},
"replacementValue": {
- "$ref": "GooglePrivacyDlpV2beta2Value",
- "description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range."
- },
- "min": {
- "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused.",
+ "description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range.",
"$ref": "GooglePrivacyDlpV2beta2Value"
}
},
"id": "GooglePrivacyDlpV2beta2Bucket"
},
- "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult": {
- "properties": {
- "categoricalStatsResult": {
- "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsResult"
- },
- "numericalStatsResult": {
- "$ref": "GooglePrivacyDlpV2beta1NumericalStatsResult"
- },
- "kMapEstimationResult": {
- "$ref": "GooglePrivacyDlpV2beta1KMapEstimationResult"
- },
- "kAnonymityResult": {
- "$ref": "GooglePrivacyDlpV2beta1KAnonymityResult"
- },
- "lDiversityResult": {
- "$ref": "GooglePrivacyDlpV2beta1LDiversityResult"
- }
- },
- "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult",
- "description": "Result of a risk analysis\n[`Operation`](/dlp/docs/reference/rest/v2beta1/inspect.operations)\nrequest.",
- "type": "object"
- },
"GooglePrivacyDlpV2beta2CreateInspectTemplateRequest": {
"description": "Request message for CreateInspectTemplate.",
"type": "object",
@@ -341,29 +194,42 @@
},
"id": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest"
},
+ "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult": {
+ "description": "Result of a risk analysis\n[`Operation`](/dlp/docs/reference/rest/v2beta1/inspect.operations)\nrequest.",
+ "type": "object",
+ "properties": {
+ "lDiversityResult": {
+ "$ref": "GooglePrivacyDlpV2beta1LDiversityResult"
+ },
+ "categoricalStatsResult": {
+ "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsResult"
+ },
+ "numericalStatsResult": {
+ "$ref": "GooglePrivacyDlpV2beta1NumericalStatsResult"
+ },
+ "kMapEstimationResult": {
+ "$ref": "GooglePrivacyDlpV2beta1KMapEstimationResult"
+ },
+ "kAnonymityResult": {
+ "$ref": "GooglePrivacyDlpV2beta1KAnonymityResult"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult"
+ },
"GooglePrivacyDlpV2beta1CategoricalStatsConfig": {
"description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.",
"type": "object",
"properties": {
"field": {
- "description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data.",
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ "$ref": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data."
}
},
"id": "GooglePrivacyDlpV2beta1CategoricalStatsConfig"
},
"GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket": {
+ "type": "object",
"properties": {
- "bucketSize": {
- "description": "Total number of values in this bucket.",
- "format": "int64",
- "type": "string"
- },
- "valueFrequencyUpperBound": {
- "description": "Upper bound on the value frequency of the values in this bucket.",
- "format": "int64",
- "type": "string"
- },
"valueFrequencyLowerBound": {
"description": "Lower bound on the value frequency of the values in this bucket.",
"format": "int64",
@@ -375,10 +241,19 @@
"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",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket"
},
"GooglePrivacyDlpV2beta1KMapEstimationConfig": {
"description": "Reidentifiability metric. This corresponds to a risk model similar to what\nis called \"journalist risk\" in the literature, except the attack dataset is\nstatistically modeled instead of being perfectly known. This can be done\nusing publicly available data (like the US Census), or using a custom\nstatistical model (indicated as one or several BigQuery tables), or by\nextrapolating from the distribution of values in the input dataset.",
@@ -409,13 +284,9 @@
"description": "Result of the numerical stats computation.",
"type": "object",
"properties": {
- "minValue": {
- "description": "Minimum value appearing in the column.",
- "$ref": "GooglePrivacyDlpV2beta2Value"
- },
"maxValue": {
- "$ref": "GooglePrivacyDlpV2beta2Value",
- "description": "Maximum value appearing in the column."
+ "description": "Maximum value appearing in the column.",
+ "$ref": "GooglePrivacyDlpV2beta2Value"
},
"quantileValues": {
"description": "List of 99 values that partition the set of field values into 100 equal\nsized buckets.",
@@ -423,11 +294,17 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta2Value"
}
+ },
+ "minValue": {
+ "description": "Minimum value appearing in the column.",
+ "$ref": "GooglePrivacyDlpV2beta2Value"
}
},
"id": "GooglePrivacyDlpV2beta2NumericalStatsResult"
},
"GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata": {
+ "description": "Metadata returned within the\n[`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis.operations/get)\nfor risk analysis.",
+ "type": "object",
"properties": {
"createTime": {
"description": "The time which this request was started.",
@@ -435,19 +312,19 @@
"type": "string"
},
"requestedSourceTable": {
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
- "description": "Input dataset to compute metrics over."
+ "description": "Input dataset to compute metrics over.",
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
},
"requestedPrivacyMetric": {
- "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric",
- "description": "Privacy metric to compute."
+ "description": "Privacy metric to compute.",
+ "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric"
}
},
- "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata",
- "description": "Metadata returned within the\n[`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis.operations/get)\nfor risk analysis.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata"
},
"GooglePrivacyDlpV2beta2TaggedField": {
+ "description": "A column with a semantic tag attached.",
+ "type": "object",
"properties": {
"field": {
"description": "Identifies the column. [required]",
@@ -458,33 +335,31 @@
"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"
+ "description": "If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data",
+ "$ref": "GoogleProtobufEmpty"
}
},
- "id": "GooglePrivacyDlpV2beta2TaggedField",
- "description": "A column with a semantic tag attached.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2TaggedField"
},
"GooglePrivacyDlpV2beta2InspectContentRequest": {
"description": "Request to search for potentially sensitive info in a ContentItem.",
"type": "object",
"properties": {
- "item": {
- "description": "The item to inspect.",
- "$ref": "GooglePrivacyDlpV2beta2ContentItem"
- },
"inspectConfig": {
- "description": "Configuration for the inspector. What specified here will override\nthe template referenced by the inspect_template_name argument.",
- "$ref": "GooglePrivacyDlpV2beta2InspectConfig"
+ "$ref": "GooglePrivacyDlpV2beta2InspectConfig",
+ "description": "Configuration for the inspector. What specified here will override\nthe template referenced by the inspect_template_name argument."
},
"inspectTemplateName": {
"description": "Optional template to use. Any configuration directly specified in\ninspect_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
"type": "string"
+ },
+ "item": {
+ "description": "The item to inspect.",
+ "$ref": "GooglePrivacyDlpV2beta2ContentItem"
}
},
"id": "GooglePrivacyDlpV2beta2InspectContentRequest"
@@ -493,18 +368,6 @@
"description": "The DeidentifyTemplates contains instructions on how to deidentify content.",
"type": "object",
"properties": {
- "displayName": {
- "description": "Display name (max 256 chars).",
- "type": "string"
- },
- "description": {
- "description": "Short description (max 256 chars).",
- "type": "string"
- },
- "deidentifyConfig": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig",
- "description": "///////////// // The core content of the template // ///////////////"
- },
"createTime": {
"description": "The creation timestamp of a inspectTemplate, output only field.",
"format": "google-datetime",
@@ -518,27 +381,45 @@
"name": {
"description": "The template name. Output only.\n\nThe template will have one of the following formats:\n`projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR\n`organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID`",
"type": "string"
+ },
+ "displayName": {
+ "description": "Display name (max 256 chars).",
+ "type": "string"
+ },
+ "description": {
+ "description": "Short description (max 256 chars).",
+ "type": "string"
+ },
+ "deidentifyConfig": {
+ "description": "///////////// // The core content of the template // ///////////////",
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig"
}
},
"id": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
},
"GooglePrivacyDlpV2beta2DatastoreOptions": {
+ "description": "Options defining a data set within Google Cloud Datastore.",
+ "type": "object",
"properties": {
- "kind": {
- "$ref": "GooglePrivacyDlpV2beta2KindExpression",
- "description": "The kind to process."
- },
"partitionId": {
"description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.",
"$ref": "GooglePrivacyDlpV2beta2PartitionId"
+ },
+ "kind": {
+ "description": "The kind to process.",
+ "$ref": "GooglePrivacyDlpV2beta2KindExpression"
}
},
- "id": "GooglePrivacyDlpV2beta2DatastoreOptions",
- "description": "Options defining a data set within Google Cloud Datastore.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2DatastoreOptions"
},
"GooglePrivacyDlpV2beta2InspectTemplate": {
+ "description": "The inspectTemplate contains a configuration (set of types of sensitive data\nto be detected) to be used anywhere you otherwise would normally specify\nInspectConfig.",
+ "type": "object",
"properties": {
+ "inspectConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectConfig",
+ "description": "The core content of the template. Configuration of the scanning process."
+ },
"displayName": {
"description": "Display name (max 256 chars).",
"type": "string"
@@ -560,22 +441,19 @@
"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": {
- "description": "The core content of the template. Configuration of the scanning process.",
- "$ref": "GooglePrivacyDlpV2beta2InspectConfig"
}
},
- "id": "GooglePrivacyDlpV2beta2InspectTemplate",
- "description": "The inspectTemplate contains a configuration (set of types of sensitive data\nto be detected) to be used anywhere you otherwise would normally specify\nInspectConfig.",
- "type": "object"
+ "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": {
+ "type": "string",
"enumDescriptions": [
"",
"0-9",
@@ -591,36 +469,33 @@
"ALPHA_LOWER_CASE",
"PUNCTUATION",
"WHITESPACE"
- ],
- "type": "string"
+ ]
}
},
- "id": "GooglePrivacyDlpV2beta2CharsToIgnore",
- "description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.",
- "type": "object"
+ "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"
+ "type": "object",
+ "properties": {},
+ "id": "GoogleProtobufEmpty"
},
"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"
+ "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",
- "description": "General identifier of a data field in a storage service.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2FieldId"
},
"GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest": {
"description": "Request for creating a risk analysis DlpJob.",
@@ -637,6 +512,18 @@
"description": "Request to de-identify a list of items.",
"type": "object",
"properties": {
+ "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": {
+ "$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"
@@ -644,24 +531,24 @@
"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": {
- "$ref": "GooglePrivacyDlpV2beta2InspectConfig",
- "description": "Configuration for the inspector.\nItems specified here will override the template referenced by the\ninspect_template_name argument."
- },
- "inspectTemplateName": {
- "description": "Optional template to use. Any configuration directly specified in\ninspect_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
- "type": "string"
- },
- "item": {
- "description": "The item to de-identify. Will be treated as text.",
- "$ref": "GooglePrivacyDlpV2beta2ContentItem"
}
},
"id": "GooglePrivacyDlpV2beta2DeidentifyContentRequest"
},
"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",
@@ -673,21 +560,9 @@
"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": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket",
- "description": "A KMapEstimationHistogramBucket message with the following values:\n min_anonymity: 3\n max_anonymity: 5\n frequency: 42\nmeans that there are 42 records whose quasi-identifier values correspond\nto 3, 4 or 5 people in the overlying population. An important particular\ncase is when min_anonymity = max_anonymity = 1: the frequency field then\ncorresponds to the number of uniquely identifiable records.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket"
},
"GooglePrivacyDlpV2beta1CloudStorageOptions": {
"description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.",
@@ -700,20 +575,24 @@
"id": "GooglePrivacyDlpV2beta1CloudStorageOptions"
},
"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": {
+ "description": "Custom infoTypes provided by the user.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2CustomInfoType"
+ }
+ },
+ "limits": {
+ "$ref": "GooglePrivacyDlpV2beta2FindingLimits"
+ },
"excludeInfoTypes": {
"description": "When true, excludes type information of the findings.",
"type": "boolean"
},
"minLikelihood": {
- "enum": [
- "LIKELIHOOD_UNSPECIFIED",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
"description": "Only returns findings equal or above this threshold. The default is\nPOSSIBLE.",
"type": "string",
"enumDescriptions": [
@@ -723,6 +602,14 @@
"Some matching elements.",
"",
"Many matching elements."
+ ],
+ "enum": [
+ "LIKELIHOOD_UNSPECIFIED",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
]
},
"infoTypes": {
@@ -735,55 +622,32 @@
"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",
- "description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
- "type": "object"
+ "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"
}
+ },
+ "tableReference": {
+ "$ref": "GooglePrivacyDlpV2beta2BigQueryTable",
+ "description": "Complete BigQuery table reference."
}
},
- "id": "GooglePrivacyDlpV2beta2BigQueryOptions",
- "description": "Options defining BigQuery table and row identifiers.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2BigQueryOptions"
},
"GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails": {
+ "description": "Result of a risk analysis operation request.",
+ "type": "object",
"properties": {
- "categoricalStatsResult": {
- "$ref": "GooglePrivacyDlpV2beta2CategoricalStatsResult"
- },
- "requestedPrivacyMetric": {
- "description": "Privacy metric to compute.",
- "$ref": "GooglePrivacyDlpV2beta2PrivacyMetric"
- },
- "numericalStatsResult": {
- "$ref": "GooglePrivacyDlpV2beta2NumericalStatsResult"
- },
- "kAnonymityResult": {
- "$ref": "GooglePrivacyDlpV2beta2KAnonymityResult"
- },
"kMapEstimationResult": {
"$ref": "GooglePrivacyDlpV2beta2KMapEstimationResult"
},
@@ -793,13 +657,26 @@
"requestedSourceTable": {
"$ref": "GooglePrivacyDlpV2beta2BigQueryTable",
"description": "Input dataset to compute metrics over."
+ },
+ "requestedPrivacyMetric": {
+ "description": "Privacy metric to compute.",
+ "$ref": "GooglePrivacyDlpV2beta2PrivacyMetric"
+ },
+ "categoricalStatsResult": {
+ "$ref": "GooglePrivacyDlpV2beta2CategoricalStatsResult"
+ },
+ "numericalStatsResult": {
+ "$ref": "GooglePrivacyDlpV2beta2NumericalStatsResult"
+ },
+ "kAnonymityResult": {
+ "$ref": "GooglePrivacyDlpV2beta2KAnonymityResult"
}
},
- "id": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails",
- "description": "Result of a risk analysis operation request.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails"
},
"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"
@@ -808,20 +685,18 @@
"type": "string"
}
},
- "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"
+ "id": "GooglePrivacyDlpV2beta2QuasiIdField"
},
"GooglePrivacyDlpV2beta1CloudStoragePath": {
+ "description": "A location in Cloud Storage.",
+ "type": "object",
"properties": {
"path": {
"description": "The url, in the format of `gs://bucket/\u003cpath\u003e`.",
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1CloudStoragePath",
- "description": "A location in Cloud Storage.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1CloudStoragePath"
},
"GooglePrivacyDlpV2beta1KAnonymityHistogramBucket": {
"description": "Histogram bucket of equivalence class sizes in the table.",
@@ -853,15 +728,15 @@
"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"
}
},
- "id": "GooglePrivacyDlpV2beta1InspectOperationResult",
- "description": "The operational data.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1InspectOperationResult"
},
"GooglePrivacyDlpV2beta2TransformationOverview": {
"description": "Overview of the modifications that occurred.",
@@ -900,21 +775,9 @@
},
"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": {
+ "description": "Result of the l-diversity computation.",
+ "type": "object",
"properties": {
"sensitiveValueFrequencyHistogramBuckets": {
"description": "Histogram of l-diversity equivalence class sensitive value frequencies.",
@@ -924,22 +787,26 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta1LDiversityResult",
- "description": "Result of the l-diversity computation.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1LDiversityResult"
+ },
+ "GooglePrivacyDlpV2beta1CategoricalStatsResult": {
+ "description": "Result of the categorical stats computation.",
+ "type": "object",
+ "properties": {
+ "valueFrequencyHistogramBuckets": {
+ "description": "Histogram of value frequencies in the column.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1CategoricalStatsResult"
},
"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",
@@ -949,11 +816,19 @@
"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",
- "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"
+ "id": "GoogleTypeTimeOfDay"
},
"GooglePrivacyDlpV2beta2LDiversityEquivalenceClass": {
"description": "The set of columns' values that share the same ldiversity value.",
@@ -987,23 +862,23 @@
"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"
+ "$ref": "GooglePrivacyDlpV2beta2FieldId",
+ "description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data."
}
},
- "id": "GooglePrivacyDlpV2beta2CategoricalStatsConfig",
- "description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2CategoricalStatsConfig"
},
"GooglePrivacyDlpV2beta1LDiversityConfig": {
"description": "l-diversity metric, used for analysis of reidentification risk.",
"type": "object",
"properties": {
"sensitiveAttribute": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "Sensitive field for computing the l-value."
+ "description": "Sensitive field for computing the l-value.",
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
},
"quasiIds": {
"description": "Set of quasi-identifiers indicating how equivalence classes are\ndefined for the l-diversity computation. When multiple fields are\nspecified, they are considered a single composite key.",
@@ -1016,6 +891,8 @@
"id": "GooglePrivacyDlpV2beta1LDiversityConfig"
},
"GooglePrivacyDlpV2beta2ValueFrequency": {
+ "description": "A value of a field, including its frequency.",
+ "type": "object",
"properties": {
"value": {
"description": "A value contained in the field in question.",
@@ -1027,23 +904,27 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2ValueFrequency",
- "description": "A value of a field, including its frequency.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2ValueFrequency"
},
"GooglePrivacyDlpV2beta2ReplaceValueConfig": {
+ "description": "Replace each input value with a given `Value`.",
+ "type": "object",
"properties": {
"newValue": {
- "description": "Value to replace it with.",
- "$ref": "GooglePrivacyDlpV2beta2Value"
+ "$ref": "GooglePrivacyDlpV2beta2Value",
+ "description": "Value to replace it with."
}
},
- "id": "GooglePrivacyDlpV2beta2ReplaceValueConfig",
- "description": "Replace each input value with a given `Value`.",
- "type": "object"
+ "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",
@@ -1054,31 +935,25 @@
"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]"
- },
- "table": {
- "$ref": "GooglePrivacyDlpV2beta2BigQueryTable",
- "description": "Auxiliary table location. [required]"
}
},
- "id": "GooglePrivacyDlpV2beta2AuxiliaryTable",
- "description": "An auxiliary table contains statistical information on the relative\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable).",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2AuxiliaryTable"
},
"GooglePrivacyDlpV2beta1StorageConfig": {
"description": "Shared message indicating Cloud storage type.",
"type": "object",
"properties": {
+ "cloudStorageOptions": {
+ "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions",
+ "description": "Google Cloud Storage options specification."
+ },
"datastoreOptions": {
- "$ref": "GooglePrivacyDlpV2beta1DatastoreOptions",
- "description": "Google Cloud Datastore options specification."
+ "description": "Google Cloud Datastore options specification.",
+ "$ref": "GooglePrivacyDlpV2beta1DatastoreOptions"
},
"bigQueryOptions": {
- "description": "BigQuery options specification.",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions"
- },
- "cloudStorageOptions": {
- "description": "Google Cloud Storage options specification.",
- "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions"
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions",
+ "description": "BigQuery options specification."
}
},
"id": "GooglePrivacyDlpV2beta1StorageConfig"
@@ -1102,7 +977,12 @@
"id": "GooglePrivacyDlpV2beta1BigQueryOptions"
},
"GooglePrivacyDlpV2beta1PrivacyMetric": {
+ "description": "Privacy metric to compute for reidentification risk analysis.",
+ "type": "object",
"properties": {
+ "lDiversityConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1LDiversityConfig"
+ },
"numericalStatsConfig": {
"$ref": "GooglePrivacyDlpV2beta1NumericalStatsConfig"
},
@@ -1114,20 +994,25 @@
},
"kMapEstimationConfig": {
"$ref": "GooglePrivacyDlpV2beta1KMapEstimationConfig"
- },
- "lDiversityConfig": {
- "$ref": "GooglePrivacyDlpV2beta1LDiversityConfig"
}
},
- "id": "GooglePrivacyDlpV2beta1PrivacyMetric",
- "description": "Privacy metric to compute for reidentification risk analysis.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1PrivacyMetric"
},
"GooglePrivacyDlpV2beta2Location": {
+ "description": "Specifies the location of the finding.",
+ "type": "object",
"properties": {
+ "recordKey": {
+ "$ref": "GooglePrivacyDlpV2beta2RecordKey",
+ "description": "The pointer to the record in storage that contained the field the\nfinding was found in.\nProvided when the finding's containing element is a property\nof a storage object."
+ },
+ "tableLocation": {
+ "description": "The pointer to the row of the table that contained the finding.\nProvided when the finding's containing element is a cell of a table.",
+ "$ref": "GooglePrivacyDlpV2beta2TableLocation"
+ },
"codepointRange": {
- "description": "Unicode character offsets delimiting the finding.\nThese are relative to the finding's containing element.\nProvided when the content is text.",
- "$ref": "GooglePrivacyDlpV2beta2Range"
+ "$ref": "GooglePrivacyDlpV2beta2Range",
+ "description": "Unicode character offsets delimiting the finding.\nThese are relative to the finding's containing element.\nProvided when the content is text."
},
"fieldId": {
"description": "The pointer to the property or cell that contained the finding.\nProvided when the finding's containing element is a cell in a table\nor a property of storage object.",
@@ -1141,49 +1026,41 @@
}
},
"byteRange": {
- "$ref": "GooglePrivacyDlpV2beta2Range",
- "description": "Zero-based byte offsets delimiting the finding.\nThese are relative to the finding's containing element.\nNote that when the content is not textual, this references\nthe UTF-8 encoded textual representation of the content.\nOmitted if content is an image."
- },
- "recordKey": {
- "description": "The pointer to the record in storage that contained the field the\nfinding was found in.\nProvided when the finding's containing element is a property\nof a storage object.",
- "$ref": "GooglePrivacyDlpV2beta2RecordKey"
- },
- "tableLocation": {
- "$ref": "GooglePrivacyDlpV2beta2TableLocation",
- "description": "The pointer to the row of the table that contained the finding.\nProvided when the finding's containing element is a cell of a table."
+ "description": "Zero-based byte offsets delimiting the finding.\nThese are relative to the finding's containing element.\nNote that when the content is not textual, this references\nthe UTF-8 encoded textual representation of the content.\nOmitted if content is an image.",
+ "$ref": "GooglePrivacyDlpV2beta2Range"
}
},
- "id": "GooglePrivacyDlpV2beta2Location",
- "description": "Specifies the location of the finding.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2Location"
},
"GooglePrivacyDlpV2beta2ReidentifyContentResponse": {
"description": "Results of re-identifying a item.",
"type": "object",
"properties": {
- "overview": {
- "$ref": "GooglePrivacyDlpV2beta2TransformationOverview",
- "description": "An overview of the changes that were made to the `item`."
- },
"item": {
"$ref": "GooglePrivacyDlpV2beta2ContentItem",
"description": "The re-identified item."
+ },
+ "overview": {
+ "description": "An overview of the changes that were made to the `item`.",
+ "$ref": "GooglePrivacyDlpV2beta2TransformationOverview"
}
},
"id": "GooglePrivacyDlpV2beta2ReidentifyContentResponse"
},
- "GooglePrivacyDlpV2beta2TransientCryptoKey": {
+ "GooglePrivacyDlpV2beta1NumericalStatsConfig": {
+ "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
+ "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"
+ "field": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "Field to compute numerical stats on. Supported types are\ninteger, float, date, datetime, timestamp, time."
}
},
- "id": "GooglePrivacyDlpV2beta2TransientCryptoKey",
- "description": "Use this to have a random data crypto key generated.\nIt will be discarded after the request finishes.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1NumericalStatsConfig"
},
"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.",
@@ -1210,56 +1087,48 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass",
- "description": "The set of columns' values that share the same l-diversity value.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass"
},
- "GooglePrivacyDlpV2beta1NumericalStatsConfig": {
+ "GooglePrivacyDlpV2beta2TransientCryptoKey": {
+ "description": "Use this to have a random data crypto key generated.\nIt will be discarded after the request finishes.",
+ "type": "object",
"properties": {
- "field": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "Field to compute numerical stats on. Supported types are\ninteger, float, date, datetime, timestamp, time."
+ "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": "GooglePrivacyDlpV2beta1NumericalStatsConfig",
- "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2TransientCryptoKey"
},
"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"
}
+ },
+ "primitiveTransformation": {
+ "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation",
+ "description": "Primitive transformation to apply to the infoType. [required]"
}
},
- "id": "GooglePrivacyDlpV2beta2InfoTypeTransformation",
- "description": "A transformation to apply to text that is identified as a specific\ninfo_type.",
- "type": "object"
- },
- "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"
+ "id": "GooglePrivacyDlpV2beta2InfoTypeTransformation"
},
"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": {
+ "description": "Operator used to compare the field or infoType to the value. [required]",
+ "type": "string",
"enumDescriptions": [
"",
"Equal.",
@@ -1279,18 +1148,24 @@
"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": {
- "description": "Value to compare against. [Required, except for `EXISTS` tests.]",
- "$ref": "GooglePrivacyDlpV2beta2Value"
+ "$ref": "GooglePrivacyDlpV2beta2Value",
+ "description": "Value to compare against. [Required, except for `EXISTS` tests.]"
}
},
- "id": "GooglePrivacyDlpV2beta2Condition",
- "description": "The field type of `value` and `field` do not need to match to be\nconsidered equal, but not all comparisons are possible.\n\nA `value` of type:\n\n- `string` can be compared against all other types\n- `boolean` can only be compared against other booleans\n- `integer` can be compared against doubles or a string if the string value\ncan be parsed as an integer.\n- `double` can be compared against integers or a string if the string can\nbe parsed as a double.\n- `Timestamp` can be compared against strings in RFC 3339 date string\nformat.\n- `TimeOfDay` can be compared against timestamps and strings in the format\nof 'HH:mm:ss'.\n\nIf we fail to compare do to type mismatch, a warning will be given and\nthe condition will evaluate to false.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2Condition"
+ },
+ "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"
},
"GooglePrivacyDlpV2beta2TableLocation": {
"description": "Location of a finding within a table.",
@@ -1305,6 +1180,8 @@
"id": "GooglePrivacyDlpV2beta2TableLocation"
},
"GooglePrivacyDlpV2beta2KMapEstimationResult": {
+ "description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.",
+ "type": "object",
"properties": {
"kMapEstimationHistogram": {
"description": "The intervals [min_anonymity, max_anonymity] do not overlap. If a value\ndoesn't correspond to any such interval, the associated frequency is\nzero. For example, the following records:\n {min_anonymity: 1, max_anonymity: 1, frequency: 17}\n {min_anonymity: 2, max_anonymity: 3, frequency: 42}\n {min_anonymity: 5, max_anonymity: 10, frequency: 99}\nmean that there are no record with an estimated anonymity of 4, 5, or\nlarger than 10.",
@@ -1314,12 +1191,40 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta2KMapEstimationResult",
- "description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2KMapEstimationResult"
+ },
+ "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"
},
"GooglePrivacyDlpV2beta2PrimitiveTransformation": {
+ "description": "A rule for transforming a value.",
+ "type": "object",
"properties": {
+ "replaceConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2ReplaceValueConfig"
+ },
+ "timePartConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2TimePartConfig"
+ },
+ "fixedSizeBucketingConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2FixedSizeBucketingConfig"
+ },
"characterMaskConfig": {
"$ref": "GooglePrivacyDlpV2beta2CharacterMaskConfig"
},
@@ -1337,47 +1242,17 @@
},
"cryptoReplaceFfxFpeConfig": {
"$ref": "GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig"
- },
- "replaceConfig": {
- "$ref": "GooglePrivacyDlpV2beta2ReplaceValueConfig"
- },
- "fixedSizeBucketingConfig": {
- "$ref": "GooglePrivacyDlpV2beta2FixedSizeBucketingConfig"
- },
- "timePartConfig": {
- "$ref": "GooglePrivacyDlpV2beta2TimePartConfig"
}
},
- "id": "GooglePrivacyDlpV2beta2PrimitiveTransformation",
- "description": "A rule for transforming a value.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass": {
- "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",
- "description": "The set of columns' values that share the same ldiversity value",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2PrimitiveTransformation"
},
"GooglePrivacyDlpV2beta1NumericalStatsResult": {
"description": "Result of the numerical stats computation.",
"type": "object",
"properties": {
"maxValue": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Maximum value appearing in the column."
+ "description": "Maximum value appearing in the column.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
},
"quantileValues": {
"description": "List of 99 values that partition the set of field values into 100 equal\nsized buckets.",
@@ -1387,24 +1262,26 @@
}
},
"minValue": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Minimum value appearing in the column."
+ "description": "Minimum value appearing in the column.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
}
},
"id": "GooglePrivacyDlpV2beta1NumericalStatsResult"
},
- "GooglePrivacyDlpV2beta2InfoType": {
+ "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": {
- "name": {
- "description": "Name of the information type.",
- "type": "string"
+ "wordList": {
+ "description": "List of words or phrases to search for.",
+ "$ref": "GooglePrivacyDlpV2beta1WordList"
}
},
- "id": "GooglePrivacyDlpV2beta2InfoType",
- "description": "Type of information detected by the API.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1Dictionary"
},
"GooglePrivacyDlpV2beta2ListDlpJobsResponse": {
+ "description": "The response message for listing DLP jobs.",
+ "type": "object",
"properties": {
"jobs": {
"description": "A list of DlpJobs that matches the specified filter in the request.",
@@ -1418,30 +1295,26 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2ListDlpJobsResponse",
- "description": "The response message for listing DLP jobs.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2ListDlpJobsResponse"
},
- "GooglePrivacyDlpV2beta1Dictionary": {
+ "GooglePrivacyDlpV2beta2InfoType": {
+ "description": "Type of information detected by the API.",
+ "type": "object",
"properties": {
- "wordList": {
- "description": "List of words or phrases to search for.",
- "$ref": "GooglePrivacyDlpV2beta1WordList"
+ "name": {
+ "description": "Name of the information type.",
+ "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1Dictionary",
- "description": "Custom information type based on a dictionary of words or phrases. This can\nbe used to match sensitive information specific to the data, such as a list\nof employee IDs or job titles.\n\nDictionary words are case-insensitive and all characters other than letters\nand digits in the unicode [Basic Multilingual\nPlane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)\nwill be replaced with whitespace when scanning for matches, so the\ndictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\",\n\"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters\nsurrounding any match must be of a different type than the adjacent\ncharacters within the word, so letters must be next to non-letters and\ndigits next to non-digits. For example, the dictionary word \"jen\" will\nmatch the first three letters of the text \"jen123\" but will return no\nmatches for \"jennifer\".\n\nDictionary words containing a large number of characters that are not\nletters or digits may result in unexpected findings because such characters\nare treated as whitespace.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2InfoType"
},
"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": {
- "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.",
@@ -1449,13 +1322,17 @@
"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",
- "description": "Options defining a data set within Google Cloud Datastore.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1DatastoreOptions"
},
"GooglePrivacyDlpV2beta2RiskAnalysisJobConfig": {
+ "description": "Configuration for a risk analysis job.",
+ "type": "object",
"properties": {
"sourceTable": {
"description": "Input dataset to compute metrics over.",
@@ -1466,28 +1343,7 @@
"description": "Privacy metric to compute."
}
},
- "id": "GooglePrivacyDlpV2beta2RiskAnalysisJobConfig",
- "description": "Configuration for a risk analysis job.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2StorageConfig": {
- "properties": {
- "datastoreOptions": {
- "$ref": "GooglePrivacyDlpV2beta2DatastoreOptions",
- "description": "Google Cloud Datastore options specification."
- },
- "bigQueryOptions": {
- "$ref": "GooglePrivacyDlpV2beta2BigQueryOptions",
- "description": "BigQuery options specification."
- },
- "cloudStorageOptions": {
- "description": "Google Cloud Storage options specification.",
- "$ref": "GooglePrivacyDlpV2beta2CloudStorageOptions"
- }
- },
- "id": "GooglePrivacyDlpV2beta2StorageConfig",
- "description": "Shared message indicating Cloud storage type.",
- "type": "object"
+ "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.",
@@ -1501,7 +1357,28 @@
},
"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]",
@@ -1511,9 +1388,7 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta2InfoTypeTransformations",
- "description": "A type of transformation that will scan unstructured text and\napply various `PrimitiveTransformation`s to each finding, where the\ntransformation is applied to only values that were identified as a specific\ninfo_type.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2InfoTypeTransformations"
},
"GooglePrivacyDlpV2beta2KAnonymityHistogramBucket": {
"type": "object",
@@ -1552,6 +1427,8 @@
"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.",
@@ -1567,9 +1444,7 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ],
- "description": "Only returns findings equal or above this threshold.",
- "type": "string"
+ ]
},
"infoTypeLimits": {
"description": "Configuration of findings limit given for specified info types.",
@@ -1604,8 +1479,31 @@
},
"id": "GooglePrivacyDlpV2beta1InspectConfig"
},
- "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"
+ },
+ "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": {
+ "timeValue": {
+ "$ref": "GoogleTypeTimeOfDay"
+ },
+ "integerValue": {
+ "format": "int64",
+ "type": "string"
+ },
+ "stringValue": {
+ "type": "string"
+ },
"dateValue": {
"$ref": "GoogleTypeDate"
},
@@ -1619,64 +1517,41 @@
"floatValue": {
"format": "double",
"type": "number"
- },
- "timeValue": {
- "$ref": "GoogleTypeTimeOfDay"
- },
- "integerValue": {
- "format": "int64",
- "type": "string"
- },
- "stringValue": {
- "type": "string"
}
},
- "id": "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"
- },
- "GooglePrivacyDlpV2beta1Projection": {
- "description": "A representation of a Datastore property in a projection.",
- "type": "object",
- "properties": {
- "property": {
- "$ref": "GooglePrivacyDlpV2beta1PropertyReference",
- "description": "The property to project."
- }
- },
- "id": "GooglePrivacyDlpV2beta1Projection"
+ "id": "GooglePrivacyDlpV2beta2Value"
},
"GooglePrivacyDlpV2beta2ImageRedactionConfig": {
+ "description": "Configuration for determining how redaction of images should occur.",
+ "type": "object",
"properties": {
- "redactAllText": {
- "description": "If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted.",
- "type": "boolean"
- },
"infoType": {
"$ref": "GooglePrivacyDlpV2beta2InfoType",
"description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig."
},
"redactionColor": {
- "description": "The color to use when redacting content from an image. If not specified,\nthe default is black.",
- "$ref": "GooglePrivacyDlpV2beta2Color"
+ "$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"
}
},
- "id": "GooglePrivacyDlpV2beta2ImageRedactionConfig",
- "description": "Configuration for determining how redaction of images should occur.",
- "type": "object"
+ "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."
+ "description": "If run with an inspect template, a snapshot of it's state at the time of\nthis run.",
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
},
"jobConfig": {
"$ref": "GooglePrivacyDlpV2beta2InspectJobConfig"
}
},
- "id": "GooglePrivacyDlpV2beta2RequestedOptions",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2RequestedOptions"
},
"GoogleTypeDate": {
"description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
@@ -1715,22 +1590,20 @@
"id": "GooglePrivacyDlpV2beta2ListInfoTypesResponse"
},
"GooglePrivacyDlpV2beta2FileSet": {
+ "description": "Set of files to scan.",
+ "type": "object",
"properties": {
"url": {
"description": "The url, in the format `gs://\u003cbucket\u003e/\u003cpath\u003e`. Trailing wildcard in the\npath is allowed.",
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2FileSet",
- "description": "Set of files to scan.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2FileSet"
},
"GooglePrivacyDlpV2beta1CustomInfoType": {
+ "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": {
"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"
@@ -1738,41 +1611,43 @@
"dictionary": {
"description": "Dictionary-based custom info type.",
"$ref": "GooglePrivacyDlpV2beta1Dictionary"
+ },
+ "surrogateType": {
+ "$ref": "GooglePrivacyDlpV2beta1SurrogateType",
+ "description": "Surrogate info type."
}
},
- "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"
+ "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",
- "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"
+ "id": "GooglePrivacyDlpV2beta1EntityId"
},
"GooglePrivacyDlpV2beta1AuxiliaryTable": {
"description": "An auxiliary table contains statistical information on the relative\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable).",
"type": "object",
"properties": {
- "relativeFrequency": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero.\n[required]"
- },
- "table": {
- "description": "Auxiliary table location. [required]",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
- },
"quasiIds": {
"description": "Quasi-identifier columns. [required]",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1QuasiIdField"
}
+ },
+ "relativeFrequency": {
+ "$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": {
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
+ "description": "Auxiliary table location. [required]"
}
},
"id": "GooglePrivacyDlpV2beta1AuxiliaryTable"
@@ -1785,11 +1660,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": {
@@ -1819,34 +1694,27 @@
"id": "GooglePrivacyDlpV2beta1KMapEstimationResult"
},
"GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest": {
+ "description": "Request message for CreateDeidentifyTemplate.",
+ "type": "object",
"properties": {
- "deidentifyTemplate": {
- "description": "The DeidentifyTemplate to create.",
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
"templateId": {
"description": "The template id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.",
"type": "string"
+ },
+ "deidentifyTemplate": {
+ "description": "The DeidentifyTemplate to create.",
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
}
},
- "id": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest",
- "description": "Request message for CreateDeidentifyTemplate.",
- "type": "object"
+ "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": {
- "imageRedactionConfigs": {
- "description": "The configuration for specifying what content to redact from images.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2ImageRedactionConfig"
- }
- },
"inspectConfig": {
- "$ref": "GooglePrivacyDlpV2beta2InspectConfig",
- "description": "Configuration for the inspector."
+ "description": "Configuration for the inspector.",
+ "$ref": "GooglePrivacyDlpV2beta2InspectConfig"
},
"imageData": {
"description": "The bytes of the image to redact.",
@@ -1856,28 +1724,35 @@
"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"
}
+ },
+ "estimatedAnonymity": {
+ "description": "The estimated anonymity for these quasi-identifier values.",
+ "format": "int64",
+ "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues",
- "description": "A tuple of values for the quasi-identifier columns.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues"
},
"GooglePrivacyDlpV2beta2WordList": {
"description": "Message defining a list of words or phrases to search for in the data.",
@@ -1894,7 +1769,13 @@
"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"
@@ -1907,15 +1788,9 @@
"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": "GooglePrivacyDlpV2beta2ContentItem",
- "description": "Container structure for the content to inspect.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2ContentItem"
},
"GooglePrivacyDlpV2beta2CategoricalStatsResult": {
"description": "Result of the categorical stats computation.",
@@ -1932,35 +1807,33 @@
"id": "GooglePrivacyDlpV2beta2CategoricalStatsResult"
},
"GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig": {
- "properties": {},
- "id": "GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig",
"description": "Replace each matching finding with the name of the info_type.",
- "type": "object"
+ "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": {
+ "partitionId": {
+ "$ref": "GooglePrivacyDlpV2beta2PartitionId",
+ "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
+ },
"path": {
"description": "The entity path.\nAn entity path consists of one or more elements composed of a kind and a\nstring or numerical identifier, which identify entities. The first\nelement identifies a _root entity_, the second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nA path can never be empty, and a path can have at most 100 elements.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta2PathElement"
}
- },
- "partitionId": {
- "$ref": "GooglePrivacyDlpV2beta2PartitionId",
- "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
}
},
- "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"
+ "id": "GooglePrivacyDlpV2beta2Key"
},
"GooglePrivacyDlpV2beta1BigQueryTable": {
+ "description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.",
+ "type": "object",
"properties": {
- "datasetId": {
- "description": "Dataset ID of the table.",
- "type": "string"
- },
"tableId": {
"description": "Name of the table.",
"type": "string"
@@ -1968,14 +1841,26 @@
"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"
+ "id": "GooglePrivacyDlpV2beta1BigQueryTable"
},
"GooglePrivacyDlpV2beta2FieldTransformation": {
+ "description": "The transformation to apply to the field.",
+ "type": "object",
"properties": {
+ "condition": {
+ "$ref": "GooglePrivacyDlpV2beta2RecordCondition",
+ "description": "Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85."
+ },
+ "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",
@@ -1984,21 +1869,11 @@
}
},
"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"
- },
- "infoTypeTransformations": {
- "$ref": "GooglePrivacyDlpV2beta2InfoTypeTransformations",
- "description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`."
+ "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation",
+ "description": "Apply the transformation to the entire field."
}
},
- "id": "GooglePrivacyDlpV2beta2FieldTransformation",
- "description": "The transformation to apply to the field.",
- "type": "object"
+ "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.",
@@ -2025,84 +1900,84 @@
"type": "object",
"properties": {
"condition": {
- "description": "A condition that when it evaluates to true will result in the record being\nevaluated to be suppressed from the transformed content.",
- "$ref": "GooglePrivacyDlpV2beta2RecordCondition"
+ "$ref": "GooglePrivacyDlpV2beta2RecordCondition",
+ "description": "A condition that when it evaluates to true will result in the record being\nevaluated to be suppressed from the transformed content."
}
},
"id": "GooglePrivacyDlpV2beta2RecordSuppression"
},
"GooglePrivacyDlpV2beta1KindExpression": {
+ "description": "A representation of a Datastore kind.",
+ "type": "object",
"properties": {
"name": {
"description": "The name of the kind.",
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1KindExpression",
- "description": "A representation of a Datastore kind.",
- "type": "object"
+ "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."
+ "description": "Field to compute numerical stats on. Supported types are\ninteger, float, date, datetime, timestamp, time.",
+ "$ref": "GooglePrivacyDlpV2beta2FieldId"
}
},
- "id": "GooglePrivacyDlpV2beta2NumericalStatsConfig",
- "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
- "type": "object"
+ "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. If table_id is not\nset a new one will be generated for you with the following format:\ndlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for\ngenerating the date details."
+ "description": "Store findings in a new table in an existing dataset. If table_id is not\nset a new one will be generated for you with the following format:\ndlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for\ngenerating the date details.",
+ "$ref": "GooglePrivacyDlpV2beta2BigQueryTable"
}
},
- "id": "GooglePrivacyDlpV2beta2OutputStorageConfig",
- "description": "Cloud repository for storing output.",
- "type": "object"
+ "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"
- },
- "infoType": {
- "description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that\nare found but not specified in another InfoTypeLimit.",
- "$ref": "GooglePrivacyDlpV2beta2InfoType"
}
},
"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",
- "description": "Set of files to scan.",
- "type": "object"
+ "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"
- },
- "infoType": {
- "$ref": "GooglePrivacyDlpV2beta2InfoType",
- "description": "The type of finding this stat is for."
}
},
"id": "GooglePrivacyDlpV2beta2InfoTypeStatistics"
@@ -2150,17 +2025,17 @@
"description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed.",
"type": "object",
"properties": {
- "rows": {
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2Row"
- }
- },
"headers": {
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta2FieldId"
}
+ },
+ "rows": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2Row"
+ }
}
},
"id": "GooglePrivacyDlpV2beta2Table"
@@ -2183,11 +2058,6 @@
"description": "Histogram bucket of value frequencies in the column.",
"type": "object",
"properties": {
- "valueFrequencyUpperBound": {
- "description": "Upper bound on the value frequency of the values in this bucket.",
- "format": "int64",
- "type": "string"
- },
"valueFrequencyLowerBound": {
"description": "Lower bound on the value frequency of the values in this bucket.",
"format": "int64",
@@ -2204,6 +2074,11 @@
"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"
@@ -2221,6 +2096,7 @@
"type": "string"
},
"code": {
+ "type": "string",
"enumDescriptions": [
"",
"",
@@ -2230,8 +2106,7 @@
"TRANSFORMATION_RESULT_CODE_UNSPECIFIED",
"SUCCESS",
"ERROR"
- ],
- "type": "string"
+ ]
}
},
"id": "GooglePrivacyDlpV2beta2SummaryResult"
@@ -2258,13 +2133,13 @@
"description": "Generic half-open interval [start, end)",
"type": "object",
"properties": {
- "start": {
- "description": "Index of the first character of the range (inclusive).",
+ "end": {
+ "description": "Index of the last character of the range (exclusive).",
"format": "int64",
"type": "string"
},
- "end": {
- "description": "Index of the last character of the range (exclusive).",
+ "start": {
+ "description": "Index of the first character of the range (inclusive).",
"format": "int64",
"type": "string"
}
@@ -2272,26 +2147,24 @@
"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."
+ "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table.",
+ "$ref": "GooglePrivacyDlpV2beta2RecordTransformations"
},
"infoTypeTransformations": {
"description": "Treat the dataset as free-form text and apply the same free text\ntransformation everywhere.",
"$ref": "GooglePrivacyDlpV2beta2InfoTypeTransformations"
}
},
- "id": "GooglePrivacyDlpV2beta2DeidentifyConfig",
- "description": "The configuration that controls how the data will change.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2DeidentifyConfig"
},
"GooglePrivacyDlpV2beta2KMapEstimationConfig": {
+ "description": "Reidentifiability metric. This corresponds to a risk model similar to what\nis called \"journalist risk\" in the literature, except the attack dataset is\nstatistically modeled instead of being perfectly known. This can be done\nusing publicly available data (like the US Census), or using a custom\nstatistical model (indicated as one or several BigQuery tables), or by\nextrapolating from the distribution of values in the input dataset.",
+ "type": "object",
"properties": {
- "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",
@@ -2305,13 +2178,17 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta2TaggedField"
}
+ },
+ "regionCode": {
+ "description": "ISO 3166-1 alpha-2 region code to use in the statistical modeling.\nRequired if no column is tagged with a region-specific InfoType (like\nUS_ZIP_5) or a region code.",
+ "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2KMapEstimationConfig",
- "description": "Reidentifiability metric. This corresponds to a risk model similar to what\nis called \"journalist risk\" in the literature, except the attack dataset is\nstatistically modeled instead of being perfectly known. This can be done\nusing publicly available data (like the US Census), or using a custom\nstatistical model (indicated as one or several BigQuery tables), or by\nextrapolating from the distribution of values in the input dataset.",
- "type": "object"
+ "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.",
@@ -2321,9 +2198,29 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta2BucketingConfig",
- "description": "Generalization function that buckets values based on ranges. The ranges and\nreplacement values are dynamically provided by the user for custom behavior,\nsuch as 1-30 -\u003e LOW 31-65 -\u003e MEDIUM 66-100 -\u003e HIGH\nThis can be used on\ndata of type: number, long, string, timestamp.\nIf the bound `Value` type differs from the type of data being transformed, we\nwill first attempt converting the type of the data to be transformed to match\nthe type of the bound before comparing.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2BucketingConfig"
+ },
+ "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"
},
"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.",
@@ -2354,28 +2251,6 @@
},
"id": "GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket"
},
- "GooglePrivacyDlpV2beta2PrivacyMetric": {
- "properties": {
- "numericalStatsConfig": {
- "$ref": "GooglePrivacyDlpV2beta2NumericalStatsConfig"
- },
- "kAnonymityConfig": {
- "$ref": "GooglePrivacyDlpV2beta2KAnonymityConfig"
- },
- "categoricalStatsConfig": {
- "$ref": "GooglePrivacyDlpV2beta2CategoricalStatsConfig"
- },
- "kMapEstimationConfig": {
- "$ref": "GooglePrivacyDlpV2beta2KMapEstimationConfig"
- },
- "lDiversityConfig": {
- "$ref": "GooglePrivacyDlpV2beta2LDiversityConfig"
- }
- },
- "id": "GooglePrivacyDlpV2beta2PrivacyMetric",
- "description": "Privacy metric to compute for reidentification risk analysis.",
- "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",
@@ -2393,6 +2268,8 @@
"id": "GooglePrivacyDlpV2beta2KmsWrappedCryptoKey"
},
"GooglePrivacyDlpV2beta1QuasiIdField": {
+ "description": "A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.",
+ "type": "object",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2beta1FieldId"
@@ -2401,11 +2278,11 @@
"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"
+ "id": "GooglePrivacyDlpV2beta1QuasiIdField"
},
"GooglePrivacyDlpV2beta2KAnonymityResult": {
+ "description": "Result of the k-anonymity computation.",
+ "type": "object",
"properties": {
"equivalenceClassHistogramBuckets": {
"description": "Histogram of k-anonymity equivalence classes.",
@@ -2415,9 +2292,7 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta2KAnonymityResult",
- "description": "Result of the k-anonymity computation.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2KAnonymityResult"
},
"GooglePrivacyDlpV2beta2Result": {
"type": "object",
@@ -2446,10 +2321,6 @@
"description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.",
"type": "object",
"properties": {
- "surrogateType": {
- "description": "Surrogate info type.",
- "$ref": "GooglePrivacyDlpV2beta2SurrogateType"
- },
"infoType": {
"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"
@@ -2457,24 +2328,79 @@
"dictionary": {
"$ref": "GooglePrivacyDlpV2beta2Dictionary",
"description": "Dictionary-based custom info type."
+ },
+ "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": {
- "$ref": "GooglePrivacyDlpV2beta2ContentItem",
- "description": "The de-identified item."
+ "description": "The de-identified item.",
+ "$ref": "GooglePrivacyDlpV2beta2ContentItem"
}
},
- "id": "GooglePrivacyDlpV2beta2DeidentifyContentResponse",
- "description": "Results of de-identifying a ContentItem.",
- "type": "object"
+ "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": {
+ "cryptoKey": {
+ "description": "The key used by the encryption algorithm. [required]",
+ "$ref": "GooglePrivacyDlpV2beta2CryptoKey"
+ },
+ "context": {
+ "$ref": "GooglePrivacyDlpV2beta2FieldId",
+ "description": "The 'tweak', a context may be used for higher security since the same\nidentifier in two different contexts won't be given the same surrogate. If\nthe context is not set, a default tweak will be used.\n\nIf the context is set but:\n\n1. there is no record present when transforming a given value or\n1. the field is not present when transforming a given value,\n\na default tweak will be used.\n\nNote that case (1) is expected when an `InfoTypeTransformation` is\napplied to both structured and non-structured `ContentItem`s.\nCurrently, the referenced field may be of value type integer or string.\n\nThe tweak is constructed as a sequence of bytes in big endian byte order\nsuch that:\n\n- a 64 bit integer is encoded followed by a single byte of value 1\n- a string is encoded in UTF-8 format followed by a single byte of value\n å 2"
+ },
+ "surrogateInfoType": {
+ "$ref": "GooglePrivacyDlpV2beta2InfoType",
+ "description": "The custom infoType to annotate the surrogate with.\nThis annotation will be applied to the surrogate by prefixing it with\nthe name of the custom infoType followed by the number of\ncharacters comprising the surrogate. The following scheme defines the\nformat: info_type_name(surrogate_character_count):surrogate\n\nFor example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and\nthe surrogate is 'abc', the full replacement value\nwill be: 'MY_TOKEN_INFO_TYPE(3):abc'\n\nThis annotation identifies the surrogate when inspecting content using the\ncustom infoType\n[`SurrogateType`](/dlp/docs/reference/rest/v2beta2/InspectConfig#surrogatetype).\nThis facilitates reversal of the surrogate when it occurs in free text.\n\nIn order for inspection to work properly, the name of this infoType must\nnot occur naturally anywhere in your data; otherwise, inspection may\nfind a surrogate that does not correspond to an actual identifier.\nTherefore, choose your custom infoType name carefully after considering\nwhat your data looks like. One way to select a name that has a high chance\nof yielding reliable detection is to include one or more unicode characters\nthat are highly improbable to exist in your data.\nFor example, assuming your data is entered from a regular ASCII keyboard,\nthe symbol with the hex code point 29DD might be used like so:\n⧝MY_TOKEN_TYPE"
+ },
+ "commonAlphabet": {
+ "enumDescriptions": [
+ "",
+ "[0-9] (radix of 10)",
+ "[0-9A-F] (radix of 16)",
+ "[0-9A-Z] (radix of 36)",
+ "[0-9A-Za-z] (radix of 62)"
+ ],
+ "enum": [
+ "FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED",
+ "NUMERIC",
+ "HEXADECIMAL",
+ "UPPER_CASE_ALPHA_NUMERIC",
+ "ALPHA_NUMERIC"
+ ],
+ "type": "string"
+ },
+ "radix": {
+ "description": "The native way to select the alphabet. Must be in the range [2, 62].",
+ "format": "int32",
+ "type": "integer"
+ },
+ "customAlphabet": {
+ "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"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig"
+ },
+ "GooglePrivacyDlpV2beta1SurrogateType": {
+ "description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.",
+ "type": "object",
+ "properties": {},
+ "id": "GooglePrivacyDlpV2beta1SurrogateType"
},
"GooglePrivacyDlpV2beta1ValueFrequency": {
"description": "A value of a field, including its frequency.",
@@ -2486,62 +2412,34 @@
"type": "string"
},
"value": {
- "description": "A value contained in the field in question.",
- "$ref": "GooglePrivacyDlpV2beta1Value"
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "A value contained in the field in question."
}
},
"id": "GooglePrivacyDlpV2beta1ValueFrequency"
},
- "GooglePrivacyDlpV2beta1SurrogateType": {
- "properties": {},
- "id": "GooglePrivacyDlpV2beta1SurrogateType",
- "description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig": {
+ "GooglePrivacyDlpV2beta2FindingLimits": {
+ "type": "object",
"properties": {
- "customAlphabet": {
- "description": "This is supported by mapping these to the alphanumeric characters\nthat the FFX mode natively supports. This happens before/after\nencryption/decryption.\nEach character listed must appear only once.\nNumber of characters must be in the range [2, 62].\nThis must be encoded as ASCII.\nThe order of characters does not matter.",
- "type": "string"
- },
- "cryptoKey": {
- "$ref": "GooglePrivacyDlpV2beta2CryptoKey",
- "description": "The key used by the encryption algorithm. [required]"
- },
- "context": {
- "description": "The 'tweak', a context may be used for higher security since the same\nidentifier in two different contexts won't be given the same surrogate. If\nthe context is not set, a default tweak will be used.\n\nIf the context is set but:\n\n1. there is no record present when transforming a given value or\n1. the field is not present when transforming a given value,\n\na default tweak will be used.\n\nNote that case (1) is expected when an `InfoTypeTransformation` is\napplied to both structured and non-structured `ContentItem`s.\nCurrently, the referenced field may be of value type integer or string.\n\nThe tweak is constructed as a sequence of bytes in big endian byte order\nsuch that:\n\n- a 64 bit integer is encoded followed by a single byte of value 1\n- a string is encoded in UTF-8 format followed by a single byte of value\n å 2",
- "$ref": "GooglePrivacyDlpV2beta2FieldId"
- },
- "surrogateInfoType": {
- "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",
- "$ref": "GooglePrivacyDlpV2beta2InfoType"
- },
- "commonAlphabet": {
- "enum": [
- "FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED",
- "NUMERIC",
- "HEXADECIMAL",
- "UPPER_CASE_ALPHA_NUMERIC",
- "ALPHA_NUMERIC"
- ],
- "type": "string",
- "enumDescriptions": [
- "",
- "[0-9] (radix of 10)",
- "[0-9A-F] (radix of 16)",
- "[0-9A-Z] (radix of 36)",
- "[0-9A-Za-z] (radix of 62)"
- ]
- },
- "radix": {
- "description": "The native way to select the alphabet. Must be in the range [2, 62].",
+ "maxFindingsPerItem": {
+ "description": "Max number of findings that will be returned for each item scanned.",
"format": "int32",
"type": "integer"
+ },
+ "maxFindingsPerRequest": {
+ "description": "Max total number of findings that will be returned per request/job.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxFindingsPerInfoType": {
+ "description": "Configuration of findings limit given for specified infoTypes.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2InfoTypeLimit"
+ }
}
},
- "id": "GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig",
- "description": "Replaces an identifier with a surrogate using FPE with the FFX\nmode of operation; however when used in the `ReidentifyContent` API method,\nit serves the opposite function by reversing the surrogate back into\nthe original identifier.\nThe identifier must be encoded as ASCII.\nFor a given crypto key and context, the same identifier will be\nreplaced with the same surrogate.\nIdentifiers must be at least two characters long.\nIn the case that the identifier is the empty string, it will be skipped.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2FindingLimits"
},
"GooglePrivacyDlpV2beta1InfoTypeLimit": {
"description": "Max findings configuration per info type, per content item or long running\noperation.",
@@ -2559,66 +2457,16 @@
},
"id": "GooglePrivacyDlpV2beta1InfoTypeLimit"
},
- "GooglePrivacyDlpV2beta2FindingLimits": {
- "properties": {
- "maxFindingsPerInfoType": {
- "description": "Configuration of findings limit given for specified infoTypes.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2InfoTypeLimit"
- }
- },
- "maxFindingsPerItem": {
- "description": "Max number of findings that will be returned for each item scanned.",
- "format": "int32",
- "type": "integer"
- },
- "maxFindingsPerRequest": {
- "description": "Max total number of findings that will be returned per request/job.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GooglePrivacyDlpV2beta2FindingLimits",
- "type": "object"
- },
"GooglePrivacyDlpV2beta2DlpJob": {
+ "description": "Combines all of the information about a DLP job.",
+ "type": "object",
"properties": {
- "endTime": {
- "description": "Time when the job finished.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Time when the job started.",
- "format": "google-datetime",
- "type": "string"
- },
- "inspectDetails": {
- "$ref": "GooglePrivacyDlpV2beta2InspectDataSourceDetails",
- "description": "Results from inspecting a data source."
- },
- "errorResults": {
- "description": "A stream of errors encountered running the job.",
- "type": "array",
- "items": {
- "$ref": "GoogleRpcStatus"
- }
- },
"createTime": {
"description": "Time when the job was created.",
"format": "google-datetime",
"type": "string"
},
"state": {
- "enum": [
- "JOB_STATE_UNSPECIFIED",
- "PENDING",
- "RUNNING",
- "DONE",
- "CANCELED",
- "FAILED"
- ],
"description": "State of a job.",
"type": "string",
"enumDescriptions": [
@@ -2628,11 +2476,19 @@
"The job is no longer running.",
"The job was canceled before it could complete.",
"The job had an error and did not complete."
+ ],
+ "enum": [
+ "JOB_STATE_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "DONE",
+ "CANCELED",
+ "FAILED"
]
},
"riskDetails": {
- "description": "Results from analyzing risk of a data source.",
- "$ref": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails"
+ "$ref": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails",
+ "description": "Results from analyzing risk of a data source."
},
"name": {
"description": "The server-assigned name.",
@@ -2651,14 +2507,51 @@
],
"description": "The type of job.",
"type": "string"
+ },
+ "endTime": {
+ "description": "Time when the job finished.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Time when the job started.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "inspectDetails": {
+ "description": "Results from inspecting a data source.",
+ "$ref": "GooglePrivacyDlpV2beta2InspectDataSourceDetails"
+ },
+ "errorResults": {
+ "description": "A stream of errors encountered running the job.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleRpcStatus"
+ }
}
},
- "id": "GooglePrivacyDlpV2beta2DlpJob",
- "description": "Combines all of the information about a DLP job.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2DlpJob"
+ },
+ "GooglePrivacyDlpV2beta2Dictionary": {
+ "description": "Custom information type based on a dictionary of words or phrases. This can\nbe used to match sensitive information specific to the data, such as a list\nof employee IDs or job titles.\n\nDictionary words are case-insensitive and all characters other than letters\nand digits in the unicode [Basic Multilingual\nPlane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)\nwill be replaced with whitespace when scanning for matches, so the\ndictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\",\n\"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters\nsurrounding any match must be of a different type than the adjacent\ncharacters within the word, so letters must be next to non-letters and\ndigits next to non-digits. For example, the dictionary word \"jen\" will\nmatch the first three letters of the text \"jen123\" but will return no\nmatches for \"jennifer\".\n\nDictionary words containing a large number of characters that are not\nletters or digits may result in unexpected findings because such characters\nare treated as whitespace.",
+ "type": "object",
+ "properties": {
+ "wordList": {
+ "description": "List of words or phrases to search for.",
+ "$ref": "GooglePrivacyDlpV2beta2WordList"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2Dictionary"
},
"GooglePrivacyDlpV2beta1LDiversityHistogramBucket": {
+ "description": "Histogram bucket of sensitive value frequencies in the table.",
+ "type": "object",
"properties": {
+ "bucketSize": {
+ "description": "Total number of records in this bucket.",
+ "format": "int64",
+ "type": "string"
+ },
"sensitiveValueFrequencyUpperBound": {
"description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.",
"format": "int64",
@@ -2675,32 +2568,28 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass"
}
- },
- "bucketSize": {
- "description": "Total number of records in this bucket.",
- "format": "int64",
- "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket",
- "description": "Histogram bucket of sensitive value frequencies in the table.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2Dictionary": {
- "properties": {
- "wordList": {
- "$ref": "GooglePrivacyDlpV2beta2WordList",
- "description": "List of words or phrases to search for."
- }
- },
- "id": "GooglePrivacyDlpV2beta2Dictionary",
- "description": "Custom information type based on a dictionary of words or phrases. This can\nbe used to match sensitive information specific to the data, such as a list\nof employee IDs or job titles.\n\nDictionary words are case-insensitive and all characters other than letters\nand digits in the unicode [Basic Multilingual\nPlane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)\nwill be replaced with whitespace when scanning for matches, so the\ndictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\",\n\"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters\nsurrounding any match must be of a different type than the adjacent\ncharacters within the word, so letters must be next to non-letters and\ndigits next to non-digits. For example, the dictionary word \"jen\" will\nmatch the first three letters of the text \"jen123\" but will return no\nmatches for \"jennifer\".\n\nDictionary words containing a large number of characters that are not\nletters or digits may result in unexpected findings because such characters\nare treated as whitespace.",
- "type": "object"
+ "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": {
+ "floatValue": {
+ "format": "double",
+ "type": "number"
+ },
+ "integerValue": {
+ "format": "int64",
+ "type": "string"
+ },
+ "timeValue": {
+ "$ref": "GoogleTypeTimeOfDay"
+ },
+ "stringValue": {
+ "type": "string"
+ },
"dateValue": {
"$ref": "GoogleTypeDate"
},
@@ -2710,20 +2599,6 @@
},
"booleanValue": {
"type": "boolean"
- },
- "floatValue": {
- "format": "double",
- "type": "number"
- },
- "timeValue": {
- "$ref": "GoogleTypeTimeOfDay"
- },
- "integerValue": {
- "format": "int64",
- "type": "string"
- },
- "stringValue": {
- "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta1Value"
@@ -2739,14 +2614,20 @@
},
"id": "GooglePrivacyDlpV2beta2RecordCondition"
},
+ "GooglePrivacyDlpV2beta2KindExpression": {
+ "description": "A representation of a Datastore kind.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the kind.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2KindExpression"
+ },
"GooglePrivacyDlpV2beta2LDiversityHistogramBucket": {
"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",
@@ -2763,35 +2644,29 @@
"description": "Total number of equivalence classes in this bucket.",
"format": "int64",
"type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2LDiversityHistogramBucket"
- },
- "GooglePrivacyDlpV2beta2KindExpression": {
- "description": "A representation of a Datastore kind.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the kind.",
+ },
+ "sensitiveValueFrequencyUpperBound": {
+ "description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.",
+ "format": "int64",
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2KindExpression"
+ "id": "GooglePrivacyDlpV2beta2LDiversityHistogramBucket"
},
"GooglePrivacyDlpV2beta2InspectResult": {
"description": "All the findings for a single scanned item.",
"type": "object",
"properties": {
+ "findingsTruncated": {
+ "description": "If true, then this item might have more findings than were returned,\nand the findings returned are an arbitrary subset of all findings.\nThe findings list might be truncated because the input items were too\nlarge, or because the server reached the maximum amount of resources\nallowed for a single API call. For best results, divide the input into\nsmaller batches.",
+ "type": "boolean"
+ },
"findings": {
"description": "List of findings for an item.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta2Finding"
}
- },
- "findingsTruncated": {
- "description": "If true, then this item might have more findings than were returned,\nand the findings returned are an arbitrary subset of all findings.\nThe findings list might be truncated because the input items were too\nlarge, or because the server reached the maximum amount of resources\nallowed for a single API call. For best results, divide the input into\nsmaller batches.",
- "type": "boolean"
}
},
"id": "GooglePrivacyDlpV2beta2InspectResult"
@@ -2800,13 +2675,13 @@
"description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.",
"type": "object",
"properties": {
- "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"
+ },
+ "namespaceId": {
+ "description": "If not empty, the ID of the namespace to which the entities belong.",
+ "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta1PartitionId"
@@ -2823,8 +2698,19 @@
"id": "GooglePrivacyDlpV2beta2CryptoHashConfig"
},
"GooglePrivacyDlpV2beta2TimePartConfig": {
+ "description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.",
+ "type": "object",
"properties": {
"partToExtract": {
+ "enumDescriptions": [
+ "",
+ "[0-9999]",
+ "[1-12]",
+ "[1-31]",
+ "[1-7]",
+ "[1-52]",
+ "[0-23]"
+ ],
"enum": [
"TIME_PART_UNSPECIFIED",
"YEAR",
@@ -2834,29 +2720,15 @@
"WEEK_OF_YEAR",
"HOUR_OF_DAY"
],
- "type": "string",
- "enumDescriptions": [
- "",
- "[0-9999]",
- "[1-12]",
- "[1-31]",
- "[1-7]",
- "[1-52]",
- "[0-23]"
- ]
+ "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2TimePartConfig",
- "description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2TimePartConfig"
},
"GooglePrivacyDlpV2beta2ImageLocation": {
+ "description": "Bounding box encompassing detected text within an image.",
+ "type": "object",
"properties": {
- "height": {
- "description": "Height of the bounding box in pixels.",
- "format": "int32",
- "type": "integer"
- },
"top": {
"description": "Top coordinate of the bounding box. (0,0) is upper left.",
"format": "int32",
@@ -2871,13 +2743,18 @@
"description": "Width of the bounding box in pixels.",
"format": "int32",
"type": "integer"
+ },
+ "height": {
+ "description": "Height of the bounding box in pixels.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "GooglePrivacyDlpV2beta2ImageLocation",
- "description": "Bounding box encompassing detected text within an image.",
- "type": "object"
+ "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]",
@@ -2887,9 +2764,7 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta1WordList",
- "description": "Message defining a list of words or phrases to search for in the data.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1WordList"
},
"GooglePrivacyDlpV2beta1FieldId": {
"description": "General identifier of a data field in a storage service.",
@@ -2903,6 +2778,8 @@
"id": "GooglePrivacyDlpV2beta1FieldId"
},
"GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest": {
+ "description": "Request message for UpdateInspectTemplate.",
+ "type": "object",
"properties": {
"updateMask": {
"description": "Mask to control which fields get updated.",
@@ -2914,22 +2791,22 @@
"description": "New InspectTemplate value."
}
},
- "id": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest",
- "description": "Request message for UpdateInspectTemplate.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest"
},
"GooglePrivacyDlpV2beta2InspectDataSourceRequest": {
+ "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
+ "type": "object",
"properties": {
"jobConfig": {
- "$ref": "GooglePrivacyDlpV2beta2InspectJobConfig",
- "description": "A configuration for the job."
+ "description": "A configuration for the job.",
+ "$ref": "GooglePrivacyDlpV2beta2InspectJobConfig"
}
},
- "id": "GooglePrivacyDlpV2beta2InspectDataSourceRequest",
- "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2InspectDataSourceRequest"
},
"GooglePrivacyDlpV2beta2Expressions": {
+ "description": "An expression, consisting or an operator and conditions.",
+ "type": "object",
"properties": {
"logicalOperator": {
"enumDescriptions": [
@@ -2947,19 +2824,23 @@
"$ref": "GooglePrivacyDlpV2beta2Conditions"
}
},
- "id": "GooglePrivacyDlpV2beta2Expressions",
- "description": "An expression, consisting or an operator and conditions.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2Expressions"
},
"GooglePrivacyDlpV2beta2TransformationSummary": {
+ "description": "Summary of a single tranformation.\nOnly one of 'transformation', 'field_transformation', or 'record_suppress'\nwill be set.",
+ "type": "object",
"properties": {
"infoType": {
"$ref": "GooglePrivacyDlpV2beta2InfoType",
"description": "Set if the transformation was limited to a specific info_type."
},
"transformation": {
- "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation",
- "description": "The specific transformation these stats apply to."
+ "description": "The specific transformation these stats apply to.",
+ "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation"
+ },
+ "field": {
+ "$ref": "GooglePrivacyDlpV2beta2FieldId",
+ "description": "Set if the transformation was limited to a specific FieldId."
},
"results": {
"type": "array",
@@ -2967,10 +2848,6 @@
"$ref": "GooglePrivacyDlpV2beta2SummaryResult"
}
},
- "field": {
- "$ref": "GooglePrivacyDlpV2beta2FieldId",
- "description": "Set if the transformation was limited to a specific FieldId."
- },
"fieldTransformations": {
"description": "The field transformation that was applied.\nIf multiple field transformations are requested for a single field,\nthis list will contain all of them; otherwise, only one is supplied.",
"type": "array",
@@ -2988,9 +2865,7 @@
"description": "The specific suppression option these stats apply to."
}
},
- "id": "GooglePrivacyDlpV2beta2TransformationSummary",
- "description": "Summary of a single tranformation.\nOnly one of 'transformation', 'field_transformation', or 'record_suppress'\nwill be set.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2TransformationSummary"
},
"GooglePrivacyDlpV2beta2FixedSizeBucketingConfig": {
"description": "Buckets values based on fixed size ranges. The\nBucketing transformation can provide all of this functionality,\nbut requires more configuration. This message is provided as a convenience to\nthe user for simple bucketing strategies.\n\nThe transformed value will be a hyphenated string of\n\u003clower_bound\u003e-\u003cupper_bound\u003e, i.e if lower_bound = 10 and upper_bound = 20\nall values that are within this bucket will be replaced with \"10-20\".\n\nThis can be used on data of type: double, long.\n\nIf the bound Value type differs from the type of data\nbeing transformed, we will first attempt converting the type of the data to\nbe transformed to match the type of the bound before comparing.",
@@ -3019,6 +2894,7 @@
"id": "GooglePrivacyDlpV2beta2CancelDlpJobRequest"
},
"GooglePrivacyDlpV2beta2Row": {
+ "type": "object",
"properties": {
"values": {
"type": "array",
@@ -3027,10 +2903,11 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta2Row",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2Row"
},
"GooglePrivacyDlpV2beta2Finding": {
+ "description": "Represents a piece of potentially sensitive content.",
+ "type": "object",
"properties": {
"infoType": {
"description": "The type of content that might have been found.\nProvided if requested by the `InspectConfig`.",
@@ -3070,16 +2947,12 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2Finding",
- "description": "Represents a piece of potentially sensitive content.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2Finding"
},
"GooglePrivacyDlpV2beta1TaggedField": {
+ "description": "A column with a semantic tag attached.",
+ "type": "object",
"properties": {
- "customTag": {
- "description": "A column can be tagged with a custom tag. In this case, the user must\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).",
- "type": "string"
- },
"infoType": {
"$ref": "GooglePrivacyDlpV2beta1InfoType",
"description": "A column can be tagged with a InfoType to use the relevant public\ndataset as a statistical model of population, if available. We\ncurrently support US ZIP codes, region codes, ages and genders."
@@ -3091,42 +2964,56 @@
"field": {
"$ref": "GooglePrivacyDlpV2beta1FieldId",
"description": "Identifies the column. [required]"
+ },
+ "customTag": {
+ "description": "A column can be tagged with a custom tag. In this case, the user must\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).",
+ "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1TaggedField",
- "description": "A column with a semantic tag attached.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1TaggedField"
},
"GooglePrivacyDlpV2beta2PartitionId": {
+ "description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.",
+ "type": "object",
"properties": {
- "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"
+ },
+ "namespaceId": {
+ "description": "If not empty, the ID of the namespace to which the entities belong.",
+ "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2PartitionId",
- "description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2PartitionId"
},
- "GooglePrivacyDlpV2beta2Conditions": {
+ "GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues": {
+ "description": "A tuple of values for the quasi-identifier columns.",
+ "type": "object",
"properties": {
- "conditions": {
+ "quasiIdsValues": {
+ "description": "The quasi-identifier values.",
"type": "array",
"items": {
- "$ref": "GooglePrivacyDlpV2beta2Condition"
+ "$ref": "GooglePrivacyDlpV2beta2Value"
}
+ },
+ "estimatedAnonymity": {
+ "description": "The estimated anonymity for these quasi-identifier values.",
+ "format": "int64",
+ "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2Conditions",
- "description": "A collection of conditions.",
- "type": "object"
+ "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",
@@ -3142,46 +3029,26 @@
"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": "GooglePrivacyDlpV2beta2CharacterMaskConfig",
- "description": "Partially mask a string by replacing a given number of characters with a\nfixed character. Masking can start from the beginning or end of the string.\nThis can be used on data of any type (numbers, longs, and so on) and when\nde-identifying structured data we'll attempt to preserve the original data's\ntype. (This allows you to take a long like 123 and modify it to a string like\n**3.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2CharacterMaskConfig"
},
- "GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues": {
+ "GooglePrivacyDlpV2beta2Conditions": {
+ "description": "A collection of conditions.",
+ "type": "object",
"properties": {
- "quasiIdsValues": {
- "description": "The quasi-identifier values.",
+ "conditions": {
"type": "array",
"items": {
- "$ref": "GooglePrivacyDlpV2beta2Value"
+ "$ref": "GooglePrivacyDlpV2beta2Condition"
}
- },
- "estimatedAnonymity": {
- "description": "The estimated anonymity for these quasi-identifier values.",
- "format": "int64",
- "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues",
- "description": "A tuple of values for the quasi-identifier columns.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2Conditions"
},
"GooglePrivacyDlpV2beta2InspectJobConfig": {
"type": "object",
"properties": {
- "storageConfig": {
- "description": "The data to scan.",
- "$ref": "GooglePrivacyDlpV2beta2StorageConfig"
- },
- "outputConfig": {
- "description": "Where to put the findings.",
- "$ref": "GooglePrivacyDlpV2beta2OutputStorageConfig"
- },
"inspectConfig": {
"description": "How and what to scan for.",
"$ref": "GooglePrivacyDlpV2beta2InspectConfig"
@@ -3189,11 +3056,21 @@
"inspectTemplateName": {
"description": "If provided, will be used as the default for all values in InspectConfig.\n`inspect_config` will be merged into the values persisted as part of the\ntemplate.",
"type": "string"
+ },
+ "storageConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2StorageConfig",
+ "description": "The data to scan."
+ },
+ "outputConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2OutputStorageConfig",
+ "description": "Where to put the findings."
}
},
"id": "GooglePrivacyDlpV2beta2InspectJobConfig"
},
"GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse": {
+ "description": "Response message for ListDeidentifyTemplates.",
+ "type": "object",
"properties": {
"deidentifyTemplates": {
"description": "List of deidentify templates, up to page_size in\nListDeidentifyTemplatesRequest.",
@@ -3207,11 +3084,11 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse",
- "description": "Response message for ListDeidentifyTemplates.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse"
},
"GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest": {
+ "description": "Request message for UpdateDeidentifyTemplate.",
+ "type": "object",
"properties": {
"updateMask": {
"description": "Mask to control which fields get updated.",
@@ -3219,102 +3096,221 @@
"type": "string"
},
"deidentifyTemplate": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate",
- "description": "New DeidentifyTemplate value."
+ "description": "New DeidentifyTemplate value.",
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
}
},
- "id": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest",
- "description": "Request message for UpdateDeidentifyTemplate.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest"
},
"GooglePrivacyDlpV2beta2SurrogateType": {
- "properties": {},
- "id": "GooglePrivacyDlpV2beta2SurrogateType",
"description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "GooglePrivacyDlpV2beta2SurrogateType"
},
"GooglePrivacyDlpV2beta2CryptoKey": {
+ "description": "This is a data encryption key (DEK) (as opposed to\na key encryption key (KEK) stored by KMS).\nWhen using KMS to wrap/unwrap DEKs, be sure to set an appropriate\nIAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot\nunwrap the data crypto key.",
+ "type": "object",
"properties": {
+ "transient": {
+ "$ref": "GooglePrivacyDlpV2beta2TransientCryptoKey"
+ },
"kmsWrapped": {
"$ref": "GooglePrivacyDlpV2beta2KmsWrappedCryptoKey"
},
"unwrapped": {
"$ref": "GooglePrivacyDlpV2beta2UnwrappedCryptoKey"
- },
- "transient": {
- "$ref": "GooglePrivacyDlpV2beta2TransientCryptoKey"
}
},
- "id": "GooglePrivacyDlpV2beta2CryptoKey",
- "description": "This is a data encryption key (DEK) (as opposed to\na key encryption key (KEK) stored by KMS).\nWhen using KMS to wrap/unwrap DEKs, be sure to set an appropriate\nIAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot\nunwrap the data crypto key.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2CryptoKey"
},
"GooglePrivacyDlpV2beta1InfoTypeStatistics": {
+ "description": "Statistics regarding a specific InfoType.",
+ "type": "object",
"properties": {
+ "infoType": {
+ "description": "The type of finding this stat is for.",
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ },
"count": {
"description": "Number of findings for this info type.",
"format": "int64",
"type": "string"
- },
- "infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "The type of finding this stat is for."
}
},
- "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics",
- "description": "Statistics regarding a specific InfoType.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics"
},
"GooglePrivacyDlpV2beta2CloudStorageKey": {
+ "description": "Record key for a finding in a Cloud Storage file.",
+ "type": "object",
"properties": {
- "filePath": {
- "description": "Path to the file.",
- "type": "string"
- },
"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",
- "description": "Record key for a finding in a Cloud Storage file.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2CloudStorageKey"
},
"GooglePrivacyDlpV2beta1PropertyReference": {
+ "description": "A reference to a property relative to the Datastore kind expressions.",
+ "type": "object",
"properties": {
"name": {
"description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1PropertyReference",
- "description": "A reference to a property relative to the Datastore kind expressions.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1PropertyReference"
},
"GooglePrivacyDlpV2beta2KAnonymityConfig": {
+ "description": "k-anonymity metric, used for analysis of reidentification risk.",
+ "type": "object",
"properties": {
- "entityId": {
- "$ref": "GooglePrivacyDlpV2beta2EntityId",
- "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": "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",
- "description": "k-anonymity metric, used for analysis of reidentification risk.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2KAnonymityConfig"
+ },
+ "GooglePrivacyDlpV2beta2InfoTypeDescription": {
+ "description": "InfoType description.",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "Human readable form of the infoType name.",
+ "type": "string"
+ },
+ "supportedBy": {
+ "description": "Which parts of the API supports this InfoType.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "ENUM_TYPE_UNSPECIFIED",
+ "INSPECT",
+ "RISK_ANALYSIS"
+ ]
+ },
+ "enumDescriptions": [
+ "",
+ "Supported by the inspect operations.",
+ "Supported by the risk analysis operations."
+ ]
+ },
+ "name": {
+ "description": "Internal name of the infoType.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2InfoTypeDescription"
+ },
+ "GooglePrivacyDlpV2beta2InspectDataSourceDetails": {
+ "description": "The results of an inspect DataSource job.",
+ "type": "object",
+ "properties": {
+ "result": {
+ "$ref": "GooglePrivacyDlpV2beta2Result",
+ "description": "A summary of the outcome of this inspect job."
+ },
+ "requestedOptions": {
+ "$ref": "GooglePrivacyDlpV2beta2RequestedOptions",
+ "description": "The configuration used for this job."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2InspectDataSourceDetails"
+ },
+ "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": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig",
+ "description": "Configuration for the re-identification of the content item.\nThis field shares the same proto message type that is used for\nde-identification, however its usage here is for the reversal of the\nprevious de-identification. Re-identification is performed by examining\nthe transformations used to de-identify the items and executing the\nreverse. This requires that only reversible transformations\nbe provided here. The reversible transformations are:\n\n - `CryptoReplaceFfxFpeConfig`"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2ReidentifyContentRequest"
+ },
+ "GooglePrivacyDlpV2beta2LDiversityResult": {
+ "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": "GooglePrivacyDlpV2beta2LDiversityHistogramBucket"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2LDiversityResult"
+ },
+ "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",
+ "type": "number"
+ },
+ "blue": {
+ "description": "The amount of blue in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2Color"
+ },
+ "GooglePrivacyDlpV2beta2InspectContentResponse": {
+ "description": "Results of inspecting an item.",
+ "type": "object",
+ "properties": {
+ "result": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectResult",
+ "description": "The findings."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2InspectContentResponse"
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"canonicalName": "DLP",
"auth": {
@@ -3338,64 +3334,11 @@
"resources": {
"deidentifyTemplates": {
"methods": {
- "create": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates",
- "path": "v2beta2/{+parent}/deidentifyTemplates",
- "id": "dlp.projects.deidentifyTemplates.create",
- "description": "Creates an Deidentify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage.",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest"
- }
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameters": {
- "name": {
- "description": "Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
- "id": "dlp.projects.deidentifyTemplates.delete",
- "path": "v2beta2/{+name}",
- "description": "Deletes inspect templates."
- },
"patch": {
+ "description": "Updates the inspect template.",
"request": {
"$ref": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest"
},
- "description": "Updates the inspect template.",
"response": {
"$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
},
@@ -3403,30 +3346,31 @@
"name"
],
"httpMethod": "PATCH",
- "parameters": {
- "name": {
- "description": "Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$",
- "location": "path"
- }
- },
"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` or\nprojects/project-id/deidentifyTemplates/432452342.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$"
+ }
+ },
"flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"path": "v2beta2/{+name}",
"id": "dlp.projects.deidentifyTemplates.patch"
},
"get": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
+ "description": "Gets an inspect template.",
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ },
"parameters": {
"name": {
"description": "Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
@@ -3440,23 +3384,25 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
- "path": "v2beta2/{+name}",
"id": "dlp.projects.deidentifyTemplates.get",
- "description": "Gets an inspect template."
+ "path": "v2beta2/{+name}"
},
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
"response": {
"$ref": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse"
},
+ "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 `ListDeidentifyTemplates`.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -3465,6 +3411,32 @@
"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/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates",
+ "path": "v2beta2/{+parent}/deidentifyTemplates",
+ "id": "dlp.projects.deidentifyTemplates.list",
+ "description": "Lists inspect templates."
+ },
+ "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": {
"description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
"required": true,
"type": "string",
@@ -3476,76 +3448,11 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates",
- "id": "dlp.projects.deidentifyTemplates.list",
"path": "v2beta2/{+parent}/deidentifyTemplates",
- "description": "Lists inspect templates."
- }
- }
- },
- "image": {
- "methods": {
- "redact": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2RedactImageResponse"
- },
- "parameters": {
- "parent": {
- "description": "The parent resource name, for example projects/my-project-id.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/image:redact",
- "id": "dlp.projects.image.redact",
- "path": "v2beta2/{+parent}/image:redact",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2RedactImageRequest"
- },
- "description": "Redacts potentially sensitive info from an image.\nThis method has limits on input size, processing time, and output size.\n[How-to guide](/dlp/docs/redacting-sensitive-data-images)"
- }
- }
- },
- "dlpJobs": {
- "methods": {
- "cancel": {
- "path": "v2beta2/{+name}:cancel",
- "id": "dlp.projects.dlpJobs.cancel",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2CancelDlpJobRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running DlpJob. The server\nmakes a best effort to cancel the DlpJob, but success is not\nguaranteed.",
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/dlpJobs/[^/]+$",
- "location": "path",
- "description": "The name of the DlpJob resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel"
+ "id": "dlp.projects.deidentifyTemplates.create"
},
"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"
},
@@ -3558,31 +3465,118 @@
],
"parameters": {
"name": {
+ "location": "path",
+ "description": "Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
+ "path": "v2beta2/{+name}",
+ "id": "dlp.projects.deidentifyTemplates.delete"
+ }
+ }
+ },
+ "image": {
+ "methods": {
+ "redact": {
+ "description": "Redacts potentially sensitive info from an image.\nThis method has limits on input size, processing time, and output size.\n[How-to guide](/dlp/docs/redacting-sensitive-data-images)",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2RedactImageRequest"
+ },
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2RedactImageResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "The parent resource name, for example projects/my-project-id.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/image:redact",
+ "path": "v2beta2/{+parent}/image:redact",
+ "id": "dlp.projects.image.redact"
+ }
+ }
+ },
+ "dlpJobs": {
+ "methods": {
+ "cancel": {
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the DlpJob resource to be cancelled.",
+ "required": true,
+ "type": "string",
"pattern": "^projects/[^/]+/dlpJobs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel",
+ "path": "v2beta2/{+name}:cancel",
+ "id": "dlp.projects.dlpJobs.cancel",
+ "description": "Starts asynchronous cancellation on a long-running DlpJob. The server\nmakes a best effort to cancel the DlpJob, but success is not\nguaranteed.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2CancelDlpJobRequest"
+ }
+ },
+ "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": {
"location": "path",
"description": "The name of the DlpJob resource to be deleted.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/dlpJobs/[^/]+$"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}",
"path": "v2beta2/{+name}",
"id": "dlp.projects.dlpJobs.delete"
},
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
"response": {
"$ref": "GooglePrivacyDlpV2beta2ListDlpJobsResponse"
},
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
@@ -3610,14 +3604,16 @@
"location": "query",
"description": "Optional. Allows filtering.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `\u003cfield\u003e \u003coperator\u003e \u003cvalue\u003e`.\n* Supported fields/values for inspect jobs:\n - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED\n - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY\n* Supported fields for risk analysis jobs:\n - `state` - RUNNING|CANCELED|FINISHED|FAILED\n* The operator must be `=` or `!=`.\n\nExamples:\n\n* inspected_storage = cloud_storage AND state = done\n* inspected_storage = cloud_storage OR inspected_storage = bigquery\n* inspected_storage = cloud_storage AND (state = done OR state = canceled)\n\nThe length of this field should be no more than 500 characters.",
"type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v2beta2/projects/{projectsId}/dlpJobs",
- "id": "dlp.projects.dlpJobs.list",
"path": "v2beta2/{+parent}/dlpJobs",
+ "id": "dlp.projects.dlpJobs.list",
"description": "Lists DlpJobs that match the specified filter in the request."
},
"get": {
@@ -3629,18 +3625,18 @@
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"name": {
+ "location": "path",
"description": "The name of the DlpJob resource.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/dlpJobs/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/dlpJobs/[^/]+$"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}",
"path": "v2beta2/{+name}",
"id": "dlp.projects.dlpJobs.get"
@@ -3649,35 +3645,8 @@
},
"inspectTemplates": {
"methods": {
- "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": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates",
- "id": "dlp.projects.inspectTemplates.create",
- "path": "v2beta2/{+parent}/inspectTemplates"
- },
"delete": {
+ "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
"path": "v2beta2/{+name}",
"id": "dlp.projects.inspectTemplates.delete",
"description": "Deletes inspect templates.",
@@ -3688,465 +3657,18 @@
"name"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"name": {
+ "location": "path",
"description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$",
- "location": "path",
- "description": "Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
- "required": true,
- "type": "string"
+ "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
- "id": "dlp.projects.inspectTemplates.patch",
- "path": "v2beta2/{+name}",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest"
- },
- "description": "Updates the inspect template."
- },
- "get": {
- "path": "v2beta2/{+name}",
- "id": "dlp.projects.inspectTemplates.get",
- "description": "Gets an inspect template.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$",
- "location": "path",
- "description": "Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}"
- },
- "list": {
- "description": "Lists inspect templates.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListInspectTemplates`.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates",
- "path": "v2beta2/{+parent}/inspectTemplates",
- "id": "dlp.projects.inspectTemplates.list"
- }
- }
- },
- "content": {
- "methods": {
- "deidentify": {
- "path": "v2beta2/{+parent}/content:deidentify",
- "id": "dlp.projects.content.deidentify",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyContentRequest"
- },
- "description": "De-identifies potentially sensitive info from a ContentItem.\nThis method has limits on input size and output size.\n[How-to guide](/dlp/docs/deidentify-sensitive-data)",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyContentResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "description": "The parent resource name, for example projects/my-project-id.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/content:deidentify"
- },
- "inspect": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2InspectContentResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The parent resource name, for example projects/my-project-id.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/content:inspect",
- "path": "v2beta2/{+parent}/content:inspect",
- "id": "dlp.projects.content.inspect",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2InspectContentRequest"
- },
- "description": "Finds potentially sensitive info in content.\nThis method has limits on input size, processing time, and output size.\n[How-to guide for text](/dlp/docs/inspecting-text), [How-to guide for\nimages](/dlp/docs/inspecting-images)"
- },
- "reidentify": {
- "path": "v2beta2/{+parent}/content:reidentify",
- "id": "dlp.projects.content.reidentify",
- "description": "Re-identify content that has been de-identified.",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentRequest"
- },
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The parent resource name.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/content:reidentify"
- }
- }
- },
- "dataSource": {
- "methods": {
- "inspect": {
- "path": "v2beta2/{+parent}/dataSource:inspect",
- "id": "dlp.projects.dataSource.inspect",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2InspectDataSourceRequest"
- },
- "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository. [How-to guide](/dlp/docs/inspecting-storage)",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DlpJob"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "description": "The parent resource name, for example projects/my-project-id.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/dataSource:inspect"
- },
- "analyze": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DlpJob"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "The parent resource name, for example projects/my-project-id.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/dataSource:analyze",
- "path": "v2beta2/{+parent}/dataSource:analyze",
- "id": "dlp.projects.dataSource.analyze",
- "description": "Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository. [How-to guide](/dlp/docs/compute-risk-analysis)",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest"
- }
- }
- }
- }
- }
- },
- "infoTypes": {
- "methods": {
- "list": {
- "path": "v2beta2/infoTypes",
- "id": "dlp.infoTypes.list",
- "description": "Returns sensitive information types DLP supports.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2ListInfoTypesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "languageCode": {
- "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"
- },
- "filter": {
- "location": "query",
- "description": "Optional filter to only return infoTypes supported by certain parts of the\nAPI. Defaults to supported_by=INSPECT.",
- "type": "string"
- }
- },
- "flatPath": "v2beta2/infoTypes"
- }
- }
- },
- "organizations": {
- "resources": {
- "deidentifyTemplates": {
- "methods": {
- "create": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates",
- "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."
- },
- "delete": {
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$",
- "location": "path",
- "description": "Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
- "path": "v2beta2/{+name}",
- "id": "dlp.organizations.deidentifyTemplates.delete",
- "description": "Deletes inspect templates."
- },
- "patch": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$",
- "location": "path",
- "description": "Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
- "path": "v2beta2/{+name}",
- "id": "dlp.organizations.deidentifyTemplates.patch",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest"
- },
- "description": "Updates the inspect template."
- },
- "get": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$",
- "location": "path",
- "description": "Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
- "path": "v2beta2/{+name}",
- "id": "dlp.organizations.deidentifyTemplates.get",
- "description": "Gets an inspect template."
- },
- "list": {
- "path": "v2beta2/{+parent}/deidentifyTemplates",
- "id": "dlp.organizations.deidentifyTemplates.list",
- "description": "Lists inspect templates.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates"
- }
- }
- },
- "inspectTemplates": {
- "methods": {
- "delete": {
- "path": "v2beta2/{+name}",
- "id": "dlp.organizations.inspectTemplates.delete",
- "description": "Deletes inspect templates.",
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$",
- "location": "path",
- "description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}"
+ ]
},
"patch": {
"description": "Updates the inspect template.",
@@ -4165,18 +3687,493 @@
],
"parameters": {
"name": {
- "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$",
"location": "path",
"description": "Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$"
}
},
- "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
+ "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
"path": "v2beta2/{+name}",
- "id": "dlp.organizations.inspectTemplates.patch"
+ "id": "dlp.projects.inspectTemplates.patch"
},
"get": {
+ "description": "Gets an inspect template.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
+ "path": "v2beta2/{+name}",
+ "id": "dlp.projects.inspectTemplates.get"
+ },
+ "list": {
+ "description": "Lists inspect templates.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse"
+ },
+ "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": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates",
+ "id": "dlp.projects.inspectTemplates.list",
+ "path": "v2beta2/{+parent}/inspectTemplates"
+ },
+ "create": {
+ "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates",
+ "path": "v2beta2/{+parent}/inspectTemplates",
+ "id": "dlp.projects.inspectTemplates.create",
+ "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest"
+ },
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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/[^/]+$"
+ }
+ }
+ }
+ }
+ },
+ "content": {
+ "methods": {
+ "inspect": {
+ "flatPath": "v2beta2/projects/{projectsId}/content:inspect",
+ "path": "v2beta2/{+parent}/content:inspect",
+ "id": "dlp.projects.content.inspect",
+ "description": "Finds potentially sensitive info in content.\nThis method has limits on input size, processing time, and output size.\n[How-to guide for text](/dlp/docs/inspecting-text), [How-to guide for\nimages](/dlp/docs/inspecting-images)",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectContentRequest"
+ },
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectContentResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The parent resource name, for example projects/my-project-id.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "reidentify": {
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "The parent resource name.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/content:reidentify",
+ "path": "v2beta2/{+parent}/content:reidentify",
+ "id": "dlp.projects.content.reidentify",
+ "description": "Re-identify content that has been de-identified.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentRequest"
+ }
+ },
+ "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)",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyContentResponse"
+ },
+ "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"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/content:deidentify",
+ "path": "v2beta2/{+parent}/content:deidentify",
+ "id": "dlp.projects.content.deidentify"
+ }
+ }
+ },
+ "dataSource": {
+ "methods": {
+ "analyze": {
+ "flatPath": "v2beta2/projects/{projectsId}/dataSource:analyze",
+ "path": "v2beta2/{+parent}/dataSource:analyze",
+ "id": "dlp.projects.dataSource.analyze",
+ "description": "Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository. [How-to guide](/dlp/docs/compute-risk-analysis)",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest"
+ },
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DlpJob"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "The parent resource name, for example projects/my-project-id.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ }
+ },
+ "inspect": {
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectDataSourceRequest"
+ },
+ "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository. [How-to guide](/dlp/docs/inspecting-storage)",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DlpJob"
+ },
+ "parameters": {
+ "parent": {
+ "description": "The parent resource name, for example projects/my-project-id.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/dataSource:inspect",
+ "id": "dlp.projects.dataSource.inspect",
+ "path": "v2beta2/{+parent}/dataSource:inspect"
+ }
+ }
+ }
+ }
+ },
+ "infoTypes": {
+ "methods": {
+ "list": {
+ "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": {
+ "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",
+ "description": "Returns sensitive information types DLP supports."
+ }
+ }
+ },
+ "organizations": {
+ "resources": {
+ "deidentifyTemplates": {
+ "methods": {
+ "patch": {
+ "description": "Updates the inspect template.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest"
+ },
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
+ "path": "v2beta2/{+name}",
+ "id": "dlp.organizations.deidentifyTemplates.patch"
+ },
+ "get": {
+ "description": "Gets an inspect template.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
+ "path": "v2beta2/{+name}",
+ "id": "dlp.organizations.deidentifyTemplates.get"
+ },
+ "list": {
+ "description": "Lists inspect templates.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "location": "path",
+ "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ },
+ "pageToken": {
+ "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates",
+ "path": "v2beta2/{+parent}/deidentifyTemplates",
+ "id": "dlp.organizations.deidentifyTemplates.list"
+ },
+ "create": {
+ "description": "Creates an Deidentify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest"
+ },
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates",
+ "path": "v2beta2/{+parent}/deidentifyTemplates",
+ "id": "dlp.organizations.deidentifyTemplates.create"
+ },
+ "delete": {
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
+ "path": "v2beta2/{+name}",
+ "id": "dlp.organizations.deidentifyTemplates.delete",
+ "description": "Deletes inspect templates."
+ }
+ }
+ },
+ "inspectTemplates": {
+ "methods": {
+ "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": {
+ "description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "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` or\nprojects/project-id/inspectTemplates/432452342.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
+ "id": "dlp.organizations.inspectTemplates.patch",
+ "path": "v2beta2/{+name}"
+ },
+ "get": {
+ "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
"path": "v2beta2/{+name}",
"id": "dlp.organizations.inspectTemplates.get",
"description": "Gets an inspect template.",
@@ -4187,21 +4184,21 @@
"name"
],
"httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/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}"
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$"
+ }
+ }
},
"list": {
+ "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates",
"path": "v2beta2/{+parent}/inspectTemplates",
"id": "dlp.organizations.inspectTemplates.list",
"description": "Lists inspect templates.",
@@ -4212,32 +4209,35 @@
"parent"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
+ "pageToken": {
+ "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListInspectTemplates`.",
+ "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"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListInspectTemplates`.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.",
- "format": "int32",
- "type": "integer",
- "location": "query"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates"
+ }
},
"create": {
+ "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest"
+ },
"response": {
"$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
},
@@ -4245,25 +4245,21 @@
"parent"
],
"httpMethod": "POST",
- "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"
],
+ "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/[^/]+$"
+ }
+ },
"flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates",
"path": "v2beta2/{+parent}/inspectTemplates",
- "id": "dlp.organizations.inspectTemplates.create",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest"
- },
- "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage."
+ "id": "dlp.organizations.inspectTemplates.create"
}
}
}
@@ -4271,71 +4267,6 @@
}
},
"parameters": {
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "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": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
@@ -4347,17 +4278,86 @@
"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"
},
- "pp": {
- "description": "Pretty-print response.",
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
+ "default": "true"
+ },
+ "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": {
+ "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": "v2beta2",
- "baseUrl": "https://dlp.googleapis.com/"
+ "baseUrl": "https://dlp.googleapis.com/",
+ "servicePath": "",
+ "description": "The Google Data Loss Prevention API provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.",
+ "kind": "discovery#restDescription",
+ "basePath": ""
}
diff --git a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
index f15fb76..c1ff89a 100644
--- a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
+++ b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
@@ -1,8 +1,188 @@
{
+ "canonicalName": "Firebase Dynamic Links",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/firebase": {
+ "description": "View and administer all your Firebase data and settings"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "firebasedynamiclinks",
+ "batchPath": "batch",
+ "title": "Firebase Dynamic Links API",
+ "ownerName": "Google",
+ "resources": {
+ "shortLinks": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "CreateShortDynamicLinkResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {},
+ "flatPath": "v1/shortLinks",
+ "path": "v1/shortLinks",
+ "id": "firebasedynamiclinks.shortLinks.create",
+ "description": "Creates a short Dynamic Link given either a valid long Dynamic Link or\ndetails such as Dynamic Link domain, Android and iOS app information.\nThe created short Dynamic Link will not expire.\n\nRepeated calls with the same long Dynamic Link or Dynamic Link information\nwill produce the same short Dynamic Link.\n\nThe Dynamic Link domain in the request must be owned by requester's\nFirebase project.",
+ "request": {
+ "$ref": "CreateShortDynamicLinkRequest"
+ }
+ }
+ }
+ },
+ "v1": {
+ "methods": {
+ "getLinkStats": {
+ "response": {
+ "$ref": "DynamicLinkStats"
+ },
+ "parameterOrder": [
+ "dynamicLink"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {
+ "durationDays": {
+ "description": "The span of time requested in days.",
+ "format": "int64",
+ "type": "string",
+ "location": "query"
+ },
+ "dynamicLink": {
+ "description": "Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/{dynamicLink}/linkStats",
+ "path": "v1/{dynamicLink}/linkStats",
+ "id": "firebasedynamiclinks.getLinkStats",
+ "description": "Fetches analytics stats of a short Dynamic Link for a given\nduration. Metrics include number of clicks, redirects, installs,\napp first opens, and app reopens."
+ },
+ "installAttribution": {
+ "description": "Get iOS strong/weak-match info for post-install attribution.",
+ "request": {
+ "$ref": "GetIosPostInstallAttributionRequest"
+ },
+ "response": {
+ "$ref": "GetIosPostInstallAttributionResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {},
+ "flatPath": "v1/installAttribution",
+ "path": "v1/installAttribution",
+ "id": "firebasedynamiclinks.installAttribution"
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "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://firebasedynamiclinks-ipv6.googleapis.com/",
- "description": "Programmatically creates and manages Firebase Dynamic Links.",
"kind": "discovery#restDescription",
+ "description": "Programmatically creates and manages Firebase Dynamic Links.",
"servicePath": "",
"basePath": "",
"revision": "20180112",
@@ -11,27 +191,7 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "CreateShortDynamicLinkRequest": {
- "id": "CreateShortDynamicLinkRequest",
- "description": "Request to create a short Dynamic Link.",
- "type": "object",
- "properties": {
- "longDynamicLink": {
- "description": "Full long Dynamic Link URL with desired query parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
- "type": "string"
- },
- "suffix": {
- "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)."
- }
- }
- },
"DesktopInfo": {
- "id": "DesktopInfo",
"description": "Desktop related attributes to the Dynamic Link.",
"type": "object",
"properties": {
@@ -39,11 +199,10 @@
"description": "Link to open on desktop.",
"type": "string"
}
- }
+ },
+ "id": "DesktopInfo"
},
"DynamicLinkEventStat": {
- "description": "Dynamic Link event stat.",
- "type": "object",
"properties": {
"count": {
"description": "The number of times this event occurred.",
@@ -51,8 +210,6 @@
"type": "string"
},
"event": {
- "description": "Link event.",
- "type": "string",
"enumDescriptions": [
"Unspecified type.",
"Indicates that an FDL is clicked by users.",
@@ -68,11 +225,11 @@
"APP_INSTALL",
"APP_FIRST_OPEN",
"APP_RE_OPEN"
- ]
+ ],
+ "description": "Link event.",
+ "type": "string"
},
"platform": {
- "description": "Requested platform.",
- "type": "string",
"enumDescriptions": [
"Unspecified platform.",
"Represents Android platform.\nAll apps and browsers on Android are classfied in this category.",
@@ -84,19 +241,19 @@
"ANDROID",
"IOS",
"DESKTOP"
- ]
+ ],
+ "description": "Requested platform.",
+ "type": "string"
}
},
- "id": "DynamicLinkEventStat"
+ "id": "DynamicLinkEventStat",
+ "description": "Dynamic Link event stat.",
+ "type": "object"
},
"GetIosPostInstallAttributionRequest": {
"description": "Request for iSDK to execute strong match flow for post-install attribution.\nThis is meant for iOS requests only. Requests from other platforms will\nnot be honored.",
"type": "object",
"properties": {
- "uniqueMatchLinkToCheck": {
- "description": "Possible unique matched link that server need to check before performing\nfingerprint match. If passed link is short server need to expand the link.\nIf link is long server need to vslidate the link.",
- "type": "string"
- },
"appInstallationTime": {
"description": "App installation epoch time (https://en.wikipedia.org/wiki/Unix_time).\nThis is a client signal for a more accurate weak match.",
"format": "int64",
@@ -121,8 +278,6 @@
]
},
"retrievalMethod": {
- "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.",
@@ -134,7 +289,9 @@
"IMPLICIT_WEAK_MATCH",
"EXPLICIT_WEAK_MATCH",
"EXPLICIT_STRONG_AFTER_WEAK_MATCH"
- ]
+ ],
+ "description": "App post install attribution retrieval information. Disambiguates\nmechanism (iSDK or developer invoked) to retrieve payload from\nclicked link.",
+ "type": "string"
},
"sdkVersion": {
"description": "Google SDK version.",
@@ -145,14 +302,17 @@
"type": "string"
},
"device": {
- "$ref": "DeviceInfo",
- "description": "Device information."
+ "description": "Device information.",
+ "$ref": "DeviceInfo"
+ },
+ "uniqueMatchLinkToCheck": {
+ "description": "Possible unique matched link that server need to check before performing\nfingerprint match. If passed link is short server need to expand the link.\nIf link is long server need to vslidate the link.",
+ "type": "string"
}
},
"id": "GetIosPostInstallAttributionRequest"
},
"CreateShortDynamicLinkResponse": {
- "id": "CreateShortDynamicLinkResponse",
"description": "Response to create a short Dynamic Link.",
"type": "object",
"properties": {
@@ -171,14 +331,14 @@
"$ref": "DynamicLinkWarning"
}
}
- }
+ },
+ "id": "CreateShortDynamicLinkResponse"
},
"Suffix": {
- "id": "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.",
@@ -188,28 +348,15 @@
"OPTION_UNSPECIFIED",
"UNGUESSABLE",
"SHORT"
- ],
- "description": "Suffix option.",
- "type": "string"
+ ]
}
- }
+ },
+ "id": "Suffix",
+ "description": "Short Dynamic Link suffix.",
+ "type": "object"
},
"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": {
- "utmContent": {
- "description": "Campaign content; used for A/B testing and content-targeted ads to\ndifferentiate ads or links that point to the same URL.",
- "type": "string"
- },
- "utmMedium": {
- "description": "Campaign medium; used to identify a medium such as email or cost-per-click.",
- "type": "string"
- },
- "utmTerm": {
- "description": "Campaign term; used with paid search to supply the keywords for ads.",
- "type": "string"
- },
"utmSource": {
"description": "Campaign source; used to identify a search engine, newsletter, or other\nsource.",
"type": "string"
@@ -221,26 +368,28 @@
"utmCampaign": {
"description": "Campaign name; used for keyword analysis to identify a specific product\npromotion or strategic campaign.",
"type": "string"
+ },
+ "utmContent": {
+ "description": "Campaign content; used for A/B testing and content-targeted ads to\ndifferentiate ads or links that point to the same URL.",
+ "type": "string"
+ },
+ "utmMedium": {
+ "description": "Campaign medium; used to identify a medium such as email or cost-per-click.",
+ "type": "string"
+ },
+ "utmTerm": {
+ "description": "Campaign term; used with paid search to supply the keywords for ads.",
+ "type": "string"
}
},
- "id": "GooglePlayAnalytics"
+ "id": "GooglePlayAnalytics",
+ "description": "Parameters for Google Play Campaign Measurements.\n[Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params)",
+ "type": "object"
},
"DynamicLinkInfo": {
"description": "Information about a Dynamic Link.",
"type": "object",
"properties": {
- "androidInfo": {
- "description": "Android related information. See Android related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).",
- "$ref": "AndroidInfo"
- },
- "navigationInfo": {
- "$ref": "NavigationInfo",
- "description": "Information of navigation behavior of a Firebase Dynamic Links."
- },
- "analyticsInfo": {
- "description": "Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).",
- "$ref": "AnalyticsInfo"
- },
"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"
@@ -254,55 +403,29 @@
"type": "string"
},
"iosInfo": {
- "$ref": "IosInfo",
- "description": "iOS related information. See iOS related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
+ "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": {
+ "description": "Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).",
+ "$ref": "AnalyticsInfo"
}
},
"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": {
- "id": "ITunesConnectAnalytics",
"description": "Parameters for iTunes Connect App Analytics.",
"type": "object",
"properties": {
@@ -322,20 +445,50 @@
"description": "Provider token that enables analytics for Dynamic Links from within iTunes\nConnect.",
"type": "string"
}
- }
+ },
+ "id": "ITunesConnectAnalytics"
+ },
+ "DeviceInfo": {
+ "description": "Signals associated with the device making the request.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "DeviceInfo"
},
"GetIosPostInstallAttributionResponse": {
"description": "Response for iSDK to execute strong match flow for post-install attribution.",
"type": "object",
"properties": {
- "utmSource": {
- "description": "Scion source value to be propagated by iSDK to Scion at post-install.",
- "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"
@@ -349,8 +502,6 @@
"type": "string"
},
"attributionConfidence": {
- "description": "The confidence of the returned attribution.",
- "type": "string",
"enumDescriptions": [
"Unset.",
"Weak confidence, more than one matching link found or link suspected to\nbe false positive",
@@ -362,7 +513,9 @@
"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",
@@ -391,19 +544,22 @@
"utmMedium": {
"description": "Scion medium value to be propagated by iSDK to Scion at post-install.",
"type": "string"
+ },
+ "utmSource": {
+ "description": "Scion source value to be propagated by iSDK to Scion at post-install.",
+ "type": "string"
+ },
+ "isStrongMatchExecutable": {
+ "description": "Instruction for iSDK to attemmpt to perform strong match. For instance,\nif browser does not support/allow cookie or outside of support browsers,\nthis will be false.",
+ "type": "boolean"
}
},
"id": "GetIosPostInstallAttributionResponse"
},
"SocialMetaTagInfo": {
- "id": "SocialMetaTagInfo",
"description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.",
"type": "object",
"properties": {
- "socialDescription": {
- "description": "A short description of the link. Optional.",
- "type": "string"
- },
"socialTitle": {
"description": "Title to be displayed. Optional.",
"type": "string"
@@ -411,13 +567,15 @@
"socialImageLink": {
"description": "An image url string. Optional.",
"type": "string"
+ },
+ "socialDescription": {
+ "description": "A short description of the link. Optional.",
+ "type": "string"
}
- }
+ },
+ "id": "SocialMetaTagInfo"
},
"DynamicLinkStats": {
- "id": "DynamicLinkStats",
- "description": "Analytics stats of a Dynamic Link for a given timeframe.",
- "type": "object",
"properties": {
"linkEventStats": {
"description": "Dynamic Link event stats.",
@@ -426,11 +584,12 @@
"$ref": "DynamicLinkEventStat"
}
}
- }
+ },
+ "id": "DynamicLinkStats",
+ "description": "Analytics stats of a Dynamic Link for a given timeframe.",
+ "type": "object"
},
"DynamicLinkWarning": {
- "description": "Dynamic Links warning messages.",
- "type": "object",
"properties": {
"warningCode": {
"description": "The warning code.",
@@ -507,13 +666,18 @@
"type": "string"
}
},
- "id": "DynamicLinkWarning"
+ "id": "DynamicLinkWarning",
+ "description": "Dynamic Links warning messages.",
+ "type": "object"
},
"AndroidInfo": {
- "id": "AndroidInfo",
"description": "Android related attributes to the Dynamic Link.",
"type": "object",
"properties": {
+ "androidPackageName": {
+ "description": "Android package name of the app.",
+ "type": "string"
+ },
"androidMinPackageVersionCode": {
"description": "Minimum version code for the Android app. If the installed app’s version\ncode is lower, then the user is taken to the Play Store.",
"type": "string"
@@ -525,27 +689,22 @@
"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"
}
- }
+ },
+ "id": "AndroidInfo"
},
"NavigationInfo": {
- "id": "NavigationInfo",
- "description": "Information of navigation behavior.",
- "type": "object",
"properties": {
"enableForcedRedirect": {
"description": "If this option is on, FDL click will be forced to redirect rather than\nshow an interstitial page.",
"type": "boolean"
}
- }
+ },
+ "id": "NavigationInfo",
+ "description": "Information of navigation behavior.",
+ "type": "object"
},
"IosInfo": {
- "description": "iOS related attributes to the Dynamic Link..",
- "type": "object",
"properties": {
"iosFallbackLink": {
"description": "Link to open on iOS if the app is not installed.",
@@ -572,15 +731,17 @@
"type": "string"
}
},
- "id": "IosInfo"
+ "id": "IosInfo",
+ "description": "iOS related attributes to the Dynamic Link..",
+ "type": "object"
},
"AnalyticsInfo": {
"description": "Tracking parameters supported by Dynamic Link.",
"type": "object",
"properties": {
"itunesConnectAnalytics": {
- "$ref": "ITunesConnectAnalytics",
- "description": "iTunes Connect App Analytics."
+ "description": "iTunes Connect App Analytics.",
+ "$ref": "ITunesConnectAnalytics"
},
"googlePlayAnalytics": {
"description": "Google Play Campaign Measurements.",
@@ -588,191 +749,30 @@
}
},
"id": "AnalyticsInfo"
+ },
+ "CreateShortDynamicLinkRequest": {
+ "description": "Request to create a short Dynamic Link.",
+ "type": "object",
+ "properties": {
+ "dynamicLinkInfo": {
+ "description": "Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
+ "$ref": "DynamicLinkInfo"
+ },
+ "longDynamicLink": {
+ "description": "Full long Dynamic Link URL with desired query parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
+ "type": "string"
+ },
+ "suffix": {
+ "description": "Short Dynamic Link suffix. Optional.",
+ "$ref": "Suffix"
+ }
+ },
+ "id": "CreateShortDynamicLinkRequest"
}
},
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest",
- "canonicalName": "Firebase Dynamic Links",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/firebase": {
- "description": "View and administer all your Firebase data and settings"
- }
- }
- }
- },
- "rootUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "firebasedynamiclinks",
- "batchPath": "batch",
- "title": "Firebase Dynamic Links API",
- "ownerName": "Google",
- "resources": {
- "shortLinks": {
- "methods": {
- "create": {
- "scopes": [
- "https://www.googleapis.com/auth/firebase"
- ],
- "parameters": {},
- "flatPath": "v1/shortLinks",
- "path": "v1/shortLinks",
- "id": "firebasedynamiclinks.shortLinks.create",
- "description": "Creates a short Dynamic Link given either a valid long Dynamic Link or\ndetails such as Dynamic Link domain, Android and iOS app information.\nThe created short Dynamic Link will not expire.\n\nRepeated calls with the same long Dynamic Link or Dynamic Link information\nwill produce the same short Dynamic Link.\n\nThe Dynamic Link domain in the request must be owned by requester's\nFirebase project.",
- "request": {
- "$ref": "CreateShortDynamicLinkRequest"
- },
- "response": {
- "$ref": "CreateShortDynamicLinkResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- }
- }
- },
- "v1": {
- "methods": {
- "getLinkStats": {
- "parameters": {
- "durationDays": {
- "location": "query",
- "description": "The span of time requested in days.",
- "format": "int64",
- "type": "string"
- },
- "dynamicLink": {
- "description": "Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/firebase"
- ],
- "flatPath": "v1/{dynamicLink}/linkStats",
- "path": "v1/{dynamicLink}/linkStats",
- "id": "firebasedynamiclinks.getLinkStats",
- "description": "Fetches analytics stats of a short Dynamic Link for a given\nduration. Metrics include number of clicks, redirects, installs,\napp first opens, and app reopens.",
- "response": {
- "$ref": "DynamicLinkStats"
- },
- "parameterOrder": [
- "dynamicLink"
- ],
- "httpMethod": "GET"
- },
- "installAttribution": {
- "request": {
- "$ref": "GetIosPostInstallAttributionRequest"
- },
- "description": "Get iOS strong/weak-match info for post-install attribution.",
- "response": {
- "$ref": "GetIosPostInstallAttributionResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/firebase"
- ],
- "flatPath": "v1/installAttribution",
- "path": "v1/installAttribution",
- "id": "firebasedynamiclinks.installAttribution"
- }
- }
- }
- },
- "parameters": {
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "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": {
- "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"
- }
- }
+ "protocol": "rest"
}
diff --git a/firebaseremoteconfig/v1/firebaseremoteconfig-api.json b/firebaseremoteconfig/v1/firebaseremoteconfig-api.json
index 63687eb..1a79920 100644
--- a/firebaseremoteconfig/v1/firebaseremoteconfig-api.json
+++ b/firebaseremoteconfig/v1/firebaseremoteconfig-api.json
@@ -1,8 +1,4 @@
{
- "rootUrl": "https://firebaseremoteconfig.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "firebaseremoteconfig",
- "batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Firebase Remote Config API",
"ownerName": "Google",
@@ -10,44 +6,40 @@
"projects": {
"methods": {
"getRemoteConfig": {
- "flatPath": "v1/projects/{projectsId}/remoteConfig",
- "id": "firebaseremoteconfig.projects.getRemoteConfig",
- "path": "v1/{+project}/remoteConfig",
- "description": "Get the latest version Remote Configuration for a project.\nReturns the RemoteConfig as the payload, and also the eTag as a\nresponse header.",
- "httpMethod": "GET",
"response": {
"$ref": "RemoteConfig"
},
"parameterOrder": [
"project"
],
+ "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",
+ "path": "v1/{+project}/remoteConfig",
+ "id": "firebaseremoteconfig.projects.getRemoteConfig",
+ "description": "Get the latest version Remote Configuration for a project.\nReturns the RemoteConfig as the payload, and also the eTag as a\nresponse header."
},
"updateRemoteConfig": {
- "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.",
- "request": {
- "$ref": "RemoteConfig"
- },
- "response": {
- "$ref": "RemoteConfig"
- },
+ "httpMethod": "PUT",
"parameterOrder": [
"project"
],
- "httpMethod": "PUT",
+ "response": {
+ "$ref": "RemoteConfig"
+ },
"parameters": {
"validateOnly": {
+ "location": "query",
"description": "Optional. Defaults to \u003ccode\u003efalse\u003c/code\u003e (UpdateRemoteConfig call should\nupdate the backend if there are no validation/interal errors). May be set\nto \u003ccode\u003etrue\u003c/code\u003e to indicate that, should no validation errors occur,\nthe call should return a \"200 OK\" instead of performing the update. Note\nthat other error messages (500 Internal Error, 412 Version Mismatch, etc)\nmay still result after flipping to \u003ccode\u003efalse\u003c/code\u003e, even if getting a\n\"200 OK\" when calling with \u003ccode\u003etrue\u003c/code\u003e.",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
},
"project": {
"description": "The GMP project identifier. Required.\nSee note at the beginning of this file regarding project ids.",
@@ -58,22 +50,47 @@
}
},
"flatPath": "v1/projects/{projectsId}/remoteConfig",
+ "id": "firebaseremoteconfig.projects.updateRemoteConfig",
"path": "v1/{+project}/remoteConfig",
- "id": "firebaseremoteconfig.projects.updateRemoteConfig"
+ "description": "Update a RemoteConfig. We treat this as an always-existing\nresource (when it is not found in our data store, we treat it as version\n0, a template with zero conditions and zero parameters). Hence there are\nno Create or Delete operations. Returns the updated template when\nsuccessful (and the updated eTag as a response header), or an error if\nthings go wrong.\nPossible error messages:\n* VALIDATION_ERROR (HTTP status 400) with additional details if the\ntemplate being passed in can not be validated.\n* AUTHENTICATION_ERROR (HTTP status 401) if the request can not be\nauthenticate (e.g. no access token, or invalid access token).\n* AUTHORIZATION_ERROR (HTTP status 403) if the request can not be\nauthorized (e.g. the user has no access to the specified project id).\n* VERSION_MISMATCH (HTTP status 412) when trying to update when the\nexpected eTag (passed in via the \"If-match\" header) is not specified, or\nis specified but does does not match the current eTag.\n* Internal error (HTTP status 500) for Database problems or other internal\nerrors.",
+ "request": {
+ "$ref": "RemoteConfig"
+ }
}
}
}
},
"parameters": {
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -87,14 +104,14 @@
"default": "true"
},
"fields": {
+ "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"callback": {
"description": "JSONP",
@@ -102,8 +119,6 @@
"location": "query"
},
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -112,11 +127,11 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -128,35 +143,16 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query"
- },
- "access_token": {
"location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
+ "description": "Data format for response.",
+ "default": "json"
}
},
"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/",
@@ -164,6 +160,21 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "RemoteConfigParameterValue": {
+ "properties": {
+ "value": {
+ "description": "the string to set the parameter to",
+ "type": "string"
+ },
+ "useInAppDefault": {
+ "description": "if true, omit the parameter from the map of fetched parameter values",
+ "type": "boolean"
+ }
+ },
+ "id": "RemoteConfigParameterValue",
+ "description": "A RemoteConfigParameter's \"value\" (either the default value, or the value\nassociated with a condition name) is either a string, or the\n\"use_in_app_default\" indicator (which means to leave out the parameter from\nthe returned \u003ckey, value\u003e map that is the output of the parameter fetch).\nWe represent the \"use_in_app_default\" as a bool, but (when using the boolean\ninstead of the string) it should always be \u003ccode\u003etrue\u003c/code\u003e.",
+ "type": "object"
+ },
"RemoteConfig": {
"description": "*\nThe RemoteConfig consists of a list of conditions (which can be\nthought of as named \"if\" statements) and a map of parameters (parameter key\nto a structure containing an optional default value, as well as a optional\nsubmap of (condition name to value when that condition is true).",
"type": "object",
@@ -186,8 +197,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": {
"description": {
"description": "Optional.\nA description for this Parameter. Length must be less than or equal to\n100 characters (or more precisely, unicode code points, which is defined in\njava/com/google/wireless/android/config/ConstsExporter.java).\nA description may contain any Unicode characters",
@@ -201,27 +210,17 @@
"type": "object"
},
"defaultValue": {
- "$ref": "RemoteConfigParameterValue",
- "description": "Optional - value to set the parameter to, when none of the named conditions\nevaluate to \u003ccode\u003etrue\u003c/code\u003e."
+ "description": "Optional - value to set the parameter to, when none of the named conditions\nevaluate to \u003ccode\u003etrue\u003c/code\u003e.",
+ "$ref": "RemoteConfigParameterValue"
}
},
- "id": "RemoteConfigParameter"
+ "id": "RemoteConfigParameter",
+ "description": "While default_value and conditional_values are each optional, at least one of\nthe two is required - otherwise, the parameter is meaningless (and an\nexception will be thrown by the validation logic).",
+ "type": "object"
},
"RemoteConfigCondition": {
- "description": "A single RemoteConfig Condition. A list of these (because order matters) are\npart of a single RemoteConfig template.",
- "type": "object",
"properties": {
- "description": {
- "description": "DO NOT USE. Implementation removed and will not be added unless requested.\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": {
- "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",
@@ -249,35 +248,36 @@
"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"
},
"name": {
"description": "Required.\nA non empty and unique name of this condition.",
"type": "string"
- }
- },
- "id": "RemoteConfigCondition"
- },
- "RemoteConfigParameterValue": {
- "description": "A RemoteConfigParameter's \"value\" (either the default value, or the value\nassociated with a condition name) is either a string, or the\n\"use_in_app_default\" indicator (which means to leave out the parameter from\nthe returned \u003ckey, value\u003e map that is the output of the parameter fetch).\nWe represent the \"use_in_app_default\" as a bool, but (when using the boolean\ninstead of the string) it should always be \u003ccode\u003etrue\u003c/code\u003e.",
- "type": "object",
- "properties": {
- "value": {
- "description": "the string to set the parameter to",
+ },
+ "description": {
+ "description": "DO NOT USE. Implementation removed and will not be added unless requested.\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"
},
- "useInAppDefault": {
- "description": "if true, omit the parameter from the map of fetched parameter values",
- "type": "boolean"
+ "expression": {
+ "description": "Required.",
+ "type": "string"
}
},
- "id": "RemoteConfigParameterValue"
+ "id": "RemoteConfigCondition",
+ "description": "A single RemoteConfig Condition. A list of these (because order matters) are\npart of a single RemoteConfig template.",
+ "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": "Firebase Remote Config"
+ "canonicalName": "Firebase Remote Config",
+ "rootUrl": "https://firebaseremoteconfig.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "firebaseremoteconfig",
+ "batchPath": "batch"
}
diff --git a/firebaserules/v1/firebaserules-api.json b/firebaserules/v1/firebaserules-api.json
index 3b5bc27..293b923 100644
--- a/firebaserules/v1/firebaserules-api.json
+++ b/firebaserules/v1/firebaserules-api.json
@@ -1,476 +1,14 @@
{
- "schemas": {
- "Result": {
- "id": "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."
- }
- }
- },
- "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": {
- "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"
- },
- "line": {
- "description": "Line number of the source fragment. 1-based.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "SourcePosition"
- },
- "TestCase": {
- "id": "TestCase",
- "description": "`TestCase` messages provide the request context and an expectation as to\nwhether the given context will be allowed or denied. Test cases may specify\nthe `request`, `resource`, and `function_mocks` to mock a function call to\na service-provided function.\n\nThe `request` object represents context present at request-time.\n\nThe `resource` is the value of the target resource as it appears in\npersistent storage before the request is executed.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- }
- }
- }
- },
- "Issue": {
- "id": "Issue",
- "description": "Issues include warnings, errors, and deprecation notices.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Short error description.",
- "type": "string"
- },
- "sourcePosition": {
- "description": "Position of the issue in the `Source`.",
- "$ref": "SourcePosition"
- },
- "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"
- }
- }
- },
- "TestRulesetRequest": {
- "description": "The request for FirebaseRulesService.TestRuleset.",
- "type": "object",
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "Optional `Source` to be checked for correctness.\n\nThis field must not be set when the resource name refers to a `Ruleset`."
- },
- "testSuite": {
- "$ref": "TestSuite",
- "description": "Inline `TestSuite` to run."
- }
- },
- "id": "TestRulesetRequest"
- },
- "Ruleset": {
- "id": "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": {
- "$ref": "Source",
- "description": "`Source` for the `Ruleset`."
- },
- "createTime": {
- "description": "Time the `Ruleset` was created.\nOutput only.",
- "format": "google-datetime",
- "type": "string"
- }
- }
- },
- "File": {
- "id": "File",
- "description": "`File` containing source content.",
- "type": "object",
- "properties": {
- "fingerprint": {
- "description": "Fingerprint (e.g. github sha) associated with the `File`.",
- "format": "byte",
- "type": "string"
- },
- "name": {
- "description": "File name.",
- "type": "string"
- },
- "content": {
- "description": "Textual Content.",
- "type": "string"
- }
- }
- },
- "FunctionCall": {
- "description": "Represents a service-defined function call that was invoked during test\nexecution.",
- "type": "object",
- "properties": {
- "args": {
- "description": "The arguments that were provided to the function.",
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "function": {
- "description": "Name of the function invoked.",
- "type": "string"
- }
- },
- "id": "FunctionCall"
- },
- "ListReleasesResponse": {
- "id": "ListReleasesResponse",
- "description": "The response for FirebaseRulesService.ListReleases.",
- "type": "object",
- "properties": {
- "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"
- }
- }
- },
- "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",
- "properties": {
- "name": {
- "description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "type": "string"
- },
- "rulesetName": {
- "description": "Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must\nexist the `Release` to be created.",
- "type": "string"
- },
- "createTime": {
- "description": "Time the release was created.\nOutput only.",
- "format": "google-datetime",
- "type": "string"
- },
- "updateTime": {
- "description": "Time the release was updated.\nOutput only.",
- "format": "google-datetime",
- "type": "string"
- }
- }
- },
- "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": {
- "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",
- "properties": {
- "functionCalls": {
- "description": "The set of function calls made to service-defined methods.\n\nFunction calls are included in the order in which they are encountered\nduring evaluation, are provided for both mocked and unmocked functions,\nand included on the response regardless of the test `state`.",
- "type": "array",
- "items": {
- "$ref": "FunctionCall"
- }
- },
- "state": {
- "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": {
- "description": "Debug messages related to test execution issues encountered during\nevaluation.\n\nDebug messages may be related to too many or too few invocations of\nfunction mocks or to runtime errors that occur during evaluation.\n\nFor example: ```Unable to read variable [name: \"resource\"]```",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "errorPosition": {
- "$ref": "SourcePosition",
- "description": "Position in the `Source` or `Ruleset` where the principle runtime error\noccurs.\n\nEvaluation of an expression may result in an error. Rules are deny by\ndefault, so a `DENY` expectation when an error is generated is valid.\nWhen there is a `DENY` with an error, the `SourcePosition` is returned.\n\nE.g. `error_position { line: 19 column: 37 }`"
- }
- }
- },
- "ListRulesetsResponse": {
- "id": "ListRulesetsResponse",
- "description": "The response for FirebaseRulesService.ListRulesets.",
- "type": "object",
- "properties": {
- "rulesets": {
- "description": "List of `Ruleset` instances.",
- "type": "array",
- "items": {
- "$ref": "Ruleset"
- }
- },
- "nextPageToken": {
- "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
- "type": "string"
- }
- }
- },
- "Arg": {
- "id": "Arg",
- "description": "Arg matchers for the mock function.",
- "type": "object",
- "properties": {
- "exactValue": {
- "description": "Argument exactly matches value provided.",
- "type": "any"
- },
- "anyValue": {
- "$ref": "Empty",
- "description": "Argument matches any value provided."
- }
- }
- },
- "UpdateReleaseRequest": {
- "id": "UpdateReleaseRequest",
- "description": "The request for FirebaseRulesService.UpdateReleasePatch.",
- "type": "object",
- "properties": {
- "release": {
- "description": "`Release` to update.",
- "$ref": "Release"
- },
- "updateMask": {
- "description": "Specifies which fields to update.",
- "format": "google-fieldmask",
- "type": "string"
- }
- }
- },
- "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"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "FunctionMock": {
- "id": "FunctionMock",
- "description": "Mock function definition.\n\nMocks must refer to a function declared by the target service. The type of\nthe function args and result will be inferred at test time. If either the\narg or result values are not compatible with function type declaration, the\nrequest will be considered invalid.\n\nMore than one `FunctionMock` may be provided for a given function name so\nlong as the `Arg` matchers are distinct. There may be only one function\nfor a given overload where all `Arg` values are `Arg.any_value`.",
- "type": "object",
- "properties": {
- "args": {
- "description": "The list of `Arg` values to match. The order in which the arguments are\nprovided is the order in which they must appear in the function\ninvocation.",
- "type": "array",
- "items": {
- "$ref": "Arg"
- }
- },
- "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"
- }
- }
- },
- "GetReleaseExecutableResponse": {
- "id": "GetReleaseExecutableResponse",
- "description": "The response for FirebaseRulesService.GetReleaseExecutable",
- "type": "object",
- "properties": {
- "language": {
- "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": {
- "description": "`Ruleset` name associated with the `Release` executable.",
- "type": "string"
- },
- "executableVersion": {
- "description": "The Rules runtime version of the executable.",
- "type": "string",
- "enumDescriptions": [
- "Executable format unspecified.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1",
- "Firebase Rules syntax 'rules2' executable versions:\nCustom AST for use with Java clients.",
- "CEL-based executable for use with C++ clients."
- ],
- "enum": [
- "RELEASE_EXECUTABLE_VERSION_UNSPECIFIED",
- "FIREBASE_RULES_EXECUTABLE_V1",
- "FIREBASE_RULES_EXECUTABLE_V2"
- ]
- },
- "executable": {
- "description": "Executable view of the `Ruleset` referenced by the `Release`.",
- "format": "byte",
- "type": "string"
- },
- "updateTime": {
- "description": "Timestamp for the most recent `Release.update_time`.",
- "format": "google-datetime",
- "type": "string"
- }
- }
- },
- "Source": {
- "id": "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"
- }
- }
- }
- }
- },
- "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": "Firebase Rules",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/firebase": {
- "description": "View and administer all your Firebase data and settings"
- },
- "https://www.googleapis.com/auth/firebase.readonly": {
- "description": "View all your Firebase data and settings"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://firebaserules.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "firebaserules",
- "batchPath": "batch",
"title": "Firebase Rules API",
"ownerName": "Google",
"resources": {
"projects": {
"methods": {
"test": {
- "path": "v1/{+name}:test",
- "id": "firebaserules.projects.test",
- "description": "Test `Source` for syntactic and semantic correctness. Issues present, if\nany, will be returned to the caller with a description, severity, and\nsource location.\n\nThe test method may be executed with `Source` or a `Ruleset` name.\nPassing `Source` is useful for unit testing new rules. Passing a `Ruleset`\nname is useful for regression testing an existing rule.\n\nThe following is an example of `Source` that permits users to upload images\nto a bucket bearing their user id and matching the correct metadata:\n\n_*Example*_\n\n // Users are allowed to subscribe and unsubscribe to the blog.\n service firebase.storage {\n match /users/{userId}/images/{imageName} {\n allow write: if userId == request.auth.uid\n && (imageName.matches('*.png$')\n || imageName.matches('*.jpg$'))\n && resource.mimeType.matches('^image/')\n }\n }",
"request": {
"$ref": "TestRulesetRequest"
},
+ "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"
},
@@ -478,21 +16,23 @@
"name"
],
"httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Tests may either provide `source` or a `Ruleset` resource name.\n\nFor tests against `source`, the resource name must refer to the project:\nFormat: `projects/{project_id}`\n\nFor tests against a `Ruleset`, this must be the `Ruleset` resource name:\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/.+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
],
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}:test"
+ "flatPath": "v1/projects/{projectsId}:test",
+ "path": "v1/{+name}:test",
+ "id": "firebaserules.projects.test"
}
},
"resources": {
@@ -500,19 +40,19 @@
"methods": {
"delete": {
"httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"name"
],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"name": {
- "description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/rulesets/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`"
}
},
"scopes": [
@@ -525,20 +65,21 @@
"description": "Delete a `Ruleset` by resource name.\n\nIf the `Ruleset` is referenced by a `Release` the operation will fail."
},
"get": {
- "httpMethod": "GET",
+ "description": "Get a `Ruleset` by name including the full `Source` contents.",
"response": {
"$ref": "Ruleset"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
"parameters": {
"name": {
+ "location": "path",
"description": "Resource name for the ruleset to get.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/rulesets/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/rulesets/[^/]+$"
}
},
"scopes": [
@@ -547,9 +88,8 @@
"https://www.googleapis.com/auth/firebase.readonly"
],
"flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}",
- "id": "firebaserules.projects.rulesets.get",
"path": "v1/{+name}",
- "description": "Get a `Ruleset` by name including the full `Source` contents."
+ "id": "firebaserules.projects.rulesets.get"
},
"list": {
"response": {
@@ -566,27 +106,27 @@
],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+$",
"location": "path",
"description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
},
"pageToken": {
+ "type": "string",
"location": "query",
- "description": "Next page token for loading the next batch of `Ruleset` instances.",
- "type": "string"
+ "description": "Next page token for loading the next batch of `Ruleset` instances."
},
"pageSize": {
+ "type": "integer",
"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"
+ "format": "int32"
},
"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"
+ "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-*`"
}
},
"flatPath": "v1/projects/{projectsId}/rulesets",
@@ -595,112 +135,63 @@
"description": "List `Ruleset` metadata only and optionally filter the results by `Ruleset`\nname.\n\nThe full `Source` contents of a `Ruleset` may be retrieved with\nGetRuleset."
},
"create": {
- "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.",
- "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"
- }
- },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
- "flatPath": "v1/projects/{projectsId}/rulesets"
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`"
+ }
+ },
+ "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"
+ }
}
}
},
"releases": {
"methods": {
- "patch": {
- "parameters": {
- "name": {
- "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "path": "v1/{+name}",
- "id": "firebaserules.projects.releases.patch",
- "request": {
- "$ref": "UpdateReleaseRequest"
- },
- "description": "Update a `Release` via PATCH.\n\nOnly updates to the `ruleset_name` and `test_suite_name` fields will be\nhonored. `Release` rename is not supported. To create a `Release` use the\nCreateRelease method.",
+ "getExecutable": {
"response": {
- "$ref": "Release"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH"
- },
- "get": {
- "description": "Get a `Release` by name.",
- "response": {
- "$ref": "Release"
+ "$ref": "GetReleaseExecutableResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase",
- "https://www.googleapis.com/auth/firebase.readonly"
- ],
"parameters": {
- "name": {
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path",
- "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "path": "v1/{+name}",
- "id": "firebaserules.projects.releases.get"
- },
- "getExecutable": {
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path",
- "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "required": true,
- "type": "string"
- },
"executableVersion": {
- "description": "The requested runtime executable version.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1",
"type": "string",
"location": "query",
"enum": [
"RELEASE_EXECUTABLE_VERSION_UNSPECIFIED",
"FIREBASE_RULES_EXECUTABLE_V1",
"FIREBASE_RULES_EXECUTABLE_V2"
- ]
+ ],
+ "description": "The requested runtime executable version.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1"
+ },
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/releases/.+$",
+ "location": "path",
+ "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`"
}
},
"scopes": [
@@ -711,72 +202,65 @@
"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.",
- "response": {
- "$ref": "GetReleaseExecutableResponse"
- },
+ "description": "Get the `Release` executable to use when enforcing rules."
+ },
+ "delete": {
+ "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
+ "id": "firebaserules.projects.releases.delete",
+ "path": "v1/{+name}",
+ "description": "Delete a `Release` by resource name.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
- "httpMethod": "GET"
- },
- "delete": {
- "path": "v1/{+name}",
- "id": "firebaserules.projects.releases.delete",
- "description": "Delete a `Release` by resource name.",
"response": {
"$ref": "Empty"
},
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
"parameters": {
"name": {
- "description": "Resource name for the `Release` to delete.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/releases/.+$",
- "location": "path"
+ "location": "path",
+ "description": "Resource name for the `Release` to delete.\n\nFormat: `projects/{project_id}/releases/{release_id}`"
}
},
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ]
},
"list": {
- "httpMethod": "GET",
"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": {
- "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`"
},
"pageToken": {
- "description": "Next page token for the next batch of `Release` instances.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Next page token for the next batch of `Release` instances."
},
"pageSize": {
+ "type": "integer",
"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"
+ "format": "int32"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "`Release` filter. The list method supports filters with restrictions on the\n`Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.\n\nExample 1: A filter of 'name=prod*' might return `Release`s with names\nwithin 'projects/foo' prefixed with 'prod':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2: A filter of `name=prod* ruleset_name=uuid1234` would return only\n`Release` instances for 'projects/foo' with names prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/1234\n\nIn the examples, the filter parameters refer to the search filters are\nrelative to the project. Fully qualified prefixed may also be used. e.g.\n`test_suite_name=projects/foo/testsuites/uuid1`"
}
},
"scopes": [
@@ -785,11 +269,18 @@
"https://www.googleapis.com/auth/firebase.readonly"
],
"flatPath": "v1/projects/{projectsId}/releases",
- "id": "firebaserules.projects.releases.list",
"path": "v1/{+name}/releases",
+ "id": "firebaserules.projects.releases.list",
"description": "List the `Release` values for a project. This list may optionally be\nfiltered by `Release` name, `Ruleset` name, `TestSuite` name, or any\ncombination thereof."
},
"create": {
+ "flatPath": "v1/projects/{projectsId}/releases",
+ "path": "v1/{+name}/releases",
+ "id": "firebaserules.projects.releases.create",
+ "request": {
+ "$ref": "Release"
+ },
+ "description": "Create a `Release`.\n\nRelease names should reflect the developer's deployment practices. For\nexample, the release name may include the environment name, application\nname, application version, or any other name meaningful to the developer.\nOnce a `Release` refers to a `Ruleset`, the rules can be enforced by\nFirebase Rules-enabled services.\n\nMore than one `Release` may be 'live' concurrently. Consider the following\nthree `Release` names for `projects/foo` and the `Ruleset` to which they\nrefer.\n\nRelease Name | Ruleset Name\n--------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/beta | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456\n\nThe table reflects the `Ruleset` rollout in progress. The `prod` and\n`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`\nrefers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be\nupdated using the UpdateRelease method.",
"response": {
"$ref": "Release"
},
@@ -797,26 +288,75 @@
"name"
],
"httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ]
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Release"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/releases/.+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
+ "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
+ "id": "firebaserules.projects.releases.patch",
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "UpdateReleaseRequest"
+ },
+ "description": "Update a `Release` via PATCH.\n\nOnly updates to the `ruleset_name` and `test_suite_name` fields will be\nhonored. `Release` rename is not supported. To create a `Release` use the\nCreateRelease method."
+ },
+ "get": {
+ "description": "Get a `Release` by name.",
+ "response": {
+ "$ref": "Release"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"parameters": {
"name": {
- "pattern": "^projects/[^/]+$",
"location": "path",
- "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`",
+ "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/releases/.+$"
}
},
- "flatPath": "v1/projects/{projectsId}/releases",
- "path": "v1/{+name}/releases",
- "id": "firebaserules.projects.releases.create",
- "description": "Create a `Release`.\n\nRelease names should reflect the developer's deployment practices. For\nexample, the release name may include the environment name, application\nname, application version, or any other name meaningful to the developer.\nOnce a `Release` refers to a `Ruleset`, the rules can be enforced by\nFirebase Rules-enabled services.\n\nMore than one `Release` may be 'live' concurrently. Consider the following\nthree `Release` names for `projects/foo` and the `Ruleset` to which they\nrefer.\n\nRelease Name | Ruleset Name\n--------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/beta | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456\n\nThe table reflects the `Ruleset` rollout in progress. The `prod` and\n`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`\nrefers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be\nupdated using the UpdateRelease method.",
- "request": {
- "$ref": "Release"
- }
+ "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}",
+ "path": "v1/{+name}",
+ "id": "firebaserules.projects.releases.get"
}
}
}
@@ -824,15 +364,21 @@
}
},
"parameters": {
+ "pp": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Pretty-print response."
+ },
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"oauth_token": {
+ "type": "string",
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "description": "OAuth 2.0 token for the current user."
},
"upload_protocol": {
"location": "query",
@@ -840,40 +386,41 @@
"type": "string"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "default": "true"
},
"uploadType": {
+ "type": "string",
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "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"
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
},
"callback": {
+ "type": "string",
"location": "query",
- "description": "JSONP",
- "type": "string"
+ "description": "JSONP"
},
"$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
"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": [
@@ -886,8 +433,7 @@
"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",
@@ -895,31 +441,485 @@
"type": "string"
},
"access_token": {
- "description": "OAuth access token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth access token."
},
"quotaUser": {
+ "type": "string",
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "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."
}
},
"version": "v1",
"baseUrl": "https://firebaserules.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n",
"servicePath": "",
+ "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n",
+ "kind": "discovery#restDescription",
"basePath": "",
"revision": "20180124",
"documentationLink": "https://firebase.google.com/docs/storage/security",
"id": "firebaserules:v1",
"discoveryVersion": "v1",
- "version_module": true
+ "version_module": true,
+ "schemas": {
+ "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 `{}`."
+ },
+ "FunctionMock": {
+ "description": "Mock function definition.\n\nMocks must refer to a function declared by the target service. The type of\nthe function args and result will be inferred at test time. If either the\narg or result values are not compatible with function type declaration, the\nrequest will be considered invalid.\n\nMore than one `FunctionMock` may be provided for a given function name so\nlong as the `Arg` matchers are distinct. There may be only one function\nfor a given overload where all `Arg` values are `Arg.any_value`.",
+ "type": "object",
+ "properties": {
+ "args": {
+ "description": "The list of `Arg` values to match. The order in which the arguments are\nprovided is the order in which they must appear in the function\ninvocation.",
+ "type": "array",
+ "items": {
+ "$ref": "Arg"
+ }
+ },
+ "function": {
+ "description": "The name of the function.\n\nThe function name must match one provided by a service declaration.",
+ "type": "string"
+ },
+ "result": {
+ "$ref": "Result",
+ "description": "The mock result of the function call."
+ }
+ },
+ "id": "FunctionMock"
+ },
+ "GetReleaseExecutableResponse": {
+ "description": "The response for FirebaseRulesService.GetReleaseExecutable",
+ "type": "object",
+ "properties": {
+ "updateTime": {
+ "type": "string",
+ "description": "Timestamp for the most recent `Release.update_time`.",
+ "format": "google-datetime"
+ },
+ "language": {
+ "type": "string",
+ "enumDescriptions": [
+ "Language unspecified. Defaults to FIREBASE_RULES.",
+ "Firebase Rules language.",
+ "Event Flow triggers."
+ ],
+ "enum": [
+ "LANGUAGE_UNSPECIFIED",
+ "FIREBASE_RULES",
+ "EVENT_FLOW_TRIGGERS"
+ ],
+ "description": "`Language` used to generate the executable bytes."
+ },
+ "rulesetName": {
+ "type": "string",
+ "description": "`Ruleset` name associated with the `Release` executable."
+ },
+ "executableVersion": {
+ "type": "string",
+ "enumDescriptions": [
+ "Executable format unspecified.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1",
+ "Firebase Rules syntax 'rules2' executable versions:\nCustom AST for use with Java clients.",
+ "CEL-based executable for use with C++ clients."
+ ],
+ "enum": [
+ "RELEASE_EXECUTABLE_VERSION_UNSPECIFIED",
+ "FIREBASE_RULES_EXECUTABLE_V1",
+ "FIREBASE_RULES_EXECUTABLE_V2"
+ ],
+ "description": "The Rules runtime version of the executable."
+ },
+ "executable": {
+ "description": "Executable view of the `Ruleset` referenced by the `Release`.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "GetReleaseExecutableResponse"
+ },
+ "Source": {
+ "type": "object",
+ "properties": {
+ "files": {
+ "description": "`File` set constituting the `Source` bundle.",
+ "type": "array",
+ "items": {
+ "$ref": "File"
+ }
+ }
+ },
+ "id": "Source",
+ "description": "`Source` is one or more `File` messages comprising a logical set of rules."
+ },
+ "Result": {
+ "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",
+ "description": "Possible result values from the function mock invocation."
+ },
+ "SourcePosition": {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "line": {
+ "type": "integer",
+ "description": "Line number of the source fragment. 1-based.",
+ "format": "int32"
+ }
+ },
+ "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."
+ },
+ "TestCase": {
+ "type": "object",
+ "properties": {
+ "resource": {
+ "type": "any",
+ "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."
+ },
+ "functionMocks": {
+ "type": "array",
+ "items": {
+ "$ref": "FunctionMock"
+ },
+ "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."
+ },
+ "expectation": {
+ "enum": [
+ "EXPECTATION_UNSPECIFIED",
+ "ALLOW",
+ "DENY"
+ ],
+ "description": "Test expectation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified expectation.",
+ "Expect an allowed result.",
+ "Expect a denied result."
+ ]
+ },
+ "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",
+ "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."
+ },
+ "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": {
+ "$ref": "Source",
+ "description": "`Source` for the `Ruleset`."
+ },
+ "createTime": {
+ "description": "Time the `Ruleset` was created.\nOutput only.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Ruleset"
+ },
+ "TestRulesetRequest": {
+ "description": "The request for FirebaseRulesService.TestRuleset.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "Source",
+ "description": "Optional `Source` to be checked for correctness.\n\nThis field must not be set when the resource name refers to a `Ruleset`."
+ },
+ "testSuite": {
+ "$ref": "TestSuite",
+ "description": "Inline `TestSuite` to run."
+ }
+ },
+ "id": "TestRulesetRequest"
+ },
+ "Issue": {
+ "type": "object",
+ "properties": {
+ "sourcePosition": {
+ "$ref": "SourcePosition",
+ "description": "Position of the issue in the `Source`."
+ },
+ "severity": {
+ "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": {
+ "type": "string",
+ "description": "Short error description."
+ }
+ },
+ "id": "Issue",
+ "description": "Issues include warnings, errors, and deprecation notices."
+ },
+ "File": {
+ "type": "object",
+ "properties": {
+ "fingerprint": {
+ "type": "string",
+ "description": "Fingerprint (e.g. github sha) associated with the `File`.",
+ "format": "byte"
+ },
+ "name": {
+ "type": "string",
+ "description": "File name."
+ },
+ "content": {
+ "type": "string",
+ "description": "Textual Content."
+ }
+ },
+ "id": "File",
+ "description": "`File` containing source content."
+ },
+ "ListReleasesResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain."
+ },
+ "releases": {
+ "description": "List of `Release` instances.",
+ "type": "array",
+ "items": {
+ "$ref": "Release"
+ }
+ }
+ },
+ "id": "ListReleasesResponse",
+ "description": "The response for FirebaseRulesService.ListReleases."
+ },
+ "FunctionCall": {
+ "description": "Represents a service-defined function call that was invoked during test\nexecution.",
+ "type": "object",
+ "properties": {
+ "function": {
+ "type": "string",
+ "description": "Name of the function invoked."
+ },
+ "args": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ },
+ "description": "The arguments that were provided to the function."
+ }
+ },
+ "id": "FunctionCall"
+ },
+ "Release": {
+ "type": "object",
+ "properties": {
+ "createTime": {
+ "type": "string",
+ "description": "Time the release was created.\nOutput only.",
+ "format": "google-datetime"
+ },
+ "updateTime": {
+ "type": "string",
+ "description": "Time the release was updated.\nOutput only.",
+ "format": "google-datetime"
+ },
+ "name": {
+ "type": "string",
+ "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}`"
+ },
+ "rulesetName": {
+ "description": "Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must\nexist the `Release` to be created.",
+ "type": "string"
+ }
+ },
+ "id": "Release",
+ "description": "`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a\n`Ruleset`, rules-enabled services will be able to enforce the `Ruleset`."
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "Issue"
+ },
+ "description": "Syntactic and semantic `Source` issues of varying severity. Issues of\n`ERROR` severity will prevent tests from executing."
+ }
+ },
+ "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`.",
+ "type": "array",
+ "items": {
+ "$ref": "FunctionCall"
+ }
+ },
+ "state": {
+ "type": "string",
+ "enumDescriptions": [
+ "Test state is not set.",
+ "Test is a success.",
+ "Test is a failure."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "SUCCESS",
+ "FAILURE"
+ ],
+ "description": "State of the test."
+ },
+ "debugMessages": {
+ "description": "Debug messages related to test execution issues encountered during\nevaluation.\n\nDebug messages may be related to too many or too few invocations of\nfunction mocks or to runtime errors that occur during evaluation.\n\nFor example: ```Unable to read variable [name: \"resource\"]```",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "errorPosition": {
+ "$ref": "SourcePosition",
+ "description": "Position in the `Source` or `Ruleset` where the principle runtime error\noccurs.\n\nEvaluation of an expression may result in an error. Rules are deny by\ndefault, so a `DENY` expectation when an error is generated is valid.\nWhen there is a `DENY` with an error, the `SourcePosition` is returned.\n\nE.g. `error_position { line: 19 column: 37 }`"
+ }
+ },
+ "id": "TestResult"
+ },
+ "ListRulesetsResponse": {
+ "description": "The response for FirebaseRulesService.ListRulesets.",
+ "type": "object",
+ "properties": {
+ "rulesets": {
+ "description": "List of `Ruleset` instances.",
+ "type": "array",
+ "items": {
+ "$ref": "Ruleset"
+ }
+ },
+ "nextPageToken": {
+ "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
+ "type": "string"
+ }
+ },
+ "id": "ListRulesetsResponse"
+ },
+ "Arg": {
+ "description": "Arg matchers for the mock function.",
+ "type": "object",
+ "properties": {
+ "exactValue": {
+ "type": "any",
+ "description": "Argument exactly matches value provided."
+ },
+ "anyValue": {
+ "$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": {
+ "type": "object",
+ "properties": {
+ "release": {
+ "$ref": "Release",
+ "description": "`Release` to update."
+ },
+ "updateMask": {
+ "description": "Specifies which fields to update.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateReleaseRequest",
+ "description": "The request for FirebaseRulesService.UpdateReleasePatch."
+ }
+ },
+ "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": "Firebase Rules",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/firebase": {
+ "description": "View and administer all your Firebase data and settings"
+ },
+ "https://www.googleapis.com/auth/firebase.readonly": {
+ "description": "View all your Firebase data and settings"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://firebaserules.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "firebaserules",
+ "batchPath": "batch"
}
diff --git a/firestore/v1beta1/firestore-api.json b/firestore/v1beta1/firestore-api.json
index 7a49235..17e851e 100644
--- a/firestore/v1beta1/firestore-api.json
+++ b/firestore/v1beta1/firestore-api.json
@@ -1,21 +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",
- "batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Cloud Firestore API",
"ownerName": "Google",
@@ -24,15 +7,104 @@
"resources": {
"databases": {
"resources": {
- "documents": {
+ "indexes": {
"methods": {
- "listCollectionIds": {
- "description": "Lists all the collection IDs underneath a document.",
- "request": {
- "$ref": "ListCollectionIdsRequest"
- },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
"response": {
- "$ref": "ListCollectionIdsResponse"
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "description": "The index name. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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.delete",
+ "path": "v1beta1/{+name}",
+ "description": "Deletes an index."
+ },
+ "list": {
+ "path": "v1beta1/{+parent}/indexes",
+ "id": "firestore.projects.databases.indexes.list",
+ "description": "Lists the indexes that match the specified filters.",
+ "response": {
+ "$ref": "ListIndexesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "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": {
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "The standard List page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The standard List page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes"
+ },
+ "get": {
+ "response": {
+ "$ref": "Index"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$",
+ "location": "path",
+ "description": "The name of the index. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}",
+ "path": "v1beta1/{+name}",
+ "id": "firestore.projects.databases.indexes.get",
+ "description": "Gets an index."
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
},
"parameterOrder": [
"parent"
@@ -44,90 +116,32 @@
],
"parameters": {
"parent": {
- "description": "The parent document. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
+ "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/[^/]+/documents/[^/]+/.+$",
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
"location": "path"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:listCollectionIds",
- "path": "v1beta1/{+parent}:listCollectionIds",
- "id": "firestore.projects.databases.documents.listCollectionIds"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "currentDocument.exists": {
- "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.",
- "type": "boolean",
- "location": "query"
- },
- "name": {
- "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": {
- "location": "query",
- "description": "When set, the target document must exist and have been last updated at\nthat time.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
- "path": "v1beta1/{+name}",
- "id": "firestore.projects.databases.documents.delete",
- "description": "Deletes a document."
- },
- "commit": {
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:commit",
- "id": "firestore.projects.databases.documents.commit",
- "path": "v1beta1/{+database}/documents:commit",
+ "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": "CommitRequest"
- },
- "description": "Commits a transaction, while optionally updating documents.",
- "httpMethod": "POST",
- "parameterOrder": [
- "database"
- ],
- "response": {
- "$ref": "CommitResponse"
- },
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ]
- },
+ "$ref": "Index"
+ }
+ }
+ }
+ },
+ "documents": {
+ "methods": {
"rollback": {
"path": "v1beta1/{+database}/documents:rollback",
"id": "firestore.projects.databases.documents.rollback",
+ "description": "Rolls back a transaction.",
"request": {
"$ref": "RollbackRequest"
},
- "description": "Rolls back a transaction.",
"response": {
"$ref": "Empty"
},
@@ -135,67 +149,38 @@
"database"
],
"httpMethod": "POST",
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
- "required": true,
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
+ "parameters": {
+ "database": {
+ "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:rollback"
},
"write": {
- "httpMethod": "POST",
- "parameterOrder": [
- "database"
- ],
- "response": {
- "$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",
+ "id": "firestore.projects.databases.documents.write",
"request": {
"$ref": "WriteRequest"
},
- "description": "Streams batches of document updates and deletes, in order."
- },
- "batchGet": {
- "id": "firestore.projects.databases.documents.batchGet",
- "path": "v1beta1/{+database}/documents:batchGet",
- "request": {
- "$ref": "BatchGetDocumentsRequest"
+ "description": "Streams batches of document updates and deletes, in order.",
+ "response": {
+ "$ref": "WriteResponse"
},
- "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"
- },
+ "httpMethod": "POST",
"parameters": {
"database": {
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
+ "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/[^/]+$",
@@ -206,18 +191,17 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:batchGet"
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:write"
},
- "beginTransaction": {
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:beginTransaction",
- "path": "v1beta1/{+database}/documents:beginTransaction",
- "id": "firestore.projects.databases.documents.beginTransaction",
- "description": "Starts a new transaction.",
+ "batchGet": {
+ "path": "v1beta1/{+database}/documents:batchGet",
+ "id": "firestore.projects.databases.documents.batchGet",
+ "description": "Gets multiple documents.\n\nDocuments returned by this method are not guaranteed to be returned in the\nsame order that they were requested.",
"request": {
- "$ref": "BeginTransactionRequest"
+ "$ref": "BatchGetDocumentsRequest"
},
"response": {
- "$ref": "BeginTransactionResponse"
+ "$ref": "BatchGetDocumentsResponse"
},
"parameterOrder": [
"database"
@@ -229,15 +213,47 @@
],
"parameters": {
"database": {
+ "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:batchGet"
+ },
+ "beginTransaction": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "database"
+ ],
+ "response": {
+ "$ref": "BeginTransactionResponse"
+ },
+ "parameters": {
+ "database": {
"pattern": "^projects/[^/]+/databases/[^/]+$",
"location": "path",
"description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
"required": true,
"type": "string"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:beginTransaction",
+ "id": "firestore.projects.databases.documents.beginTransaction",
+ "path": "v1beta1/{+database}/documents:beginTransaction",
+ "request": {
+ "$ref": "BeginTransactionRequest"
+ },
+ "description": "Starts a new transaction."
},
"list": {
+ "path": "v1beta1/{+parent}/{collectionId}",
+ "id": "firestore.projects.databases.documents.list",
"description": "Lists documents.",
"response": {
"$ref": "ListDocumentsResponse"
@@ -252,18 +268,6 @@
"https://www.googleapis.com/auth/datastore"
],
"parameters": {
- "pageSize": {
- "location": "query",
- "description": "The maximum number of documents to return.",
- "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": {
"description": "Reads documents in a transaction.",
"format": "byte",
@@ -271,11 +275,16 @@
"location": "query"
},
"parent": {
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
"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"
+ },
+ "orderBy": {
+ "description": "The order to sort results by. For example: `priority desc, name`.",
"type": "string",
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$"
+ "location": "query"
},
"readTime": {
"location": "query",
@@ -283,33 +292,44 @@
"format": "google-datetime",
"type": "string"
},
- "orderBy": {
- "location": "query",
- "description": "The order to sort results by. For example: `priority desc, name`.",
- "type": "string"
- },
"showMissing": {
+ "location": "query",
"description": "If the list should show missing documents. A missing document is a\ndocument that does not exist but has sub-documents. These documents will\nbe returned with a key but will not have fields, Document.create_time,\nor Document.update_time set.\n\nRequests with `show_missing` may not specify `where` or\n`order_by`.",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
},
"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",
- "repeated": true
+ "type": "string"
},
"pageToken": {
"description": "The `next_page_token` value returned from a previous List request, if any.",
"type": "string",
"location": "query"
+ },
+ "collectionId": {
+ "location": "path",
+ "description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`\nor `messages`.",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of documents to return.",
+ "format": "int32",
+ "type": "integer"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}/{collectionId}",
- "path": "v1beta1/{+parent}/{collectionId}",
- "id": "firestore.projects.databases.documents.list"
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}/{collectionId}"
},
"runQuery": {
+ "path": "v1beta1/{+parent}:runQuery",
+ "id": "firestore.projects.databases.documents.runQuery",
+ "request": {
+ "$ref": "RunQueryRequest"
+ },
+ "description": "Runs a query.",
"response": {
"$ref": "RunQueryResponse"
},
@@ -317,28 +337,24 @@
"parent"
],
"httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
- "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"
- }
- },
- "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"
- }
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runQuery"
},
"createDocument": {
+ "path": "v1beta1/{+parent}/{collectionId}",
+ "id": "firestore.projects.databases.documents.createDocument",
"request": {
"$ref": "Document"
},
@@ -359,17 +375,17 @@
"location": "query"
},
"collectionId": {
- "location": "path",
"description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"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/.+$"
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/.+$",
+ "location": "path"
},
"documentId": {
"location": "query",
@@ -381,14 +397,9 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{collectionId}",
- "path": "v1beta1/{+parent}/{collectionId}",
- "id": "firestore.projects.databases.documents.createDocument"
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{collectionId}"
},
"get": {
- "path": "v1beta1/{+name}",
- "id": "firestore.projects.databases.documents.get",
- "description": "Gets a single document.",
"response": {
"$ref": "Document"
},
@@ -396,16 +407,12 @@
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
"parameters": {
"transaction": {
+ "location": "query",
"description": "Reads the document in a transaction.",
"format": "byte",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"name": {
"description": "The resource name of the Document to get. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
@@ -415,21 +422,30 @@
"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"
+ "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"
+ "type": "string",
+ "location": "query"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
+ "path": "v1beta1/{+name}",
+ "id": "firestore.projects.databases.documents.get",
+ "description": "Gets a single document."
},
"patch": {
+ "path": "v1beta1/{+name}",
+ "id": "firestore.projects.databases.documents.patch",
"description": "Updates or inserts a document.",
"request": {
"$ref": "Document"
@@ -446,91 +462,56 @@
"https://www.googleapis.com/auth/datastore"
],
"parameters": {
+ "name": {
+ "description": "The resource name of the document, for example\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
+ "location": "path"
+ },
+ "updateMask.fieldPaths": {
+ "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": {
+ "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
"currentDocument.updateTime": {
+ "location": "query",
"description": "When set, the target document must exist and have been last updated at\nthat time.",
"format": "google-datetime",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"currentDocument.exists": {
"location": "query",
"description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.",
"type": "boolean"
- },
- "name": {
- "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": {
- "location": "query",
- "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
- "type": "string",
- "repeated": true
- },
- "mask.fieldPaths": {
- "repeated": true,
- "location": "query",
- "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
- "type": "string"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
- "path": "v1beta1/{+name}",
- "id": "firestore.projects.databases.documents.patch"
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}"
},
"listen": {
- "description": "Listens to changes.",
"request": {
"$ref": "ListenRequest"
},
- "response": {
- "$ref": "ListenResponse"
- },
+ "description": "Listens to changes.",
+ "httpMethod": "POST",
"parameterOrder": [
"database"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
+ "response": {
+ "$ref": "ListenResponse"
+ },
"parameters": {
"database": {
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:listen",
- "path": "v1beta1/{+database}/documents:listen",
- "id": "firestore.projects.databases.documents.listen"
- }
- }
- },
- "indexes": {
- "methods": {
- "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/[^/]+$",
"location": "path",
- "description": "The name of the database this index will apply to. For example:\n`projects/{project_id}/databases/{database_id}`",
+ "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
"required": true,
"type": "string"
}
@@ -539,12 +520,11 @@
"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:listen",
+ "id": "firestore.projects.databases.documents.listen",
+ "path": "v1beta1/{+database}/documents:listen"
},
"delete": {
- "description": "Deletes an index.",
"response": {
"$ref": "Empty"
},
@@ -558,47 +538,49 @@
],
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
"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 delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$"
+ "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": {
+ "location": "query",
+ "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.",
+ "type": "boolean"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}",
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
"path": "v1beta1/{+name}",
- "id": "firestore.projects.databases.indexes.delete"
+ "id": "firestore.projects.databases.documents.delete",
+ "description": "Deletes a document."
},
- "list": {
- "description": "Lists the indexes that match the specified filters.",
- "httpMethod": "GET",
+ "listCollectionIds": {
+ "path": "v1beta1/{+parent}:listCollectionIds",
+ "id": "firestore.projects.databases.documents.listCollectionIds",
+ "request": {
+ "$ref": "ListCollectionIdsRequest"
+ },
+ "description": "Lists all the collection IDs underneath a document.",
"response": {
- "$ref": "ListIndexesResponse"
+ "$ref": "ListCollectionIdsResponse"
},
"parameterOrder": [
"parent"
],
+ "httpMethod": "POST",
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "The standard List page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard List page size.",
- "format": "int32",
- "type": "integer"
- },
"parent": {
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
"location": "path",
- "description": "The database name. For example:\n`projects/{project_id}/databases/{database_id}`",
+ "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/[^/]+$"
- },
- "filter": {
- "location": "query",
"type": "string"
}
},
@@ -606,35 +588,36 @@
"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.list",
- "path": "v1beta1/{+parent}/indexes"
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:listCollectionIds"
},
- "get": {
- "description": "Gets an index.",
+ "commit": {
"response": {
- "$ref": "Index"
+ "$ref": "CommitResponse"
},
"parameterOrder": [
- "name"
+ "database"
],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$",
- "location": "path",
- "description": "The name of the index. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`",
- "required": true,
- "type": "string"
- }
- },
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}",
- "path": "v1beta1/{+name}",
- "id": "firestore.projects.databases.indexes.get"
+ "parameters": {
+ "database": {
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path",
+ "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:commit",
+ "path": "v1beta1/{+database}/documents:commit",
+ "id": "firestore.projects.databases.documents.commit",
+ "description": "Commits a transaction, while optionally updating documents.",
+ "request": {
+ "$ref": "CommitRequest"
+ }
}
}
}
@@ -644,43 +627,6 @@
}
},
"parameters": {
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "access_token": {
- "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",
@@ -692,150 +638,94 @@
"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"
- },
- "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": {
+ "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",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "type": "string"
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
}
},
"version": "v1beta1",
"baseUrl": "https://firestore.googleapis.com/",
- "servicePath": "",
- "description": "",
"kind": "discovery#restDescription",
+ "description": "",
+ "servicePath": "",
"basePath": "",
- "documentationLink": "https://cloud.google.com/firestore",
"id": "firestore:v1beta1",
- "revision": "20180124",
+ "documentationLink": "https://cloud.google.com/firestore",
+ "revision": "20180117",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Status": {
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
- },
- "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": {
- "description": "The document's fields.\n\nThe map keys represent field names.\n\nA simple field name contains only characters `a` to `z`, `A` to `Z`,\n`0` to `9`, or `_`, and must not start with `0` to `9`. For example,\n`foo_bar_17`.\n\nField names matching the regular expression `__.*__` are reserved. Reserved\nfield names are forbidden except in certain documented contexts. The map\nkeys, represented as UTF-8, must not exceed 1,500 bytes and cannot be\nempty.\n\nField paths may be used in other contexts to refer to structured fields\ndefined here. For `map_value`, the field path is represented by the simple\nor quoted field names of the containing fields, delimited by `.`. For\nexample, the structured field\n`\"foo\" : { map_value: { \"x&y\" : { string_value: \"hello\" }}}` would be\nrepresented by the field path `foo.x&y`.\n\nWithin a field path, a quoted field name starts and ends with `` ` `` and\nmay contain any character. Some characters, including `` ` ``, must be\nescaped using a `\\`. For example, `` `x&y` `` represents `x&y` and\n`` `bak\\`tik` `` represents `` bak`tik ``.",
- "type": "object",
- "additionalProperties": {
- "$ref": "Value"
- }
- },
- "updateTime": {
- "description": "Output only. The time at which the document was last changed.\n\nThis value is initally set to the `create_time` then increases\nmonotonically with each change to the document. It can also be\ncompared to values from other documents and the `read_time` of a query.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the document, for example\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
- "type": "string"
- }
- },
- "id": "Document"
- },
- "Projection": {
- "properties": {
- "fields": {
- "description": "The fields to return.\n\nIf empty, all fields are returned. To only return the name\nof the document, use `['__name__']`.",
- "type": "array",
- "items": {
- "$ref": "FieldReference"
- }
- }
- },
- "id": "Projection",
- "description": "The projection of document's fields to return.",
- "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": {
- "readTime": {
- "description": "The read timestamp at which the remove was observed.\n\nGreater or equal to the `commit_time` of the change/delete/remove.",
- "format": "google-datetime",
- "type": "string"
- },
- "removedTargetIds": {
- "description": "A set of target IDs for targets that previously matched this document.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- },
- "document": {
- "description": "The resource name of the Document that has gone out of view.",
- "type": "string"
- }
- },
- "id": "DocumentRemove"
- },
"ListDocumentsResponse": {
"description": "The response for Firestore.ListDocuments.",
"type": "object",
@@ -867,7 +757,16 @@
"type": "object"
},
"CompositeFilter": {
+ "description": "A filter that merges multiple other filters using the given operator.",
+ "type": "object",
"properties": {
+ "filters": {
+ "description": "The list of filters to combine.\nMust contain at least one filter.",
+ "type": "array",
+ "items": {
+ "$ref": "Filter"
+ }
+ },
"op": {
"enum": [
"OPERATOR_UNSPECIFIED",
@@ -879,18 +778,9 @@
"Unspecified. This value must not be used.",
"The results are required to satisfy each of the combined filters."
]
- },
- "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"
+ "id": "CompositeFilter"
},
"DocumentsTarget": {
"description": "A target specified by a set of documents names.",
@@ -907,8 +797,6 @@
"id": "DocumentsTarget"
},
"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",
"properties": {
"fieldPaths": {
"description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
@@ -918,25 +806,27 @@
}
}
},
- "id": "DocumentMask"
+ "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": {
- "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"
}
+ },
+ "document": {
+ "description": "The name of the document to transform.",
+ "type": "string"
}
},
- "id": "DocumentTransform"
+ "id": "DocumentTransform",
+ "description": "A transformation of a document.",
+ "type": "object"
},
"FieldTransform": {
"properties": {
@@ -961,6 +851,25 @@
"description": "A transformation of a field of the document.",
"type": "object"
},
+ "CommitResponse": {
+ "properties": {
+ "writeResults": {
+ "description": "The result of applying the writes.\n\nThis i-th write result corresponds to the i-th write in the\nrequest.",
+ "type": "array",
+ "items": {
+ "$ref": "WriteResult"
+ }
+ },
+ "commitTime": {
+ "description": "The time at which the commit occurred.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "CommitResponse",
+ "description": "The response for Firestore.Commit.",
+ "type": "object"
+ },
"ListCollectionIdsResponse": {
"properties": {
"collectionIds": {
@@ -979,38 +888,8 @@
"description": "The response from Firestore.ListCollectionIds.",
"type": "object"
},
- "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"
- },
"WriteResponse": {
- "description": "The response for Firestore.Write.",
- "type": "object",
"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",
@@ -1022,29 +901,40 @@
"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"
+ "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"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Ascending.",
+ "Descending."
+ ]
+ },
+ "field": {
+ "$ref": "FieldReference",
+ "description": "The field to order by."
}
},
"id": "Order",
@@ -1055,23 +945,11 @@
"description": "A filter on a specific field.",
"type": "object",
"properties": {
- "field": {
- "description": "The field to filter by.",
- "$ref": "FieldReference"
- },
"value": {
"$ref": "Value",
"description": "The value to compare to."
},
"op": {
- "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",
@@ -1081,15 +959,34 @@
"EQUAL"
],
"description": "The operator to filter by.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Less than. Requires that the field come first in `order_by`.",
+ "Less than or equal. Requires that the field come first in `order_by`.",
+ "Greater than. Requires that the field come first in `order_by`.",
+ "Greater than or equal. Requires that the field come first in\n`order_by`.",
+ "Equal."
+ ]
+ },
+ "field": {
+ "description": "The field to filter by.",
+ "$ref": "FieldReference"
}
},
"id": "FieldFilter"
},
"TargetChange": {
- "description": "Targets being watched have changed.",
- "type": "object",
"properties": {
+ "cause": {
+ "$ref": "Status",
+ "description": "The error that resulted in this change, if applicable."
+ },
+ "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`.",
@@ -1120,22 +1017,13 @@
"format": "int32",
"type": "integer"
}
- },
- "cause": {
- "$ref": "Status",
- "description": "The error that resulted in this change, if applicable."
- },
- "readTime": {
- "description": "The consistent `read_time` for the given `target_ids` (omitted when the\ntarget_ids are not at a consistent snapshot).\n\nThe stream is guaranteed to send a `read_time` with `target_ids` empty\nwhenever the entire stream reaches a new consistent snapshot. ADD,\nCURRENT, and RESET messages are guaranteed to (eventually) result in a\nnew consistent snapshot (while NO_CHANGE and REMOVE messages are not).\n\nFor a given stream, `read_time` is guaranteed to be monotonically\nincreasing.",
- "format": "google-datetime",
- "type": "string"
}
},
- "id": "TargetChange"
+ "id": "TargetChange",
+ "description": "Targets being watched have changed.",
+ "type": "object"
},
"MapValue": {
- "description": "A map value.",
- "type": "object",
"properties": {
"fields": {
"additionalProperties": {
@@ -1145,11 +1033,11 @@
"type": "object"
}
},
- "id": "MapValue"
+ "id": "MapValue",
+ "description": "A map value.",
+ "type": "object"
},
"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.",
@@ -1169,7 +1057,9 @@
"type": "string"
}
},
- "id": "DocumentDelete"
+ "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"
},
"BeginTransactionResponse": {
"properties": {
@@ -1184,39 +1074,32 @@
"type": "object"
},
"IndexField": {
- "description": "A field of an index.",
- "type": "object",
"properties": {
+ "fieldPath": {
+ "description": "The path of the field. Must match the field path specification described\nby google.firestore.v1beta1.Document.fields.\nSpecial field path `__name__` may be used by itself or at the end of a\npath. `__type__` may be used only at the end of path.",
+ "type": "string"
+ },
"mode": {
+ "enum": [
+ "MODE_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
"description": "The field's mode.",
"type": "string",
"enumDescriptions": [
"The mode is unspecified.",
"The field's values are indexed so as to support sequencing in\nascending order and also query by \u003c, \u003e, \u003c=, \u003e=, and =.",
"The field's values are indexed so as to support sequencing in\ndescending order and also query by \u003c, \u003e, \u003c=, \u003e=, and =."
- ],
- "enum": [
- "MODE_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
]
- },
- "fieldPath": {
- "description": "The path of the field. Must match the field path specification described\nby google.firestore.v1beta1.Document.fields.\nSpecial field path `__name__` may be used by itself or at the end of a\npath. `__type__` may be used only at the end of path.",
- "type": "string"
}
},
- "id": "IndexField"
+ "id": "IndexField",
+ "description": "A field of an index.",
+ "type": "object"
},
"RunQueryResponse": {
- "description": "The response for Firestore.RunQuery.",
- "type": "object",
"properties": {
- "skippedResults": {
- "description": "The number of results that have been skipped due to an offset between\nthe last response and the current response.",
- "format": "int32",
- "type": "integer"
- },
"transaction": {
"description": "The transaction that was started as part of this request.\nCan only be set in the first response, and only if\nRunQueryRequest.new_transaction was set in the request.\nIf set, no other fields will be set in this response.",
"format": "byte",
@@ -1230,20 +1113,16 @@
"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",
"type": "string"
+ },
+ "skippedResults": {
+ "description": "The number of results that have been skipped due to an offset between\nthe last response and the current response.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "RunQueryResponse"
- },
- "BeginTransactionRequest": {
- "description": "The request for Firestore.BeginTransaction.",
- "type": "object",
- "properties": {
- "options": {
- "description": "The options for the transaction.\nDefaults to a read-write transaction.",
- "$ref": "TransactionOptions"
- }
- },
- "id": "BeginTransactionRequest"
+ "id": "RunQueryResponse",
+ "description": "The response for Firestore.RunQuery.",
+ "type": "object"
},
"CommitRequest": {
"description": "The request for Firestore.Commit.",
@@ -1264,10 +1143,25 @@
},
"id": "CommitRequest"
},
+ "BeginTransactionRequest": {
+ "description": "The request for Firestore.BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "options": {
+ "description": "The options for the transaction.\nDefaults to a read-write transaction.",
+ "$ref": "TransactionOptions"
+ }
+ },
+ "id": "BeginTransactionRequest"
+ },
"ListenRequest": {
"description": "A request for Firestore.Listen",
"type": "object",
"properties": {
+ "addTarget": {
+ "$ref": "Target",
+ "description": "A target to add to this stream."
+ },
"labels": {
"additionalProperties": {
"type": "string"
@@ -1279,10 +1173,6 @@
"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"
@@ -1291,13 +1181,13 @@
"description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
"type": "object",
"properties": {
- "longitude": {
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "latitude": {
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"format": "double",
"type": "number"
},
- "latitude": {
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "longitude": {
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"format": "double",
"type": "number"
}
@@ -1334,8 +1224,6 @@
"id": "ArrayValue"
},
"Index": {
- "description": "An index definition.",
- "type": "object",
"properties": {
"fields": {
"description": "The fields to index.",
@@ -1369,35 +1257,14 @@
"type": "string"
}
},
- "id": "Index"
+ "id": "Index",
+ "description": "An index definition.",
+ "type": "object"
},
"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."
- },
- "orderBy": {
- "description": "The order to apply to the query results.\n\nFirestore guarantees a stable ordering through the following rules:\n\n * Any field required to appear in `order_by`, that is not already\n specified in `order_by`, is appended to the order in field name order\n by default.\n * If an order on `__name__` is not specified, it is appended by default.\n\nFields are appended with the same sort direction as the last order\nspecified, or 'ASCENDING' if no order was specified. For example:\n\n * `SELECT * FROM Foo ORDER BY A` becomes\n `SELECT * FROM Foo ORDER BY A, __name__`\n * `SELECT * FROM Foo ORDER BY A DESC` becomes\n `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`\n * `SELECT * FROM Foo WHERE A \u003e 1` becomes\n `SELECT * FROM Foo WHERE A \u003e 1 ORDER BY A, __name__`",
- "type": "array",
- "items": {
- "$ref": "Order"
- }
- },
- "select": {
- "description": "The projection to return.",
- "$ref": "Projection"
- },
"limit": {
"description": "The maximum number of results to return.\n\nApplies after all other constraints.\nMust be \u003e= 0 if specified.",
"format": "int32",
@@ -1414,17 +1281,36 @@
"items": {
"$ref": "CollectionSelector"
}
+ },
+ "endAt": {
+ "$ref": "Cursor",
+ "description": "A end point for the query results."
+ },
+ "startAt": {
+ "description": "A starting point for the query results.",
+ "$ref": "Cursor"
+ },
+ "where": {
+ "$ref": "Filter",
+ "description": "The filter to apply."
+ },
+ "orderBy": {
+ "description": "The order to apply to the query results.\n\nFirestore guarantees a stable ordering through the following rules:\n\n * Any field required to appear in `order_by`, that is not already\n specified in `order_by`, is appended to the order in field name order\n by default.\n * If an order on `__name__` is not specified, it is appended by default.\n\nFields are appended with the same sort direction as the last order\nspecified, or 'ASCENDING' if no order was specified. For example:\n\n * `SELECT * FROM Foo ORDER BY A` becomes\n `SELECT * FROM Foo ORDER BY A, __name__`\n * `SELECT * FROM Foo ORDER BY A DESC` becomes\n `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`\n * `SELECT * FROM Foo WHERE A \u003e 1` becomes\n `SELECT * FROM Foo WHERE A \u003e 1 ORDER BY A, __name__`",
+ "type": "array",
+ "items": {
+ "$ref": "Order"
+ }
+ },
+ "select": {
+ "$ref": "Projection",
+ "description": "The projection to return."
}
},
"id": "StructuredQuery"
},
"UnaryFilter": {
- "description": "A filter with a single operand.",
- "type": "object",
"properties": {
"op": {
- "description": "The unary operator to apply.",
- "type": "string",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Test if a field is equal to NaN.",
@@ -1434,33 +1320,67 @@
"OPERATOR_UNSPECIFIED",
"IS_NAN",
"IS_NULL"
- ]
+ ],
+ "description": "The unary operator to apply.",
+ "type": "string"
},
"field": {
- "$ref": "FieldReference",
- "description": "The field to which to apply the operator."
+ "description": "The field to which to apply the operator.",
+ "$ref": "FieldReference"
}
},
- "id": "UnaryFilter"
+ "id": "UnaryFilter",
+ "description": "A filter with a single operand.",
+ "type": "object"
},
"Filter": {
+ "description": "A filter.",
+ "type": "object",
"properties": {
+ "unaryFilter": {
+ "$ref": "UnaryFilter",
+ "description": "A filter that takes exactly one argument."
+ },
"compositeFilter": {
"description": "A composite filter.",
"$ref": "CompositeFilter"
},
"fieldFilter": {
- "description": "A filter on a document field.",
- "$ref": "FieldFilter"
- },
- "unaryFilter": {
- "description": "A filter that takes exactly one argument.",
- "$ref": "UnaryFilter"
+ "$ref": "FieldFilter",
+ "description": "A filter on a document field."
}
},
- "id": "Filter",
- "description": "A filter.",
- "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": {
+ "streamId": {
+ "description": "The ID of the write stream to resume.\nThis may only be set in the first message. When left empty, a new write\nstream will be created.",
+ "type": "string"
+ },
+ "streamToken": {
+ "description": "A stream token that was previously sent by the server.\n\nThe client should set this field to the token from the most recent\nWriteResponse it has received. This acknowledges that the client has\nreceived responses up to this token. After sending this token, earlier\ntokens may not be used anymore.\n\nThe server may close the stream if there are too many unacknowledged\nresponses.\n\nLeave this field unset when creating a new stream. To resume a stream at\na specific point, set this field and the `stream_id` field.\n\nLeave this field unset when creating a new stream.",
+ "format": "byte",
+ "type": "string"
+ },
+ "writes": {
+ "description": "The writes to apply.\n\nAlways executed atomically and in order.\nThis must be empty on the first request.\nThis may be empty on the last request.\nThis must not be empty on all other requests.",
+ "type": "array",
+ "items": {
+ "$ref": "Write"
+ }
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels associated with this write request.",
+ "type": "object"
+ }
+ },
+ "id": "WriteRequest"
},
"BatchGetDocumentsResponse": {
"description": "The streamed response for Firestore.BatchGetDocuments.",
@@ -1487,49 +1407,8 @@
},
"id": "BatchGetDocumentsResponse"
},
- "WriteRequest": {
- "description": "The request for Firestore.Write.\n\nThe first request creates a stream, or resumes an existing one from a token.\n\nWhen creating a new stream, the server replies with a response containing\nonly an ID and a token, to use in the next request.\n\nWhen resuming a stream, the server first streams any responses later than the\ngiven token, then a response containing only an up-to-date token, to use in\nthe next request.",
- "type": "object",
- "properties": {
- "streamId": {
- "description": "The ID of the write stream to resume.\nThis may only be set in the first message. When left empty, a new write\nstream will be created.",
- "type": "string"
- },
- "streamToken": {
- "description": "A stream token that was previously sent by the server.\n\nThe client should set this field to the token from the most recent\nWriteResponse it has received. This acknowledges that the client has\nreceived responses up to this token. After sending this token, earlier\ntokens may not be used anymore.\n\nThe server may close the stream if there are too many unacknowledged\nresponses.\n\nLeave this field unset when creating a new stream. To resume a stream at\na specific point, set this field and the `stream_id` field.\n\nLeave this field unset when creating a new stream.",
- "format": "byte",
- "type": "string"
- },
- "writes": {
- "description": "The writes to apply.\n\nAlways executed atomically and in order.\nThis must be empty on the first request.\nThis may be empty on the last request.\nThis must not be empty on all other requests.",
- "type": "array",
- "items": {
- "$ref": "Write"
- }
- },
- "labels": {
- "description": "Labels associated with this write request.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "id": "WriteRequest"
- },
"Target": {
- "description": "A specification of a set of documents to listen to.",
- "type": "object",
"properties": {
- "resumeToken": {
- "description": "A resume token from a prior TargetChange for an identical target.\n\nUsing a resume token with a different target is unsupported and may fail.",
- "format": "byte",
- "type": "string"
- },
- "once": {
- "description": "If the target should be removed once it is current and consistent.",
- "type": "boolean"
- },
"readTime": {
"description": "Start listening after a specific `read_time`.\n\nThe client must know the state of matching documents at this time.",
"format": "google-datetime",
@@ -1547,36 +1426,30 @@
"query": {
"description": "A target specified by a query.",
"$ref": "QueryTarget"
- }
- },
- "id": "Target"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "Precondition": {
- "description": "A precondition on a document, used for conditional operations.",
- "type": "object",
- "properties": {
- "updateTime": {
- "description": "When set, the target document must exist and have been last updated at\nthat time.",
- "format": "google-datetime",
+ },
+ "resumeToken": {
+ "description": "A resume token from a prior TargetChange for an identical target.\n\nUsing a resume token with a different target is unsupported and may fail.",
+ "format": "byte",
"type": "string"
},
- "exists": {
- "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.",
+ "once": {
+ "description": "If the target should be removed once it is current and consistent.",
"type": "boolean"
}
},
- "id": "Precondition"
+ "id": "Target",
+ "description": "A specification of a set of documents to listen to.",
+ "type": "object"
},
"RunQueryRequest": {
"description": "The request for Firestore.RunQuery.",
"type": "object",
"properties": {
+ "transaction": {
+ "description": "Reads documents in a transaction.",
+ "format": "byte",
+ "type": "string"
+ },
"structuredQuery": {
"description": "A structured query.",
"$ref": "StructuredQuery"
@@ -1589,15 +1462,32 @@
"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"
- },
- "transaction": {
- "description": "Reads documents in a transaction.",
- "format": "byte",
- "type": "string"
}
},
"id": "RunQueryRequest"
},
+ "Precondition": {
+ "description": "A precondition on a document, used for conditional operations.",
+ "type": "object",
+ "properties": {
+ "exists": {
+ "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.",
+ "type": "boolean"
+ },
+ "updateTime": {
+ "description": "When set, the target document must exist and have been last updated at\nthat time.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Precondition"
+ },
+ "Empty": {
+ "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"
+ },
"ListIndexesResponse": {
"description": "The response for FirestoreAdmin.ListIndexes.",
"type": "object",
@@ -1617,19 +1507,19 @@
"id": "ListIndexesResponse"
},
"TransactionOptions": {
+ "description": "Options for creating a new transaction.",
+ "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": {
- "$ref": "ReadWrite",
- "description": "The transaction can be used for both read and write operations."
+ "description": "The transaction can be used for both read and write operations.",
+ "$ref": "ReadWrite"
}
},
- "id": "TransactionOptions",
- "description": "Options for creating a new transaction.",
- "type": "object"
+ "id": "TransactionOptions"
},
"FieldReference": {
"description": "A reference to a field, such as `max(messages.time) as max_time`.",
@@ -1642,16 +1532,10 @@
"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."
- },
"documentChange": {
- "$ref": "DocumentChange",
- "description": "A Document has changed."
+ "description": "A Document has changed.",
+ "$ref": "DocumentChange"
},
"targetChange": {
"description": "Targets have changed.",
@@ -1664,13 +1548,17 @@
"documentDelete": {
"description": "A Document has been deleted.",
"$ref": "DocumentDelete"
+ },
+ "filter": {
+ "$ref": "ExistenceFilter",
+ "description": "A filter to apply to the set of documents previously returned for the\ngiven target.\n\nReturned when documents may have been removed from the given target, but\nthe exact documents are unknown."
}
},
- "id": "ListenResponse"
+ "id": "ListenResponse",
+ "description": "The response for Firestore.Listen.",
+ "type": "object"
},
"ListCollectionIdsRequest": {
- "description": "The request for Firestore.ListCollectionIds.",
- "type": "object",
"properties": {
"pageToken": {
"description": "A page token. Must be a value from\nListCollectionIdsResponse.",
@@ -1682,7 +1570,9 @@
"type": "integer"
}
},
- "id": "ListCollectionIdsRequest"
+ "id": "ListCollectionIdsRequest",
+ "description": "The request for Firestore.ListCollectionIds.",
+ "type": "object"
},
"ExistenceFilter": {
"properties": {
@@ -1733,18 +1623,7 @@
"type": "object"
},
"Value": {
- "description": "A message that can hold any of the supported value types.",
- "type": "object",
"properties": {
- "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",
@@ -1772,57 +1651,66 @@
"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"
},
+ "nullValue": {
+ "enum": [
+ "NULL_VALUE"
+ ],
+ "description": "A null value.",
+ "type": "string",
+ "enumDescriptions": [
+ "Null value."
+ ]
+ },
"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"
}
},
- "id": "Value"
+ "id": "Value",
+ "description": "A message that can hold any of the supported value types.",
+ "type": "object"
},
"Write": {
+ "description": "A write on a document.",
+ "type": "object",
"properties": {
- "update": {
- "$ref": "Document",
- "description": "A document to write."
- },
- "transform": {
- "$ref": "DocumentTransform",
- "description": "Applies a tranformation to a document.\nAt most one `transform` per document is allowed in a given request.\nAn `update` cannot follow a `transform` on the same document in a given\nrequest."
- },
"delete": {
"description": "A document name to delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
"type": "string"
},
"updateMask": {
"$ref": "DocumentMask",
- "description": "The fields to update in this write.\n\nThis field can be set only when the operation is `update`.\nIf the mask is not set for an `update` and the document exists, any\nexisting data will be overwritten.\nIf the mask is set and the document on the server has fields not covered by\nthe mask, they are left unchanged.\nFields referenced in the mask, but not present in the input document, are\ndeleted from the document on the server.\nThe field paths in this mask must not contain a reserved field name."
+ "description": "The fields to update in this write.\n\nThis field can be set only when the operation is `update`.\nNone of the field paths in the mask may contain a reserved name.\nIf the document exists on the server and has fields not referenced in the\nmask, they are left unchanged.\nFields referenced in the mask, but not present in the input document, are\ndeleted from the document on the server.\nThe field paths in this mask must not contain a reserved field name."
},
"currentDocument": {
- "$ref": "Precondition",
- "description": "An optional precondition on the document.\n\nThe write will fail if this is set and not met by the target document."
+ "description": "An optional precondition on the document.\n\nThe write will fail if this is set and not met by the target document.",
+ "$ref": "Precondition"
+ },
+ "update": {
+ "$ref": "Document",
+ "description": "A document to write."
+ },
+ "transform": {
+ "description": "Applies a tranformation to a document.\nAt most one `transform` per document is allowed in a given request.\nAn `update` cannot follow a `transform` on the same document in a given\nrequest.",
+ "$ref": "DocumentTransform"
}
},
- "id": "Write",
- "description": "A write on a document.",
- "type": "object"
+ "id": "Write"
},
"Cursor": {
- "description": "A position in a query result set.",
- "type": "object",
"properties": {
"before": {
"description": "If the position is just before or just after the given values, relative\nto the sort order defined by the query.",
@@ -1836,7 +1724,9 @@
}
}
},
- "id": "Cursor"
+ "id": "Cursor",
+ "description": "A position in a query result set.",
+ "type": "object"
},
"ReadWrite": {
"description": "Options for a transaction that can be used to read and write documents.",
@@ -1874,30 +1764,44 @@
"$ref": "TransactionOptions"
},
"mask": {
- "description": "The fields to return. If not set, returns all fields.\n\nIf a document has a field that is not present in this mask, that field will\nnot be returned in the response.",
- "$ref": "DocumentMask"
+ "$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."
}
},
"id": "BatchGetDocumentsRequest",
"description": "The request for Firestore.BatchGetDocuments.",
"type": "object"
},
- "QueryTarget": {
+ "DocumentChange": {
"properties": {
- "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"
+ "removedTargetIds": {
+ "description": "A set of target IDs for targets that no longer match this document.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
},
- "structuredQuery": {
- "description": "A structured query.",
- "$ref": "StructuredQuery"
+ "document": {
+ "description": "The new state of the Document.\n\nIf `mask` is set, contains only fields that were updated or added.",
+ "$ref": "Document"
+ },
+ "targetIds": {
+ "description": "A set of target IDs of targets that match this document.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
}
},
- "id": "QueryTarget",
- "description": "A target specified by a query.",
+ "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"
},
"Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
"properties": {
"response": {
"additionalProperties": {
@@ -1912,8 +1816,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": {
@@ -1928,14 +1832,103 @@
"type": "boolean"
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
+ "id": "Operation"
},
- "DocumentChange": {
+ "QueryTarget": {
+ "description": "A target specified by a query.",
+ "type": "object",
"properties": {
+ "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": {
+ "description": "A structured query.",
+ "$ref": "StructuredQuery"
+ }
+ },
+ "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": {
+ "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"
+ },
+ "Document": {
+ "description": "A Firestore document.\n\nMust not exceed 1 MiB - 4 bytes.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "additionalProperties": {
+ "$ref": "Value"
+ },
+ "description": "The document's fields.\n\nThe map keys represent field names.\n\nA simple field name contains only characters `a` to `z`, `A` to `Z`,\n`0` to `9`, or `_`, and must not start with `0` to `9`. For example,\n`foo_bar_17`.\n\nField names matching the regular expression `__.*__` are reserved. Reserved\nfield names are forbidden except in certain documented contexts. The map\nkeys, represented as UTF-8, must not exceed 1,500 bytes and cannot be\nempty.\n\nField paths may be used in other contexts to refer to structured fields\ndefined here. For `map_value`, the field path is represented by the simple\nor quoted field names of the containing fields, delimited by `.`. For\nexample, the structured field\n`\"foo\" : { map_value: { \"x&y\" : { string_value: \"hello\" }}}` would be\nrepresented by the field path `foo.x&y`.\n\nWithin a field path, a quoted field name starts and ends with `` ` `` and\nmay contain any character. Some characters, including `` ` ``, must be\nescaped using a `\\`. For example, `` `x&y` `` represents `x&y` and\n`` `bak\\`tik` `` represents `` bak`tik ``.",
+ "type": "object"
+ },
+ "updateTime": {
+ "description": "Output only. The time at which the document was last changed.\n\nThis value is initally set to the `create_time` then increases\nmonotonically with each change to the document. It can also be\ncompared to values from other documents and the `read_time` of a query.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the document, for example\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
+ "type": "string"
+ },
+ "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"
+ },
+ "Projection": {
+ "description": "The projection of document's fields to return.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "The fields to return.\n\nIf empty, all fields are returned. To only return the name\nof the document, use `['__name__']`.",
+ "type": "array",
+ "items": {
+ "$ref": "FieldReference"
+ }
+ }
+ },
+ "id": "Projection"
+ },
+ "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": {
+ "readTime": {
+ "description": "The read timestamp at which the remove was observed.\n\nGreater or equal to the `commit_time` of the change/delete/remove.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"removedTargetIds": {
- "description": "A set of target IDs for targets that no longer match this document.",
+ "description": "A set of target IDs for targets that previously matched this document.",
"type": "array",
"items": {
"format": "int32",
@@ -1943,26 +1936,33 @@
}
},
"document": {
- "$ref": "Document",
- "description": "The new state of the Document.\n\nIf `mask` is set, contains only fields that were updated or added."
- },
- "targetIds": {
- "description": "A set of target IDs of targets that match this document.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
+ "description": "The resource name of the Document that has gone out of view.",
+ "type": "string"
}
},
- "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": "DocumentRemove"
}
},
- "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": "Firestore",
+ "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"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://firestore.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "firestore",
+ "batchPath": "batch"
}
diff --git a/firestore/v1beta1/firestore-gen.go b/firestore/v1beta1/firestore-gen.go
index 6fcd9e5..cf7c2fc 100644
--- a/firestore/v1beta1/firestore-gen.go
+++ b/firestore/v1beta1/firestore-gen.go
@@ -2425,12 +2425,10 @@
// UpdateMask: The fields to update in this write.
//
// This field can be set only when the operation is `update`.
- // If the mask is not set for an `update` and the document exists,
- // any
- // existing data will be overwritten.
- // If the mask is set and the document on the server has fields not
- // covered by
- // the mask, they are left unchanged.
+ // None of the field paths in the mask may contain a reserved name.
+ // If the document exists on the server and has fields not referenced in
+ // the
+ // mask, they are left unchanged.
// Fields referenced in the mask, but not present in the input document,
// are
// deleted from the document on the server.
diff --git a/genomics/v1/genomics-api.json b/genomics/v1/genomics-api.json
index 0cae55e..a41da47 100644
--- a/genomics/v1/genomics-api.json
+++ b/genomics/v1/genomics-api.json
@@ -1,26 +1,172 @@
{
+ "baseUrl": "https://genomics.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/genomics.readonly": {
+ "description": "View Genomics data"
+ },
+ "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"
+ },
+ "https://www.googleapis.com/auth/devstorage.read_write": {
+ "description": "Manage your data in Google Cloud Storage"
+ }
+ }
+ }
+ },
+ "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": "20180123",
- "documentationLink": "https://cloud.google.com/genomics",
"id": "genomics:v1",
+ "documentationLink": "https://cloud.google.com/genomics",
"title": "Genomics API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
+ "annotationsets": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an annotation set. Caller must have WRITE permission\nfor the associated annotation set.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "parameters": {
+ "annotationSetId": {
+ "location": "path",
+ "description": "The ID of the annotation set to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/annotationsets/{annotationSetId}",
+ "id": "genomics.annotationsets.delete",
+ "path": "v1/annotationsets/{annotationSetId}"
+ },
+ "search": {
+ "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.",
+ "request": {
+ "$ref": "SearchAnnotationSetsRequest"
+ },
+ "response": {
+ "$ref": "SearchAnnotationSetsResponse"
+ },
+ "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/annotationsets/search",
+ "path": "v1/annotationsets/search",
+ "id": "genomics.annotationsets.search"
+ },
+ "get": {
+ "flatPath": "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.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "parameters": {
+ "annotationSetId": {
+ "description": "The ID of the annotation set 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"
+ ]
+ },
+ "update": {
+ "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.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "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.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "annotationSetId": {
+ "description": "The ID of the annotation set to be updated.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/annotationsets/{annotationSetId}",
+ "id": "genomics.annotationsets.update",
+ "path": "v1/annotationsets/{annotationSetId}"
+ },
+ "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"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/annotationsets",
+ "path": "v1/annotationsets",
+ "id": "genomics.annotationsets.create"
+ }
+ }
+ },
"variants": {
"methods": {
"search": {
- "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"
- },
"response": {
"$ref": "SearchVariantsResponse"
},
@@ -31,12 +177,16 @@
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
- "parameters": {}
+ "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": {
- "flatPath": "v1/variants/{variantId}",
- "path": "v1/variants/{variantId}",
- "id": "genomics.variants.get",
"description": "Gets a variant by ID.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"response": {
"$ref": "Variant"
@@ -52,18 +202,21 @@
],
"parameters": {
"variantId": {
- "location": "path",
"description": "The ID of the variant.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
- }
+ },
+ "flatPath": "v1/variants/{variantId}",
+ "path": "v1/variants/{variantId}",
+ "id": "genomics.variants.get"
},
"patch": {
- "description": "Updates a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics. Returns the modified variant without\nits calls.",
"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"
},
@@ -71,10 +224,6 @@
"variantId"
],
"httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
"parameters": {
"variantId": {
"description": "The ID of the variant to be updated.",
@@ -83,24 +232,28 @@
"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",
- "location": "query"
+ "type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
"flatPath": "v1/variants/{variantId}",
"path": "v1/variants/{variantId}",
"id": "genomics.variants.patch"
},
"delete": {
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"variantId"
],
+ "httpMethod": "DELETE",
"parameters": {
"variantId": {
"description": "The ID of the variant to be deleted.",
@@ -114,36 +267,11 @@
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/variants/{variantId}",
- "id": "genomics.variants.delete",
"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)"
},
- "merge": {
- "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",
- "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."
- },
"import": {
- "path": "v1/variants:import",
- "id": "genomics.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.",
"response": {
"$ref": "Operation"
},
@@ -155,17 +283,34 @@
"https://www.googleapis.com/auth/devstorage.read_write",
"https://www.googleapis.com/auth/genomics"
],
- "flatPath": "v1/variants:import"
+ "flatPath": "v1/variants:import",
+ "path": "v1/variants:import",
+ "id": "genomics.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."
},
- "create": {
- "parameters": {},
+ "merge": {
+ "flatPath": "v1/variants:merge",
+ "path": "v1/variants:merge",
+ "id": "genomics.variants.merge",
+ "description": "Merges the given variants with existing variants.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach variant will be\nmerged with an existing variant that matches its reference sequence,\nstart, end, reference bases, and alternative bases. If no such variant\nexists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant. Variant info fields are merged as\nspecified in the\ninfoMergeConfig\nfield of the MergeVariantsRequest.\n\nPlease exercise caution when using this method! It is easy to introduce\nmistakes in existing variants and difficult to back out of them. For\nexample,\nsuppose you were trying to merge a new variant with an existing one and\nboth\nvariants contain calls that belong to callsets with the same callset ID.\n\n // Existing variant - irrelevant fields trimmed for clarity\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 0,\n 1\n ],\n }\n ]\n }\n\n // New variant with conflicting call information\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThe resulting merged variant would overwrite the existing calls with those\nfrom the new variant:\n\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThis may be the desired outcome, but it is up to the user to determine if\nif that is indeed the case.",
+ "request": {
+ "$ref": "MergeVariantsRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
- "flatPath": "v1/variants",
- "path": "v1/variants",
- "id": "genomics.variants.create",
+ "parameters": {}
+ },
+ "create": {
"request": {
"$ref": "Variant"
},
@@ -174,221 +319,20 @@
"$ref": "Variant"
},
"parameterOrder": [],
- "httpMethod": "POST"
- }
- }
- },
- "annotationsets": {
- "methods": {
- "search": {
- "path": "v1/annotationsets/search",
- "id": "genomics.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.",
- "response": {
- "$ref": "SearchAnnotationSetsResponse"
- },
- "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/annotationsets/search"
- },
- "get": {
- "description": "Gets an annotation set. Caller must have READ permission for\nthe associated dataset.",
- "httpMethod": "GET",
- "parameterOrder": [
- "annotationSetId"
- ],
- "response": {
- "$ref": "AnnotationSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "annotationSetId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the annotation set to be retrieved."
- }
- },
- "flatPath": "v1/annotationsets/{annotationSetId}",
- "id": "genomics.annotationsets.get",
- "path": "v1/annotationsets/{annotationSetId}"
- },
- "update": {
- "flatPath": "v1/annotationsets/{annotationSetId}",
- "id": "genomics.annotationsets.update",
- "path": "v1/annotationsets/{annotationSetId}",
- "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.",
- "request": {
- "$ref": "AnnotationSet"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "annotationSetId"
- ],
- "response": {
- "$ref": "AnnotationSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
- "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.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "annotationSetId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the annotation set to be updated."
- }
- }
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnnotationSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/annotationsets",
- "id": "genomics.annotationsets.create",
- "path": "v1/annotationsets",
- "description": "Creates a new annotation set. Caller must have WRITE permission for the\nassociated dataset.\n\nThe following fields are required:\n\n * datasetId\n * referenceSetId\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field).",
- "request": {
- "$ref": "AnnotationSet"
- }
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "annotationSetId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "annotationSetId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the annotation set to be deleted."
- }
- },
- "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",
- "description": "Deletes an annotation set. Caller must have WRITE permission\nfor the associated annotation set."
+ "flatPath": "v1/variants",
+ "path": "v1/variants",
+ "id": "genomics.variants.create"
}
}
},
"references": {
- "resources": {
- "bases": {
- "methods": {
- "list": {
- "flatPath": "v1/references/{referenceId}/bases",
- "id": "genomics.references.bases.list",
- "path": "v1/references/{referenceId}/bases",
- "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).",
- "httpMethod": "GET",
- "parameterOrder": [
- "referenceId"
- ],
- "response": {
- "$ref": "ListBasesResponse"
- },
- "parameters": {
- "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": {
- "description": "The ID of the reference.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "end": {
- "description": "The end position (0-based, exclusive) of this query. Defaults to the length\nof this reference.",
- "format": "int64",
- "type": "string",
- "location": "query"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ]
- }
- }
- }
- },
"methods": {
- "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",
- "parameterOrder": [
- "referenceId"
- ],
- "response": {
- "$ref": "Reference"
- },
- "parameters": {
- "referenceId": {
- "description": "The ID of the reference.",
- "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/references/{referenceId}",
- "id": "genomics.references.get",
- "path": "v1/references/{referenceId}"
- },
"search": {
"httpMethod": "POST",
"parameterOrder": [],
@@ -408,252 +352,122 @@
"$ref": "SearchReferencesRequest"
},
"description": "Searches for references which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146)."
+ },
+ "get": {
+ "flatPath": "v1/references/{referenceId}",
+ "path": "v1/references/{referenceId}",
+ "id": "genomics.references.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",
+ "parameters": {
+ "referenceId": {
+ "location": "path",
+ "description": "The ID of the reference.",
+ "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"
+ ]
+ }
+ },
+ "resources": {
+ "bases": {
+ "methods": {
+ "list": {
+ "description": "Lists the bases in a reference, optionally restricted to a range.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).",
+ "response": {
+ "$ref": "ListBasesResponse"
+ },
+ "parameterOrder": [
+ "referenceId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of bases to return in a single page. If unspecified,\ndefaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base\npairs).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "start": {
+ "location": "query",
+ "description": "The start position (0-based) of this query. Defaults to 0.",
+ "format": "int64",
+ "type": "string"
+ },
+ "referenceId": {
+ "description": "The ID of the reference.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "end": {
+ "location": "query",
+ "description": "The end position (0-based, exclusive) of this query. Defaults to the length\nof this reference.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/references/{referenceId}/bases",
+ "path": "v1/references/{referenceId}/bases",
+ "id": "genomics.references.bases.list"
+ }
+ }
}
}
},
"datasets": {
"methods": {
- "list": {
- "response": {
- "$ref": "ListDatasetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024.",
- "format": "int32"
- },
- "projectId": {
- "type": "string",
- "location": "query",
- "description": "Required. The Google Cloud project ID to list datasets for."
- }
- },
- "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)"
- },
- "setIamPolicy": {
- "flatPath": "v1/datasets/{datasetsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "genomics.datasets.setIamPolicy",
- "description": "Sets the access control policy on the specified dataset. Replaces any\nexisting policy.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nSee \u003ca href=\"/iam/docs/managing-policies#setting_a_policy\"\u003eSetting a\nPolicy\u003c/a\u003e for more information.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "pattern": "^datasets/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`."
- }
- }
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Dataset"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets",
- "id": "genomics.datasets.create",
- "path": "v1/datasets",
- "request": {
- "$ref": "Dataset"
- },
- "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)"
- },
- "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)",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "pattern": "^datasets/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetsId}:getIamPolicy",
- "id": "genomics.datasets.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
- },
- "patch": {
- "request": {
- "$ref": "Dataset"
- },
- "description": "Updates a dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "datasetId"
- ],
- "response": {
- "$ref": "Dataset"
- },
- "parameters": {
- "datasetId": {
- "description": "The ID of the dataset to be updated.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "type": "string",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetId}",
- "id": "genomics.datasets.patch",
- "path": "v1/datasets/{datasetId}"
- },
- "get": {
- "description": "Gets a dataset by ID.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "Dataset"
- },
- "parameterOrder": [
- "datasetId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "datasetId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the dataset."
- }
- },
- "flatPath": "v1/datasets/{datasetId}",
- "path": "v1/datasets/{datasetId}",
- "id": "genomics.datasets.get"
- },
- "undelete": {
- "response": {
- "$ref": "Dataset"
- },
- "parameterOrder": [
- "datasetId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "datasetId": {
- "description": "The ID of the dataset to be undeleted.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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": {
"flatPath": "v1/datasets/{datasetsId}:testIamPermissions",
- "id": "genomics.datasets.testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
+ "id": "genomics.datasets.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nSee \u003ca href=\"/iam/docs/managing-policies#testing_permissions\"\u003eTesting\nPermissions\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"request": {
"$ref": "TestIamPermissionsRequest"
},
- "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": {
- "location": "path",
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^datasets/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
- },
- "delete": {
- "parameters": {
- "datasetId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the dataset to be deleted."
- }
- },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^datasets/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "delete": {
"flatPath": "v1/datasets/{datasetId}",
"path": "v1/datasets/{datasetId}",
"id": "genomics.datasets.delete",
@@ -664,143 +478,153 @@
"parameterOrder": [
"datasetId"
],
- "httpMethod": "DELETE"
- }
- }
- },
- "annotations": {
- "methods": {
- "delete": {
- "description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set.",
"httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "annotationId"
- ],
"parameters": {
- "annotationId": {
- "description": "The ID of the annotation to be deleted.",
+ "datasetId": {
+ "location": "path",
+ "description": "The ID of the dataset to be deleted.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.delete",
- "path": "v1/annotations/{annotationId}"
- },
- "create": {
- "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"
- },
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {}
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "BatchCreateAnnotationsResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotations:batchCreate",
- "id": "genomics.annotations.batchCreate",
- "path": "v1/annotations:batchCreate"
- },
- "search": {
- "id": "genomics.annotations.search",
- "path": "v1/annotations/search",
- "request": {
- "$ref": "SearchAnnotationsRequest"
- },
- "description": "Searches for annotations that match the given criteria. Results are\nordered by genomic coordinate (by reference sequence, then position).\nAnnotations with equivalent genomic coordinates are returned in an\nunspecified order. This order is consistent, such that two queries for the\nsame content (regardless of page size) yield annotations in the same order\nacross their respective streams of paginated responses. Caller must have\nREAD permission for the queried annotation sets.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchAnnotationsResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/annotations/search"
- },
- "get": {
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "annotationId"
- ],
- "response": {
- "$ref": "Annotation"
- },
- "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"
]
},
- "update": {
- "request": {
- "$ref": "Annotation"
- },
- "description": "Updates an annotation. Caller must have\nWRITE permission for the associated dataset.",
+ "list": {
+ "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": "Annotation"
+ "$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": {
+ "location": "query",
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 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"
+ }
+ }
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
},
"parameterOrder": [
- "annotationId"
+ "resource"
],
- "httpMethod": "PUT",
+ "httpMethod": "POST",
+ "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.",
+ "resource": {
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^datasets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetsId}: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"
+ }
+ },
+ "create": {
+ "description": "Creates a new dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "request": {
+ "$ref": "Dataset"
+ },
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/datasets",
+ "path": "v1/datasets",
+ "id": "genomics.datasets.create"
+ },
+ "getIamPolicy": {
+ "flatPath": "v1/datasets/{datasetsId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "genomics.datasets.getIamPolicy",
+ "description": "Gets the access control policy for the dataset. This is empty if the\npolicy or resource does not exist.\n\nSee \u003ca href=\"/iam/docs/managing-policies#getting_a_policy\"\u003eGetting a\nPolicy\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^datasets/[^/]+$"
+ }
+ }
+ },
+ "patch": {
+ "request": {
+ "$ref": "Dataset"
+ },
+ "description": "Updates a dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "datasetId": {
+ "description": "The ID of the dataset to be updated.",
"required": true,
"type": "string",
"location": "path"
},
"updateMask": {
"location": "query",
- "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nvariant,\ntranscript, and\ninfo. If unspecified, all mutable\nfields will be updated.",
+ "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"
}
@@ -809,26 +633,81 @@
"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"
+ "flatPath": "v1/datasets/{datasetId}",
+ "path": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.patch"
+ },
+ "get": {
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "The ID of the dataset.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetId}",
+ "path": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.get",
+ "description": "Gets a dataset by ID.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ },
+ "undelete": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameters": {
+ "datasetId": {
+ "description": "The ID of the dataset to be undeleted.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets/{datasetId}:undelete",
+ "id": "genomics.datasets.undelete",
+ "path": "v1/datasets/{datasetId}:undelete",
+ "request": {
+ "$ref": "UndeleteDatasetRequest"
+ },
+ "description": "Undeletes a dataset by restoring a dataset which was deleted via this API.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis operation is only possible for a week after the deletion occurred."
}
}
},
"variantsets": {
"methods": {
"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)",
- "httpMethod": "POST",
- "parameterOrder": [
- "variantSetId"
- ],
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
"parameters": {
"variantSetId": {
"location": "path",
@@ -837,34 +716,59 @@
"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",
- "path": "v1/variantsets/{variantSetId}:export"
+ "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)",
+ "request": {
+ "$ref": "ExportVariantSetRequest"
+ }
},
"search": {
"flatPath": "v1/variantsets/search",
"path": "v1/variantsets/search",
"id": "genomics.variantsets.search",
+ "description": "Returns a list of all variant sets matching search criteria.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).",
"request": {
"$ref": "SearchVariantSetsRequest"
},
- "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).",
"response": {
"$ref": "SearchVariantSetsResponse"
},
"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": {}
+ },
+ "get": {
+ "description": "Gets a variant set by ID.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "VariantSet"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "variantSetId": {
+ "description": "Required. The ID of the variant set.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/variantsets/{variantSetId}",
+ "path": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.get"
},
"patch": {
"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)",
@@ -890,66 +794,40 @@
"location": "query"
},
"variantSetId": {
+ "location": "path",
"description": "The ID of the variant to be updated (must already exist).",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"flatPath": "v1/variantsets/{variantSetId}",
"path": "v1/variantsets/{variantSetId}",
"id": "genomics.variantsets.patch"
},
- "get": {
- "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)",
- "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"
- }
- }
- },
"delete": {
+ "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": [
"variantSetId"
],
- "httpMethod": "DELETE",
"parameters": {
"variantSetId": {
- "location": "path",
"description": "The ID of the variant set to be deleted.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"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.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)"
+ ]
},
"create": {
"response": {
@@ -972,37 +850,155 @@
}
}
},
- "operations": {
+ "annotations": {
"methods": {
- "cancel": {
- "flatPath": "v1/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "genomics.operations.cancel",
+ "search": {
"request": {
- "$ref": "CancelOperationRequest"
+ "$ref": "SearchAnnotationsRequest"
},
- "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.",
+ "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": "Empty"
+ "$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",
+ "path": "v1/annotations/search",
+ "id": "genomics.annotations.search"
+ },
+ "get": {
+ "description": "Gets an annotation. Caller must have READ permission\nfor the associated annotation set.",
+ "response": {
+ "$ref": "Annotation"
},
"parameterOrder": [
- "name"
+ "annotationId"
],
- "httpMethod": "POST",
+ "httpMethod": "GET",
"parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
+ "annotationId": {
+ "location": "path",
+ "description": "The ID of the annotation to be retrieved.",
"required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/annotations/{annotationId}",
+ "path": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.get"
+ },
+ "update": {
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "updateMask": {
+ "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nvariant,\ntranscript, and\ninfo. If unspecified, all mutable\nfields will be updated.",
+ "format": "google-fieldmask",
"type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
+ "location": "query"
+ },
+ "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."
},
+ "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": {
+ "response": {
+ "$ref": "BatchCreateAnnotationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/annotations:batchCreate",
+ "path": "v1/annotations:batchCreate",
+ "id": "genomics.annotations.batchCreate",
+ "description": "Creates one or more new annotations atomically. All annotations must\nbelong to the same annotation set. Caller must have WRITE\npermission for this annotation set. For optimal performance, batch\npositionally adjacent annotations together.\n\nIf the request has a systemic issue, such as an attempt to write to\nan inaccessible annotation set, the entire RPC will fail accordingly. For\nlesser data issues, when possible an error will be isolated to the\ncorresponding batch entry in the response; the remaining well formed\nannotations will be created normally.\n\nFor details on the requirements for each individual annotation resource,\nsee\nCreateAnnotation.",
+ "request": {
+ "$ref": "BatchCreateAnnotationsRequest"
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
"list": {
"description": "Lists operations that match the specified filter in the request.",
"response": {
@@ -1012,75 +1008,104 @@
"name"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
"parameters": {
- "name": {
- "pattern": "^operations$",
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
"pageSize": {
- "type": "integer",
- "location": "query",
"description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
},
"filter": {
"location": "query",
"description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
"type": "string"
+ },
+ "name": {
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations$"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
"flatPath": "v1/operations",
"path": "v1/{+name}",
"id": "genomics.operations.list"
},
"get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "genomics.operations.get",
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET"
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$"
+ }
+ },
+ "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}"
+ },
+ "cancel": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "genomics.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ }
}
}
},
"referencesets": {
"methods": {
"search": {
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "SearchReferenceSetsResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -1088,17 +1113,14 @@
"https://www.googleapis.com/auth/genomics.readonly"
],
"flatPath": "v1/referencesets/search",
- "id": "genomics.referencesets.search",
"path": "v1/referencesets/search",
+ "id": "genomics.referencesets.search",
"request": {
"$ref": "SearchReferenceSetsRequest"
},
"description": "Searches for reference sets which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)"
},
"get": {
- "flatPath": "v1/referencesets/{referenceSetId}",
- "path": "v1/referencesets/{referenceSetId}",
- "id": "genomics.referencesets.get",
"description": "Gets a reference set.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).",
"response": {
"$ref": "ReferenceSet"
@@ -1119,274 +1141,37 @@
"required": true,
"type": "string"
}
- }
- }
- }
- },
- "callsets": {
- "methods": {
- "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": {
- "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",
- "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"
- },
- "patch": {
- "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",
- "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"
- }
- },
- "get": {
- "flatPath": "v1/callsets/{callSetId}",
- "path": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.get",
- "description": "Gets a call set by ID.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "CallSet"
- },
- "parameterOrder": [
- "callSetId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "callSetId": {
- "description": "The ID of the call set.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "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",
- "path": "v1/callsets",
- "id": "genomics.callsets.create"
- }
- }
- },
- "reads": {
- "methods": {
- "search": {
- "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).",
- "request": {
- "$ref": "SearchReadsRequest"
- },
- "response": {
- "$ref": "SearchReadsResponse"
- },
- "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/reads/search",
- "path": "v1/reads/search",
- "id": "genomics.reads.search"
+ "flatPath": "v1/referencesets/{referenceSetId}",
+ "path": "v1/referencesets/{referenceSetId}",
+ "id": "genomics.referencesets.get"
}
}
},
"readgroupsets": {
"methods": {
- "export": {
+ "import": {
"response": {
"$ref": "Operation"
},
- "parameterOrder": [
- "readGroupSetId"
- ],
+ "parameterOrder": [],
"httpMethod": "POST",
- "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",
- "path": "v1/readgroupsets/{readGroupSetId}:export",
- "id": "genomics.readgroupsets.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."
- },
- "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).",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchReadGroupSetsResponse"
- },
"parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/readgroupsets/search",
- "id": "genomics.readgroupsets.search",
- "path": "v1/readgroupsets/search"
- },
- "get": {
- "parameters": {
- "readGroupSetId": {
- "location": "path",
- "description": "The ID of the read group 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/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)",
- "httpMethod": "GET",
- "response": {
- "$ref": "ReadGroupSet"
- },
- "parameterOrder": [
- "readGroupSetId"
- ]
- },
- "patch": {
- "flatPath": "v1/readgroupsets/{readGroupSetId}",
- "path": "v1/readgroupsets/{readGroupSetId}",
- "id": "genomics.readgroupsets.patch",
+ "flatPath": "v1/readgroupsets:import",
+ "path": "v1/readgroupsets:import",
+ "id": "genomics.readgroupsets.import",
+ "description": "Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)",
"request": {
- "$ref": "ReadGroupSet"
- },
- "description": "Updates a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
- "response": {
- "$ref": "ReadGroupSet"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "readGroupSetId": {
- "description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "description": "An optional mask specifying which fields to update. Supported fields:\n\n* name.\n* referenceSetId.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
+ "$ref": "ImportReadGroupSetsRequest"
+ }
},
"delete": {
+ "flatPath": "v1/readgroupsets/{readGroupSetId}",
"id": "genomics.readgroupsets.delete",
"path": "v1/readgroupsets/{readGroupSetId}",
"description": "Deletes a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
@@ -1408,34 +1193,123 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/readgroupsets/{readGroupSetId}"
+ ]
},
- "import": {
+ "export": {
+ "flatPath": "v1/readgroupsets/{readGroupSetId}:export",
+ "path": "v1/readgroupsets/{readGroupSetId}:export",
+ "id": "genomics.readgroupsets.export",
+ "description": "Exports a read group set to a BAM file in Google Cloud Storage.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nNote that currently there may be some differences between exported BAM\nfiles and the original BAM file at the time of import. See\nImportReadGroupSets\nfor caveats.",
+ "request": {
+ "$ref": "ExportReadGroupSetRequest"
+ },
"response": {
"$ref": "Operation"
},
- "parameterOrder": [],
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
"httpMethod": "POST",
"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",
- "path": "v1/readgroupsets:import",
- "id": "genomics.readgroupsets.import",
- "description": "Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)",
- "request": {
- "$ref": "ImportReadGroupSetsRequest"
+ "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"
+ }
}
+ },
+ "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).",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchReadGroupSetsResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/readgroupsets/search",
+ "id": "genomics.readgroupsets.search",
+ "path": "v1/readgroupsets/search"
+ },
+ "patch": {
+ "response": {
+ "$ref": "ReadGroupSet"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "readGroupSetId": {
+ "description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "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"
+ }
+ },
+ "flatPath": "v1/readgroupsets/{readGroupSetId}",
+ "path": "v1/readgroupsets/{readGroupSetId}",
+ "id": "genomics.readgroupsets.patch",
+ "description": "Updates a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
+ "request": {
+ "$ref": "ReadGroupSet"
+ }
+ },
+ "get": {
+ "description": "Gets a read group set by ID.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "ReadGroupSet"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "readGroupSetId": {
+ "description": "The ID of the read group set.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/readgroupsets/{readGroupSetId}",
+ "path": "v1/readgroupsets/{readGroupSetId}",
+ "id": "genomics.readgroupsets.get"
}
},
"resources": {
"coveragebuckets": {
"methods": {
"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"
},
@@ -1443,12 +1317,28 @@
"readGroupSetId"
],
"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.",
+ "referenceName": {
+ "description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
"type": "string",
"location": "query"
},
+ "end": {
+ "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified. If unset or 0, defaults\nto the length of the reference.",
+ "format": "int64",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
"pageSize": {
"location": "query",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 2048.",
@@ -1472,39 +1362,184 @@
"required": true,
"type": "string",
"location": "path"
- },
- "referenceName": {
- "description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
- "type": "string",
- "location": "query"
- },
- "end": {
- "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified. If unset or 0, defaults\nto the length of the reference.",
- "format": "int64",
- "type": "string",
- "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
"flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
"path": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
- "id": "genomics.readgroupsets.coveragebuckets.list",
- "description": "Lists fixed width coverage buckets for a read group set, each of which\ncorrespond to a range of a reference sequence. Each bucket summarizes\ncoverage information across its corresponding genomic range.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nCoverage is defined as the number of reads which are aligned to a given\nbase in the reference sequence. Coverage buckets are available at several\nprecomputed bucket widths, enabling retrieval of various coverage 'zoom\nlevels'. The caller must have READ permissions for the target read group\nset."
+ "id": "genomics.readgroupsets.coveragebuckets.list"
}
}
}
}
+ },
+ "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).",
+ "response": {
+ "$ref": "SearchReadsResponse"
+ },
+ "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/reads/search",
+ "path": "v1/reads/search",
+ "id": "genomics.reads.search"
+ }
+ }
+ },
+ "callsets": {
+ "methods": {
+ "search": {
+ "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",
+ "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"
+ }
+ },
+ "patch": {
+ "request": {
+ "$ref": "CallSet"
+ },
+ "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.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "callSetId": {
+ "location": "path",
+ "description": "The ID of the call set to be updated.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.patch",
+ "path": "v1/callsets/{callSetId}"
+ },
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "callSetId": {
+ "location": "path",
+ "description": "The ID of the call set.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/callsets/{callSetId}",
+ "path": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.get"
+ },
+ "create": {
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/callsets",
+ "path": "v1/callsets",
+ "id": "genomics.callsets.create",
+ "description": "Creates a new call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "request": {
+ "$ref": "CallSet"
+ }
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "parameters": {
+ "callSetId": {
+ "location": "path",
+ "description": "The ID of the call set to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.delete",
+ "path": "v1/callsets/{callSetId}",
+ "description": "Deletes a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ }
+ }
}
},
"parameters": {
- "upload_protocol": {
- "type": "string",
+ "oauth_token": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ "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.",
@@ -1518,16 +1553,13 @@
"type": "string"
},
"fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
"location": "query",
- "description": "JSONP",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1536,9 +1568,12 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"alt": {
"enum": [
@@ -1556,57 +1591,1290 @@
"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": {
"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"
+ "type": "string",
+ "location": "query"
},
"pp": {
"location": "query",
"description": "Pretty-print response.",
"type": "boolean",
"default": "true"
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
}
},
"schemas": {
+ "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.",
+ "type": "string"
+ },
+ "referenceNames": {
+ "description": "The reference names to export. If this is not specified, all reference\nsequences, including unmapped reads, are exported.\nUse `*` to export only unmapped reads.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "projectId": {
+ "description": "Required. The Google Cloud project ID that owns this\nexport. The caller must have WRITE access to this project.",
+ "type": "string"
+ }
+ },
+ "id": "ExportReadGroupSetRequest"
+ },
+ "Exon": {
+ "type": "object",
+ "properties": {
+ "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",
+ "type": "string"
+ },
+ "frame": {
+ "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": {
+ "info": {
+ "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).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "id": {
+ "description": "The server-generated call set ID, unique across all call sets.",
+ "type": "string"
+ },
+ "created": {
+ "description": "The date this call set was created in milliseconds from the epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "sampleId": {
+ "description": "The sample ID this call set corresponds to.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The call set name.",
+ "type": "string"
+ }
+ },
+ "id": "CallSet"
+ },
+ "SearchAnnotationSetsResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ },
+ "annotationSets": {
+ "description": "The matching annotation sets.",
+ "type": "array",
+ "items": {
+ "$ref": "AnnotationSet"
+ }
+ }
+ },
+ "id": "SearchAnnotationSetsResponse"
+ },
+ "ImportVariantsRequest": {
+ "description": "The variant data import request.",
+ "type": "object",
+ "properties": {
+ "infoMergeConfig": {
+ "additionalProperties": {
+ "enum": [
+ "INFO_MERGE_OPERATION_UNSPECIFIED",
+ "IGNORE_NEW",
+ "MOVE_TO_CALLS"
+ ],
+ "type": "string"
+ },
+ "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them. This is plumbed down to the MergeVariantRequests\ngenerated by the resulting import job.",
+ "type": "object"
+ },
+ "variantSetId": {
+ "description": "Required. The variant set to which variant data should be imported.",
+ "type": "string"
+ },
+ "sourceUris": {
+ "description": "A list of URIs referencing variant files in Google Cloud Storage. URIs can\ninclude wildcards [as described\nhere](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).\nNote that recursive wildcards ('**') are not supported.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "id": "ImportVariantsRequest"
+ },
+ "VariantAnnotation": {
+ "type": "object",
+ "properties": {
+ "conditions": {
+ "description": "The set of conditions associated with this variant.\nA condition describes the way a variant influences human health.",
+ "type": "array",
+ "items": {
+ "$ref": "ClinicalCondition"
+ }
+ },
+ "effect": {
+ "enumDescriptions": [
+ "",
+ "`EFFECT_OTHER` should be used when no other Effect\nwill suffice.",
+ "`FRAMESHIFT` indicates a mutation in which the insertion or\ndeletion of nucleotides resulted in a frameshift change.",
+ "`FRAME_PRESERVING_INDEL` indicates a mutation in which a\nmultiple of three nucleotides has been inserted or deleted, resulting\nin no change to the reading frame of the coding sequence.",
+ "`SYNONYMOUS_SNP` indicates a single nucleotide polymorphism\nmutation that results in no amino acid change.",
+ "`NONSYNONYMOUS_SNP` indicates a single nucleotide\npolymorphism mutation that results in an amino acid change.",
+ "`STOP_GAIN` indicates a mutation that leads to the creation\nof a stop codon at the variant site. Frameshift mutations creating\ndownstream stop codons do not count as `STOP_GAIN`.",
+ "`STOP_LOSS` indicates a mutation that eliminates a\nstop codon at the variant site.",
+ "`SPLICE_SITE_DISRUPTION` indicates that this variant is\nfound in a splice site for the associated transcript, and alters the\nnormal splicing pattern."
+ ],
+ "enum": [
+ "EFFECT_UNSPECIFIED",
+ "EFFECT_OTHER",
+ "FRAMESHIFT",
+ "FRAME_PRESERVING_INDEL",
+ "SYNONYMOUS_SNP",
+ "NONSYNONYMOUS_SNP",
+ "STOP_GAIN",
+ "STOP_LOSS",
+ "SPLICE_SITE_DISRUPTION"
+ ],
+ "description": "Effect of the variant on the coding sequence.",
+ "type": "string"
+ },
+ "transcriptIds": {
+ "description": "Google annotation IDs of the transcripts affected by this variant. These\nshould be provided when the variant is created.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "type": {
+ "description": "Type has been adapted from ClinVar's list of variant types.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "`TYPE_OTHER` should be used when no other Type will suffice.\nFurther explanation of the variant type may be included in the\ninfo field.",
+ "`INSERTION` indicates an insertion.",
+ "`DELETION` indicates a deletion.",
+ "`SUBSTITUTION` indicates a block substitution of\ntwo or more nucleotides.",
+ "`SNP` indicates a single nucleotide polymorphism.",
+ "`STRUCTURAL` indicates a large structural variant,\nincluding chromosomal fusions, inversions, etc.",
+ "`CNV` indicates a variation in copy number."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TYPE_OTHER",
+ "INSERTION",
+ "DELETION",
+ "SUBSTITUTION",
+ "SNP",
+ "STRUCTURAL",
+ "CNV"
+ ]
+ },
+ "alternateBases": {
+ "description": "The alternate allele for this variant. If multiple alternate alleles\nexist at this location, create a separate variant for each one, as they\nmay represent distinct conditions.",
+ "type": "string"
+ },
+ "geneId": {
+ "description": "Google annotation ID of the gene affected by this variant. This should\nbe provided when the variant is created.",
+ "type": "string"
+ },
+ "clinicalSignificance": {
+ "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"
+ },
+ "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",
+ "type": "string"
+ },
+ "coverageBuckets": {
+ "description": "The coverage buckets. The list of buckets is sparse; a bucket with 0\noverlapping reads is not returned. A bucket never crosses more than one\nreference sequence. Each bucket has width `bucketWidth`, unless\nits end is the end of the reference sequence.",
+ "type": "array",
+ "items": {
+ "$ref": "CoverageBucket"
+ }
+ }
+ },
+ "id": "ListCoverageBucketsResponse"
+ },
+ "ExportVariantSetRequest": {
+ "description": "The variant data export request.",
+ "type": "object",
+ "properties": {
+ "format": {
+ "enumDescriptions": [
+ "",
+ "Export the data to Google BigQuery."
+ ],
+ "enum": [
+ "FORMAT_UNSPECIFIED",
+ "FORMAT_BIGQUERY"
+ ],
+ "description": "The format for the exported data.",
+ "type": "string"
+ },
+ "bigqueryDataset": {
+ "description": "Required. The BigQuery dataset to export data to. This dataset must already\nexist. Note that this is distinct from the Genomics concept of \"dataset\".",
+ "type": "string"
+ },
+ "bigqueryTable": {
+ "description": "Required. The BigQuery table to export data to.\nIf the table doesn't exist, it will be created. If it already exists, it\nwill be overwritten.",
+ "type": "string"
+ },
+ "callSetIds": {
+ "description": "If provided, only variant call information from the specified call sets\nwill be exported. By default all variant calls are exported.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "projectId": {
+ "description": "Required. The Google Cloud project ID that owns the destination\nBigQuery dataset. The caller must have WRITE access to this project. This\nproject will also own the resulting export job.",
+ "type": "string"
+ }
+ },
+ "id": "ExportVariantSetRequest"
+ },
+ "SearchAnnotationsRequest": {
+ "type": "object",
+ "properties": {
+ "referenceId": {
+ "description": "The ID of the reference to query.",
+ "type": "string"
+ },
+ "end": {
+ "description": "The end position of the range on the reference, 0-based exclusive. If\nreferenceId or\nreferenceName\nmust be specified, Defaults to the length of the reference.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "start": {
+ "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified,\nreferenceId or\nreferenceName\nmust be specified. Defaults to 0.",
+ "format": "int64",
+ "type": "string"
+ },
+ "annotationSetIds": {
+ "description": "Required. The annotation sets to search within. The caller must have\n`READ` access to these annotation sets.\nAll queried annotation sets must have the same type.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "referenceName": {
+ "description": "The name of the reference to query, within the reference set associated\nwith this query.",
+ "type": "string"
+ }
+ },
+ "id": "SearchAnnotationsRequest"
+ },
+ "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"
+ },
+ "CodingSequence": {
+ "type": "object",
+ "properties": {
+ "start": {
+ "description": "The start of the coding sequence on this annotation's reference sequence,\n0-based inclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.",
+ "format": "int64",
+ "type": "string"
+ },
+ "end": {
+ "description": "The end of the coding sequence on this annotation's reference sequence,\n0-based exclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "CodingSequence"
+ },
+ "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"
+ },
+ "SearchReferencesResponse": {
+ "type": "object",
+ "properties": {
+ "references": {
+ "description": "The matching references.",
+ "type": "array",
+ "items": {
+ "$ref": "Reference"
+ }
+ },
+ "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": "SearchReferencesResponse"
+ },
+ "SearchAnnotationSetsRequest": {
+ "type": "object",
+ "properties": {
+ "types": {
+ "enumDescriptions": [
+ "",
+ "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
+ "A `VARIANT` annotation type.",
+ "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
+ "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
+ ],
+ "description": "If specified, only annotation sets that have any of these types are\nreturned.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "ANNOTATION_TYPE_UNSPECIFIED",
+ "GENERIC",
+ "VARIANT",
+ "GENE",
+ "TRANSCRIPT"
+ ]
+ }
+ },
+ "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"
+ },
+ "pageSize": {
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 128. The maximum value is 1024.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "datasetIds": {
+ "description": "Required. The dataset IDs to search within. Caller must have `READ` access\nto these datasets.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "SearchAnnotationSetsRequest"
+ },
+ "SearchReadGroupSetsResponse": {
+ "description": "The read group set search response.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "A linear alignment can be represented by one CIGAR string. Describes the\nmapped position and local alignment of the read to the reference.",
+ "type": "object",
+ "properties": {
+ "mappingQuality": {
+ "description": "The mapping quality of this alignment. Represents how likely\nthe read maps to this position as opposed to other locations.\n\nSpecifically, this is -10 log10 Pr(mapping position is wrong), rounded to\nthe nearest integer.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "position": {
+ "description": "The position of this alignment.",
+ "$ref": "Position"
+ },
+ "cigar": {
+ "description": "Represents the local alignment of this sequence (alignment matches, indels,\netc) against the reference.",
+ "type": "array",
+ "items": {
+ "$ref": "CigarUnit"
+ }
+ }
+ },
+ "id": "LinearAlignment"
+ },
+ "SearchReferencesRequest": {
+ "type": "object",
+ "properties": {
+ "referenceSetId": {
+ "description": "If present, return only references which belong to this reference set.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "md5checksums": {
+ "description": "If present, return references for which the\nmd5checksum matches exactly.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "accessions": {
+ "description": "If present, return references for which a prefix of any of\nsourceAccessions match\nany of these strings. Accession numbers typically have a main number and a\nversion, for example `GCF_000001405.26`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ }
+ },
+ "id": "SearchReferencesRequest"
+ },
+ "Dataset": {
+ "description": "A Dataset is a collection of genomic data.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "The server-generated dataset ID, unique across all datasets.",
+ "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": {
+ "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"
+ }
+ },
+ "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"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "id": "ReadGroup"
+ },
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "id": "ReadGroupSet"
+ },
+ "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"
+ }
+ },
+ "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"
+ },
+ "Entry": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The creation status.",
+ "$ref": "Status"
+ },
+ "annotation": {
+ "$ref": "Annotation",
+ "description": "The created annotation, if creation was successful."
+ }
+ },
+ "id": "Entry"
+ },
+ "Position": {
+ "description": "An abstraction for referring to a genomic position, in relation to some\nalready known reference. For now, represents a genomic position as a\nreference name, a base number on that reference (0-based), and a\ndetermination of forward or reverse strand.",
+ "type": "object",
+ "properties": {
+ "position": {
+ "description": "The 0-based offset from the start of the forward strand for that reference.",
+ "format": "int64",
+ "type": "string"
+ },
+ "referenceName": {
+ "description": "The name of the reference in whatever reference set is being used.",
+ "type": "string"
+ },
+ "reverseStrand": {
+ "description": "Whether this position is on the reverse strand, as opposed to the forward\nstrand.",
+ "type": "boolean"
+ }
+ },
+ "id": "Position"
+ },
+ "SearchReferenceSetsResponse": {
+ "type": "object",
+ "properties": {
+ "referenceSets": {
+ "description": "The matching references sets.",
+ "type": "array",
+ "items": {
+ "$ref": "ReferenceSet"
+ }
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ }
+ },
+ "id": "SearchReferenceSetsResponse"
+ },
+ "SearchCallSetsRequest": {
+ "description": "The call set search request.",
+ "type": "object",
+ "properties": {
+ "pageSize": {
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "variantSetIds": {
+ "description": "Restrict the query to call sets within the given variant sets. At least one\nID must be provided.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "description": "Only return call sets for which a substring of the name matches this\nstring.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ }
+ },
+ "id": "SearchCallSetsRequest"
+ },
+ "ImportReadGroupSetsRequest": {
+ "description": "The read group set import request.",
+ "type": "object",
+ "properties": {
+ "sourceUris": {
+ "description": "A list of URIs pointing at [BAM\nfiles](https://samtools.github.io/hts-specs/SAMv1.pdf)\nin Google Cloud Storage.\nThose URIs can include wildcards (*), but do not add or remove\nmatching files before import has completed.\n\nNote that Google Cloud Storage object listing is only eventually\nconsistent: files added may be not be immediately visible to\neveryone. Thus, if using a wildcard it is preferable not to start\nthe import immediately after the files are created.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "referenceSetId": {
+ "description": "The reference set to which the imported read group sets are aligned to, if\nany. The reference names of this reference set must be a superset of those\nfound in the imported file headers. If no reference set id is provided, a\nbest effort is made to associate with a matching reference set.",
+ "type": "string"
+ },
+ "partitionStrategy": {
+ "description": "The partition strategy describes how read groups are partitioned into read\ngroup sets.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "In most cases, this strategy yields one read group set per file. This is\nthe default behavior.\n\nAllocate one read group set per file per sample. For BAM files, read\ngroups are considered to share a sample if they have identical sample\nnames. Furthermore, all reads for each file which do not belong to a read\ngroup, if any, will be grouped into a single read group set per-file.",
+ "Includes all read groups in all imported files into a single read group\nset. Requires that the headers for all imported files are equivalent. All\nreads which do not belong to a read group, if any, will be grouped into a\nseparate read group set."
+ ],
+ "enum": [
+ "PARTITION_STRATEGY_UNSPECIFIED",
+ "PER_FILE_PER_SAMPLE",
+ "MERGE_ALL"
+ ]
+ },
+ "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"
+ }
+ },
+ "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/docs).",
+ "type": "object",
+ "properties": {
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
+ }
+ },
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "Deprecated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Policy"
+ },
+ "Annotation": {
+ "description": "An annotation describes a region of reference genome. The value of an\nannotation may be one of several canonical types, supplemented by arbitrary\ninfo tags. An annotation is not inherently associated with a specific\nsample or individual (though a client could choose to use annotations in\nthis way). Example canonical annotation types are `GENE` and\n`VARIANT`.",
+ "type": "object",
+ "properties": {
+ "referenceName": {
+ "description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.",
+ "type": "string"
+ },
+ "info": {
+ "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ },
+ "type": {
+ "description": "The data type for this annotation. Must match the containing annotation\nset's type.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
+ "A `VARIANT` annotation type.",
+ "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
+ "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
+ ],
+ "enum": [
+ "ANNOTATION_TYPE_UNSPECIFIED",
+ "GENERIC",
+ "VARIANT",
+ "GENE",
+ "TRANSCRIPT"
+ ]
+ },
+ "end": {
+ "description": "The end position of the range on the reference, 0-based exclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "transcript": {
+ "description": "A transcript value represents the assertion that a particular region of\nthe reference genome may be transcribed as RNA. An alternative splicing\npattern would be represented as a separate transcript object. This field\nis only set for annotations of type `TRANSCRIPT`.",
+ "$ref": "Transcript"
+ },
+ "start": {
+ "description": "The start position of the range on the reference, 0-based inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "annotationSetId": {
+ "description": "The annotation set to which this annotation belongs.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The display name of this annotation.",
+ "type": "string"
+ },
+ "variant": {
+ "description": "A variant annotation, which describes the effect of a variant on the\ngenome, the coding sequence, and/or higher level consequences at the\norganism level e.g. pathogenicity. This field is only set for annotations\nof type `VARIANT`.",
+ "$ref": "VariantAnnotation"
+ },
+ "id": {
+ "description": "The server-generated annotation ID, unique across all annotations.",
+ "type": "string"
+ },
+ "referenceId": {
+ "description": "The ID of the Google Genomics reference associated with this range.",
+ "type": "string"
+ },
+ "reverseStrand": {
+ "description": "Whether this range refers to the reverse strand, as opposed to the forward\nstrand. Note that regardless of this field, the start/end position of the\nrange always refer to the forward strand.",
+ "type": "boolean"
+ }
+ },
+ "id": "Annotation"
+ },
+ "CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
+ },
+ "SearchReadsRequest": {
+ "description": "The read search request.",
+ "type": "object",
+ "properties": {
+ "readGroupIds": {
+ "description": "The IDs of the read groups within which to search for reads. All specified\nread groups must belong to the same read group sets. Must specify one of\n`readGroupSetIds` or `readGroupIds`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "end": {
+ "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "start": {
+ "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified.",
+ "format": "int64",
+ "type": "string"
+ },
+ "referenceName": {
+ "description": "The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to\n`*`, only unmapped reads are returned. If unspecified, all reads (mapped\nand unmapped) are returned.",
+ "type": "string"
+ },
+ "readGroupSetIds": {
+ "description": "The IDs of the read groups sets within which to search for reads. All\nspecified read group sets must be aligned against a common set of reference\nsequences; this defines the genomic coordinates for the query. Must specify\none of `readGroupSetIds` or `readGroupIds`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "SearchReadsRequest"
+ },
+ "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"
+ }
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`",
+ "type": "string"
+ },
+ "error": {
+ "$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": "An OperationMetadata object. This will always be returned with the Operation.",
+ "type": "object"
+ }
+ },
+ "id": "Operation"
+ },
+ "ImportReadGroupSetsResponse": {
+ "description": "The read group set import response.",
+ "type": "object",
+ "properties": {
+ "readGroupSetIds": {
+ "description": "IDs of the read group sets that were created.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ImportReadGroupSetsResponse"
+ },
+ "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"
+ },
+ "genotype": {
+ "description": "The genotype of this variant call. Each value represents either the value\nof the `referenceBases` field or a 1-based index into\n`alternateBases`. If a variant had a `referenceBases`\nvalue of `T` and an `alternateBases`\nvalue of `[\"A\", \"C\"]`, and the `genotype` was\n`[2, 1]`, that would mean the call\nrepresented the heterozygous value `CA` for this variant.\nIf the `genotype` was instead `[0, 1]`, the\nrepresented value would be `TA`. Ordering of the\ngenotype values is important if the `phaseset` is present.\nIf a genotype is not called (that is, a `.` is present in the\nGT string) -1 is returned.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "phaseset": {
+ "description": "If this field is present, this variant call's genotype ordering implies\nthe phase of the bases and is consistent with any other variant calls in\nthe same reference sequence which have the same phaseset value.\nWhen importing data from VCF, if the genotype data was phased but no\nphase set was specified this field will be set to `*`.",
+ "type": "string"
+ },
+ "info": {
+ "description": "A map of additional variant call information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ },
+ "callSetName": {
+ "description": "The name of the call set this variant call belongs to.",
+ "type": "string"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "id": "SearchVariantsResponse"
+ },
+ "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"
+ },
+ "sequence": {
+ "description": "A substring of the bases that make up this reference.",
+ "type": "string"
+ }
+ },
+ "id": "ListBasesResponse"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "UndeleteDatasetRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteDatasetRequest"
+ },
+ "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "end": {
+ "description": "The end position of the range on the reference, 0-based exclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "referenceName": {
+ "description": "The reference sequence name, for example `chr1`,\n`1`, or `chrX`.",
+ "type": "string"
+ }
+ },
+ "id": "Range"
+ },
+ "VariantSet": {
+ "description": "A variant set is a collection of call sets and variants. It contains summary\nstatistics of those contents. A variant set belongs to a dataset.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A textual description of this variant set.",
+ "type": "string"
+ },
+ "datasetId": {
+ "description": "The dataset to which this variant set belongs.",
+ "type": "string"
+ },
+ "name": {
+ "description": "User-specified, mutable name.",
+ "type": "string"
+ },
+ "referenceSetId": {
+ "description": "The reference set to which the variant set is mapped. The reference set\ndescribes the alignment provenance of the variant set, while the\n`referenceBounds` describe the shape of the actual variant data. The\nreference set's reference names are a superset of those found in the\n`referenceBounds`.\n\nFor example, given a variant set that is mapped to the GRCh38 reference set\nand contains a single variant on reference 'X', `referenceBounds` would\ncontain only an entry for 'X', while the associated reference set\nenumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "The metadata associated with this variant set.",
+ "type": "array",
+ "items": {
+ "$ref": "VariantSetMetadata"
+ }
+ },
+ "referenceBounds": {
+ "description": "A list of all references used by the variants in a variant set\nwith associated coordinate upper bounds for each one.",
+ "type": "array",
+ "items": {
+ "$ref": "ReferenceBound"
+ }
+ },
+ "id": {
+ "description": "The server-generated variant set ID, unique across all variant sets.",
+ "type": "string"
+ }
+ },
+ "id": "VariantSet"
+ },
"ReferenceBound": {
"description": "ReferenceBound records an upper bound for the starting coordinate of\nvariants in a particular reference.",
"type": "object",
"properties": {
- "referenceName": {
- "type": "string",
- "description": "The name of the reference associated with this reference bound."
- },
"upperBound": {
- "type": "string",
"description": "An upper bound (inclusive) on the starting coordinate of any\nvariant in the reference sequence.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
+ },
+ "referenceName": {
+ "description": "The name of the reference associated with this reference bound.",
+ "type": "string"
}
},
"id": "ReferenceBound"
},
"BatchCreateAnnotationsResponse": {
- "id": "BatchCreateAnnotationsResponse",
"type": "object",
"properties": {
"entries": {
@@ -1616,27 +2884,29 @@
"$ref": "Entry"
}
}
- }
+ },
+ "id": "BatchCreateAnnotationsResponse"
},
- "SearchCallSetsResponse": {
- "description": "The call set search response.",
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
- "nextPageToken": {
- "type": "string",
- "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."
- },
- "callSets": {
- "description": "The list of matching call sets.",
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"type": "array",
"items": {
- "$ref": "CallSet"
+ "$ref": "Operation"
}
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
- "id": "SearchCallSetsResponse"
+ "id": "ListOperationsResponse"
},
"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": {
@@ -1658,18 +2928,18 @@
"type": "object"
},
"referenceBases": {
- "type": "string",
- "description": "The reference bases for this variant. They start at the given\nposition."
+ "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.",
+ "alternateBases": {
+ "description": "The bases that appear instead of the reference bases.",
"type": "array",
"items": {
"type": "string"
}
},
- "alternateBases": {
- "description": "The bases that appear instead of the reference bases.",
+ "names": {
+ "description": "Names for the variant, for example a RefSNP ID.",
"type": "array",
"items": {
"type": "string"
@@ -1705,116 +2975,43 @@
"type": "string"
},
"quality": {
- "type": "number",
"description": "A measure of how likely this variant is to be real.\nA higher value is better.",
- "format": "double"
+ "format": "double",
+ "type": "number"
},
"id": {
"description": "The server-generated variant ID, unique across all variants.",
"type": "string"
}
},
- "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."
+ "id": "Variant"
},
- "ListOperationsResponse": {
+ "SearchCallSetsResponse": {
+ "description": "The call set search response.",
"type": "object",
"properties": {
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
+ "callSets": {
+ "description": "The list of matching call sets.",
"type": "array",
"items": {
- "$ref": "Operation"
+ "$ref": "CallSet"
}
},
"nextPageToken": {
- "type": "string",
- "description": "The standard List next-page token."
+ "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": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations."
- },
- "OperationMetadata": {
- "description": "Metadata describing an Operation.",
- "type": "object",
- "properties": {
- "projectId": {
- "type": "string",
- "description": "The Google Cloud Project in which the job is scoped."
- },
- "clientId": {
- "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
- "type": "string"
- },
- "events": {
- "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.",
- "type": "array",
- "items": {
- "$ref": "OperationEvent"
- }
- },
- "endTime": {
- "description": "The time at which the job stopped running.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "The time at which the job began to run.",
- "format": "google-datetime",
- "type": "string"
- },
- "request": {
- "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "runtimeMetadata": {
- "description": "Runtime metadata on this Operation.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "createTime": {
- "description": "The time at which the job was submitted to the Genomics service.",
- "format": "google-datetime",
- "type": "string"
- },
- "labels": {
- "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "id": "OperationMetadata"
+ "id": "SearchCallSetsResponse"
},
"SearchVariantsRequest": {
- "id": "SearchVariantsRequest",
"description": "The variant search request.",
"type": "object",
"properties": {
- "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",
- "items": {
- "type": "string"
- }
- },
"end": {
- "type": "string",
"description": "The end of the window, 0-based exclusive. If unspecified or 0, defaults to\nthe length of the reference.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"maxCalls": {
"description": "The maximum number of calls to return in a single page. Note that this\nlimit may be exceeded in the event that a matching variant contains more\ncalls than the requested maximum. If unspecified, defaults to 5000. The\nmaximum value is 10000.",
@@ -1845,8 +3042,80 @@
"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",
+ "items": {
+ "type": "string"
+ }
}
- }
+ },
+ "id": "SearchVariantsRequest"
+ },
+ "OperationMetadata": {
+ "description": "Metadata describing an Operation.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "createTime": {
+ "description": "The time at which the job was submitted to the Genomics service.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Cloud Project in which the job is scoped.",
+ "type": "string"
+ },
+ "clientId": {
+ "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "The time at which the job stopped running.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "events": {
+ "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.",
+ "type": "array",
+ "items": {
+ "$ref": "OperationEvent"
+ }
+ },
+ "startTime": {
+ "description": "The time at which the job began to run.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "request": {
+ "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "runtimeMetadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Runtime metadata on this Operation.",
+ "type": "object"
+ }
+ },
+ "id": "OperationMetadata"
},
"SearchReadGroupSetsRequest": {
"description": "The read group set search request.",
@@ -1857,8 +3126,8 @@
"type": "string"
},
"pageToken": {
- "type": "string",
- "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."
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
},
"pageSize": {
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 1024.",
@@ -1879,8 +3148,8 @@
"type": "object",
"properties": {
"nextPageToken": {
- "type": "string",
- "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."
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
},
"annotations": {
"description": "The matching annotations.",
@@ -1893,38 +3162,26 @@
"id": "SearchAnnotationsResponse"
},
"SearchReadsResponse": {
- "id": "SearchReadsResponse",
"description": "The read search response.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- },
"alignments": {
+ "description": "The list of matching alignments sorted by mapped genomic coordinate,\nif any, ascending in position within the same reference. Unmapped reads,\nwhich have no position, are returned contiguously and are sorted in\nascending lexicographic order by fragment name.",
"type": "array",
"items": {
"$ref": "Read"
- },
- "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."
- }
- }
- },
- "ClinicalCondition": {
- "id": "ClinicalCondition",
- "type": "object",
- "properties": {
- "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"
}
},
+ "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"
+ },
+ "ClinicalCondition": {
+ "type": "object",
+ "properties": {
"omimId": {
"description": "The OMIM id for this condition.\nSearch for these IDs at http://omim.org/",
"type": "string"
@@ -1935,8 +3192,20 @@
"items": {
"$ref": "ExternalId"
}
+ },
+ "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"
},
"Program": {
"type": "object",
@@ -1984,24 +3253,24 @@
"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"
},
"diskNames": {
+ "description": "The names of the disks that were created for this pipeline.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "The names of the disks that were created for this pipeline."
+ }
},
"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"
@@ -2009,13 +3278,13 @@
"ExternalId": {
"type": "object",
"properties": {
- "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": {
+ "description": "The id used by the source of this data.",
+ "type": "string"
}
},
"id": "ExternalId"
@@ -2024,13 +3293,9 @@
"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`.",
- "type": "string"
- },
"md5checksum": {
- "type": "string",
- "description": "MD5 of the upper-case sequence excluding all whitespace characters (this\nis equivalent to SQ:M5 in SAM). This value is represented in lower case\nhexadecimal format."
+ "description": "MD5 of the upper-case sequence excluding all whitespace characters (this\nis equivalent to SQ:M5 in SAM). This value is represented in lower case\nhexadecimal format.",
+ "type": "string"
},
"id": {
"description": "The server-generated reference ID, unique across all references.",
@@ -2056,6 +3321,10 @@
"sourceUri": {
"description": "The URI from which the sequence was obtained. Typically specifies a FASTA\nformat file.",
"type": "string"
+ },
+ "name": {
+ "description": "The name of this reference, for example `22`.",
+ "type": "string"
}
},
"id": "Reference"
@@ -2064,15 +3333,23 @@
"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": {
+ "key": {
+ "description": "The top-level key.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A textual description of this metadata.",
+ "type": "string"
+ },
"info": {
- "description": "Remaining structured metadata key-value pairs. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "any"
}
- }
+ },
+ "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"
},
"type": {
"description": "The type of data. Possible types include: Integer, Float,\nFlag, Character, and String.",
@@ -2105,14 +3382,6 @@
"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.",
- "type": "string"
- },
- "description": {
- "description": "A textual description of this metadata.",
- "type": "string"
}
},
"id": "VariantSetMetadata"
@@ -2121,6 +3390,11 @@
"description": "The search variant sets request.",
"type": "object",
"properties": {
+ "pageSize": {
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
+ "format": "int32",
+ "type": "integer"
+ },
"datasetIds": {
"description": "Exactly one dataset ID must be provided here. Only variant sets which\nbelong to this dataset will be returned.",
"type": "array",
@@ -2131,11 +3405,6 @@
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
- },
- "pageSize": {
- "type": "integer",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
- "format": "int32"
}
},
"id": "SearchVariantSetsRequest"
@@ -2143,6 +3412,13 @@
"SearchReferenceSetsRequest": {
"type": "object",
"properties": {
+ "md5checksums": {
+ "description": "If present, return reference sets for which the\nmd5checksum matches exactly.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"accessions": {
"description": "If present, return reference sets for which a prefix of any of\nsourceAccessions\nmatch any of these strings. Accession numbers typically have a main number\nand a version, for example `NC_000001.11`.",
"type": "array",
@@ -2155,20 +3431,13 @@
"type": "string"
},
"pageSize": {
- "type": "integer",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"assemblyId": {
"description": "If present, return reference sets for which a substring of their\n`assemblyId` matches this string (case insensitive).",
"type": "string"
- },
- "md5checksums": {
- "description": "If present, return reference sets for which the\nmd5checksum matches exactly.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
},
"id": "SearchReferenceSetsRequest"
@@ -2185,9 +3454,20 @@
"id": "SetIamPolicyRequest"
},
"MergeVariantsRequest": {
- "id": "MergeVariantsRequest",
"type": "object",
"properties": {
+ "infoMergeConfig": {
+ "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them.",
+ "type": "object",
+ "additionalProperties": {
+ "enum": [
+ "INFO_MERGE_OPERATION_UNSPECIFIED",
+ "IGNORE_NEW",
+ "MOVE_TO_CALLS"
+ ],
+ "type": "string"
+ }
+ },
"variantSetId": {
"description": "The destination variant set.",
"type": "string"
@@ -2198,50 +3478,14 @@
"items": {
"$ref": "Variant"
}
- },
- "infoMergeConfig": {
- "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "enum": [
- "INFO_MERGE_OPERATION_UNSPECIFIED",
- "IGNORE_NEW",
- "MOVE_TO_CALLS"
- ]
- }
- }
- }
- },
- "BatchCreateAnnotationsRequest": {
- "type": "object",
- "properties": {
- "annotations": {
- "description": "The annotations to be created. At most 4096 can be specified in a single\nrequest.",
- "type": "array",
- "items": {
- "$ref": "Annotation"
- }
- },
- "requestId": {
- "type": "string",
- "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."
}
},
- "id": "BatchCreateAnnotationsRequest"
+ "id": "MergeVariantsRequest"
},
"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",
@@ -2252,16 +3496,16 @@
"type": "boolean"
},
"alignedQuality": {
+ "description": "The quality of the read sequence contained in this alignment record\n(equivalent to QUAL in SAM).\n`alignedSequence` and `alignedQuality` may be shorter than the full read\nsequence and quality. This will occur if the alignment is part of a\nchimeric alignment, or if the read was trimmed. When this occurs, the CIGAR\nfor this read will begin/end with a hard clip operator that will indicate\nthe length of the excised sequence.",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
- },
- "description": "The quality of the read sequence contained in this alignment record\n(equivalent to QUAL in SAM).\n`alignedSequence` and `alignedQuality` may be shorter than the full read\nsequence and quality. This will occur if the alignment is part of a\nchimeric alignment, or if the read was trimmed. When this occurs, the CIGAR\nfor this read will begin/end with a hard clip operator that will indicate\nthe length of the excised sequence."
+ }
},
"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"
},
"id": {
"description": "The server-generated read ID, unique across all reads. This is different\nfrom the `fragmentName`.",
@@ -2314,67 +3558,49 @@
"type": "any"
}
}
+ },
+ "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"
}
},
"id": "Read"
},
- "ReferenceSet": {
+ "BatchCreateAnnotationsRequest": {
+ "type": "object",
"properties": {
- "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`.",
+ "annotations": {
+ "description": "The annotations to be created. At most 4096 can be specified in a single\nrequest.",
"type": "array",
"items": {
- "type": "string"
+ "$ref": "Annotation"
}
},
- "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"
- },
- "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",
- "items": {
- "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.",
+ "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": "ReferenceSet",
- "description": "A reference set is a set of references which typically comprise a reference\nassembly for a species, such as `GRCh38` which is representative\nof the human genome. A reference set defines a common coordinate space for\ncomparing reference-aligned experimental data. A reference set contains 1 or\nmore references.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "type": "object"
+ "id": "BatchCreateAnnotationsRequest"
},
"CigarUnit": {
"description": "A single CIGAR operation.",
"type": "object",
"properties": {
+ "referenceSequence": {
+ "description": "`referenceSequence` is only used at mismatches\n(`SEQUENCE_MISMATCH`) and deletions (`DELETE`).\nFilling this field replaces SAM's MD tag. If the relevant information is\nnot available, this field is unset.",
+ "type": "string"
+ },
"operationLength": {
"description": "The number of genomic bases that the operation runs for. Required.",
"format": "int64",
"type": "string"
},
"operation": {
- "type": "string",
"enumDescriptions": [
"",
"An alignment match indicates that a sequence can be aligned to the\nreference without evidence of an INDEL. Unlike the\n`SEQUENCE_MATCH` and `SEQUENCE_MISMATCH` operators,\nthe `ALIGNMENT_MATCH` operator does not indicate whether the\nreference and read sequences are an exact match. This operator is\nequivalent to SAM's `M`.",
@@ -2398,15 +3624,80 @@
"PAD",
"SEQUENCE_MATCH",
"SEQUENCE_MISMATCH"
- ]
- },
- "referenceSequence": {
- "description": "`referenceSequence` is only used at mismatches\n(`SEQUENCE_MISMATCH`) and deletions (`DELETE`).\nFilling this field replaces SAM's MD tag. If the relevant information is\nnot available, this field is unset.",
+ ],
"type": "string"
}
},
"id": "CigarUnit"
},
+ "ReferenceSet": {
+ "description": "A reference set is a set of references which typically comprise a reference\nassembly for a species, such as `GRCh38` which is representative\nof the human genome. A reference set defines a common coordinate space for\ncomparing reference-aligned experimental data. A reference set contains 1 or\nmore references.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
+ "properties": {
+ "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",
+ "items": {
+ "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",
+ "items": {
+ "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"
+ },
+ "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": {
+ "geneId": {
+ "description": "The annotation ID of the gene from which this transcript is transcribed.",
+ "type": "string"
+ },
+ "exons": {
+ "description": "The \u003ca href=\"http://en.wikipedia.org/wiki/Exon\"\u003eexons\u003c/a\u003e that compose\nthis transcript. This field should be unset for genomes where transcript\nsplicing does not occur, for example prokaryotes.\n\nIntrons are regions of the transcript that are not included in the\nspliced RNA product. Though not explicitly modeled here, intron ranges can\nbe deduced; all regions of this transcript that are not exons are introns.\n\nExonic sequences do not necessarily code for a translational product\n(amino acids). Only the regions of exons bounded by the\ncodingSequence correspond\nto coding DNA sequence.\n\nExons are ordered by start position and may not overlap.",
+ "type": "array",
+ "items": {
+ "$ref": "Exon"
+ }
+ },
+ "codingSequence": {
+ "$ref": "CodingSequence",
+ "description": "The range of the coding sequence for this transcript, if any. To determine\nthe exact ranges of coding sequence, intersect this range with those of the\nexons, if any. If there are any\nexons, the\ncodingSequence must start\nand end within them.\n\nNote that in some cases, the reference genome will not exactly match the\nobserved mRNA transcript e.g. due to variance in the source genome from\nreference. In these cases,\nexon.frame will not necessarily\nmatch the expected reference reading frame and coding exon reference bases\ncannot necessarily be concatenated to produce the original transcript mRNA."
+ }
+ },
+ "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'.",
"type": "object",
@@ -2428,6 +3719,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",
@@ -2436,14 +3734,7 @@
"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": {
"additionalProperties": {
@@ -2462,35 +3753,9 @@
},
"id": "AnnotationSet"
},
- "Transcript": {
- "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.",
- "type": "array",
- "items": {
- "$ref": "Exon"
- }
- },
- "codingSequence": {
- "$ref": "CodingSequence",
- "description": "The range of the coding sequence for this transcript, if any. To determine\nthe exact ranges of coding sequence, intersect this range with those of the\nexons, if any. If there are any\nexons, the\ncodingSequence must start\nand end within them.\n\nNote that in some cases, the reference genome will not exactly match the\nobserved mRNA transcript e.g. due to variance in the source genome from\nreference. In these cases,\nexon.frame will not necessarily\nmatch the expected reference reading frame and coding exon reference bases\ncannot necessarily be concatenated to produce the original transcript mRNA."
- },
- "geneId": {
- "description": "The annotation ID of the gene from which this transcript is transcribed.",
- "type": "string"
- }
- },
- "id": "Transcript",
- "description": "A transcript represents the assertion that a particular region of the\nreference genome may be transcribed as RNA.",
- "type": "object"
- },
"Experiment": {
"type": "object",
"properties": {
- "sequencingCenter": {
- "description": "The sequencing center used as part of this experiment.",
- "type": "string"
- },
"platformUnit": {
"description": "The platform unit used as part of this experiment, for example\nflowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the\n@RG PU field in the SAM spec.",
"type": "string"
@@ -2502,11 +3767,16 @@
"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"
}
},
"id": "Experiment"
},
"ListDatasetsResponse": {
+ "description": "The dataset list response.",
"type": "object",
"properties": {
"datasets": {
@@ -2521,10 +3791,10 @@
"type": "string"
}
},
- "id": "ListDatasetsResponse",
- "description": "The dataset list response."
+ "id": "ListDatasetsResponse"
},
"TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
@@ -2535,1252 +3805,7 @@
}
}
},
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method."
- },
- "Exon": {
- "id": "Exon",
- "type": "object",
- "properties": {
- "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",
- "type": "string"
- },
- "frame": {
- "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"
- }
- }
- },
- "ExportReadGroupSetRequest": {
- "description": "The read group set export request.",
- "type": "object",
- "properties": {
- "exportUri": {
- "type": "string",
- "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."
- },
- "referenceNames": {
- "description": "The reference names to export. If this is not specified, all reference\nsequences, including unmapped reads, are exported.\nUse `*` to export only unmapped reads.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "projectId": {
- "description": "Required. The Google Cloud project ID that owns this\nexport. The caller must have WRITE access to this project.",
- "type": "string"
- }
- },
- "id": "ExportReadGroupSetRequest"
- },
- "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": {
- "name": {
- "description": "The call set name.",
- "type": "string"
- },
- "info": {
- "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).",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "The server-generated call set ID, unique across all call sets."
- },
- "created": {
- "description": "The date this call set was created in milliseconds from the epoch.",
- "format": "int64",
- "type": "string"
- },
- "sampleId": {
- "description": "The sample ID this call set corresponds to.",
- "type": "string"
- }
- },
- "id": "CallSet"
- },
- "SearchAnnotationSetsResponse": {
- "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"
- }
- }
- },
- "id": "SearchAnnotationSetsResponse"
- },
- "ImportVariantsRequest": {
- "description": "The variant data import request.",
- "type": "object",
- "properties": {
- "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",
- "IGNORE_NEW",
- "MOVE_TO_CALLS"
- ],
- "type": "string"
- }
- },
- "variantSetId": {
- "description": "Required. The variant set to which variant data should be imported.",
- "type": "string"
- },
- "sourceUris": {
- "description": "A list of URIs referencing variant files in Google Cloud Storage. URIs can\ninclude wildcards [as described\nhere](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).\nNote that recursive wildcards ('**') are not supported.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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"
- },
- "VariantAnnotation": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "The set of conditions associated with this variant.\nA condition describes the way a variant influences human health.",
- "type": "array",
- "items": {
- "$ref": "ClinicalCondition"
- }
- },
- "effect": {
- "enumDescriptions": [
- "",
- "`EFFECT_OTHER` should be used when no other Effect\nwill suffice.",
- "`FRAMESHIFT` indicates a mutation in which the insertion or\ndeletion of nucleotides resulted in a frameshift change.",
- "`FRAME_PRESERVING_INDEL` indicates a mutation in which a\nmultiple of three nucleotides has been inserted or deleted, resulting\nin no change to the reading frame of the coding sequence.",
- "`SYNONYMOUS_SNP` indicates a single nucleotide polymorphism\nmutation that results in no amino acid change.",
- "`NONSYNONYMOUS_SNP` indicates a single nucleotide\npolymorphism mutation that results in an amino acid change.",
- "`STOP_GAIN` indicates a mutation that leads to the creation\nof a stop codon at the variant site. Frameshift mutations creating\ndownstream stop codons do not count as `STOP_GAIN`.",
- "`STOP_LOSS` indicates a mutation that eliminates a\nstop codon at the variant site.",
- "`SPLICE_SITE_DISRUPTION` indicates that this variant is\nfound in a splice site for the associated transcript, and alters the\nnormal splicing pattern."
- ],
- "enum": [
- "EFFECT_UNSPECIFIED",
- "EFFECT_OTHER",
- "FRAMESHIFT",
- "FRAME_PRESERVING_INDEL",
- "SYNONYMOUS_SNP",
- "NONSYNONYMOUS_SNP",
- "STOP_GAIN",
- "STOP_LOSS",
- "SPLICE_SITE_DISRUPTION"
- ],
- "description": "Effect of the variant on the coding sequence.",
- "type": "string"
- },
- "transcriptIds": {
- "description": "Google annotation IDs of the transcripts affected by this variant. These\nshould be provided when the variant is created.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "enumDescriptions": [
- "",
- "`TYPE_OTHER` should be used when no other Type will suffice.\nFurther explanation of the variant type may be included in the\ninfo field.",
- "`INSERTION` indicates an insertion.",
- "`DELETION` indicates a deletion.",
- "`SUBSTITUTION` indicates a block substitution of\ntwo or more nucleotides.",
- "`SNP` indicates a single nucleotide polymorphism.",
- "`STRUCTURAL` indicates a large structural variant,\nincluding chromosomal fusions, inversions, etc.",
- "`CNV` indicates a variation in copy number."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "TYPE_OTHER",
- "INSERTION",
- "DELETION",
- "SUBSTITUTION",
- "SNP",
- "STRUCTURAL",
- "CNV"
- ],
- "description": "Type has been adapted from ClinVar's list of variant types.",
- "type": "string"
- },
- "alternateBases": {
- "description": "The alternate allele for this variant. If multiple alternate alleles\nexist at this location, create a separate variant for each one, as they\nmay represent distinct conditions.",
- "type": "string"
- },
- "geneId": {
- "description": "Google annotation ID of the gene affected by this variant. This should\nbe provided when the variant is created.",
- "type": "string"
- },
- "clinicalSignificance": {
- "type": "string",
- "enumDescriptions": [
- "",
- "`OTHER` should be used when no other clinical significance\nvalue will suffice.",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "`MULTIPLE_REPORTED` should be used when multiple clinical\nsignficances are reported for a variant. The original clinical\nsignificance values may be provided in the `info` field."
- ],
- "enum": [
- "CLINICAL_SIGNIFICANCE_UNSPECIFIED",
- "CLINICAL_SIGNIFICANCE_OTHER",
- "UNCERTAIN",
- "BENIGN",
- "LIKELY_BENIGN",
- "LIKELY_PATHOGENIC",
- "PATHOGENIC",
- "DRUG_RESPONSE",
- "HISTOCOMPATIBILITY",
- "CONFERS_SENSITIVITY",
- "RISK_FACTOR",
- "ASSOCIATION",
- "PROTECTIVE",
- "MULTIPLE_REPORTED"
- ],
- "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/"
- }
- },
- "id": "VariantAnnotation"
- },
- "ListCoverageBucketsResponse": {
- "type": "object",
- "properties": {
- "coverageBuckets": {
- "description": "The coverage buckets. The list of buckets is sparse; a bucket with 0\noverlapping reads is not returned. A bucket never crosses more than one\nreference sequence. Each bucket has width `bucketWidth`, unless\nits end is the end of the reference sequence.",
- "type": "array",
- "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"
- },
- "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",
- "type": "string"
- }
- },
- "id": "ListCoverageBucketsResponse"
- },
- "ExportVariantSetRequest": {
- "description": "The variant data export request.",
- "type": "object",
- "properties": {
- "format": {
- "description": "The format for the exported data.",
- "type": "string",
- "enumDescriptions": [
- "",
- "Export the data to Google BigQuery."
- ],
- "enum": [
- "FORMAT_UNSPECIFIED",
- "FORMAT_BIGQUERY"
- ]
- },
- "bigqueryDataset": {
- "description": "Required. The BigQuery dataset to export data to. This dataset must already\nexist. Note that this is distinct from the Genomics concept of \"dataset\".",
- "type": "string"
- },
- "bigqueryTable": {
- "description": "Required. The BigQuery table to export data to.\nIf the table doesn't exist, it will be created. If it already exists, it\nwill be overwritten.",
- "type": "string"
- },
- "callSetIds": {
- "description": "If provided, only variant call information from the specified call sets\nwill be exported. By default all variant calls are exported.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "projectId": {
- "description": "Required. The Google Cloud project ID that owns the destination\nBigQuery dataset. The caller must have WRITE access to this project. This\nproject will also own the resulting export job.",
- "type": "string"
- }
- },
- "id": "ExportVariantSetRequest"
- },
- "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"
- },
- "referenceId": {
- "description": "The ID of the reference to query.",
- "type": "string"
- },
- "end": {
- "description": "The end position of the range on the reference, 0-based exclusive. If\nreferenceId or\nreferenceName\nmust be specified, Defaults to the length of the reference.",
- "format": "int64",
- "type": "string"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.",
- "format": "int32"
- },
- "start": {
- "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified,\nreferenceId or\nreferenceName\nmust be specified. Defaults to 0.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "SearchAnnotationsRequest"
- },
- "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": {
- "type": "string",
- "description": "Optional time of when event started.",
- "format": "google-datetime"
- }
- },
- "id": "OperationEvent"
- },
- "CodingSequence": {
- "properties": {
- "start": {
- "description": "The start of the coding sequence on this annotation's reference sequence,\n0-based inclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.",
- "format": "int64",
- "type": "string"
- },
- "end": {
- "description": "The end of the coding sequence on this annotation's reference sequence,\n0-based exclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "CodingSequence",
- "type": "object"
- },
- "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."
- },
- "SearchReferencesResponse": {
- "type": "object",
- "properties": {
- "references": {
- "description": "The matching references.",
- "type": "array",
- "items": {
- "$ref": "Reference"
- }
- },
- "nextPageToken": {
- "type": "string",
- "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."
- }
- },
- "id": "SearchReferencesResponse"
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
- },
- "SearchAnnotationSetsRequest": {
- "properties": {
- "referenceSetId": {
- "description": "If specified, only annotation sets associated with the given reference set\nare returned.",
- "type": "string"
- },
- "pageToken": {
- "type": "string",
- "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."
- },
- "pageSize": {
- "type": "integer",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 128. The maximum value is 1024.",
- "format": "int32"
- },
- "datasetIds": {
- "description": "Required. The dataset IDs to search within. Caller must have `READ` access\nto these datasets.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "types": {
- "description": "If specified, only annotation sets that have any of these types are\nreturned.",
- "type": "array",
- "items": {
- "enum": [
- "ANNOTATION_TYPE_UNSPECIFIED",
- "GENERIC",
- "VARIANT",
- "GENE",
- "TRANSCRIPT"
- ],
- "type": "string"
- },
- "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"
- }
- },
- "id": "SearchAnnotationSetsRequest",
- "type": "object"
- },
- "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"
- }
- }
- },
- "id": "SearchReadGroupSetsResponse"
- },
- "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.",
- "format": "int32",
- "type": "integer"
- },
- "position": {
- "description": "The position of this alignment.",
- "$ref": "Position"
- },
- "cigar": {
- "description": "Represents the local alignment of this sequence (alignment matches, indels,\netc) against the reference.",
- "type": "array",
- "items": {
- "$ref": "CigarUnit"
- }
- }
- },
- "id": "LinearAlignment"
- },
- "SearchReferencesRequest": {
- "type": "object",
- "properties": {
- "accessions": {
- "description": "If present, return references for which a prefix of any of\nsourceAccessions match\nany of these strings. Accession numbers typically have a main number and a\nversion, for example `GCF_000001405.26`.",
- "type": "array",
- "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"
- },
- "referenceSetId": {
- "description": "If present, return only references which belong to this reference set.",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.",
- "format": "int32",
- "type": "integer"
- },
- "md5checksums": {
- "description": "If present, return references for which the\nmd5checksum matches exactly.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "SearchReferencesRequest"
- },
- "Dataset": {
- "description": "A Dataset is a collection of genomic data.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "type": "object",
- "properties": {
- "createTime": {
- "description": "The time this dataset was created, in seconds from the epoch.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "The dataset name."
- },
- "projectId": {
- "description": "The Google Cloud project ID that this dataset belongs to.",
- "type": "string"
- },
- "id": {
- "description": "The server-generated dataset ID, unique across all datasets.",
- "type": "string"
- }
- },
- "id": "Dataset"
- },
- "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"
- },
- "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"
- }
- },
- "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"
- },
- "description": {
- "type": "string",
- "description": "A free-form text description of this read group."
- },
- "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": {
- "type": "object",
- "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)."
- }
- },
- "id": "ReadGroup"
- },
- "ReadGroupSet": {
- "description": "A read group set is a logical collection of read groups, which are\ncollections of reads produced by a sequencer. A read group set typically\nmodels reads corresponding to one sample, sequenced one way, and aligned one\nway.\n\n* A read group set belongs to one dataset.\n* A read group belongs to one read group set.\n* A read belongs to one read group.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "type": "object",
- "properties": {
- "datasetId": {
- "type": "string",
- "description": "The dataset to which this read group set belongs."
- },
- "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": {
- "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"
- }
- },
- "id": "ReadGroupSet"
- },
- "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"
- },
- "Entry": {
- "properties": {
- "status": {
- "$ref": "Status",
- "description": "The creation status."
- },
- "annotation": {
- "$ref": "Annotation",
- "description": "The created annotation, if creation was successful."
- }
- },
- "id": "Entry",
- "type": "object"
- },
- "Position": {
- "description": "An abstraction for referring to a genomic position, in relation to some\nalready known reference. For now, represents a genomic position as a\nreference name, a base number on that reference (0-based), and a\ndetermination of forward or reverse strand.",
- "type": "object",
- "properties": {
- "position": {
- "description": "The 0-based offset from the start of the forward strand for that reference.",
- "format": "int64",
- "type": "string"
- },
- "referenceName": {
- "description": "The name of the reference in whatever reference set is being used.",
- "type": "string"
- },
- "reverseStrand": {
- "description": "Whether this position is on the reverse strand, as opposed to the forward\nstrand.",
- "type": "boolean"
- }
- },
- "id": "Position"
- },
- "SearchReferenceSetsResponse": {
- "type": "object",
- "properties": {
- "referenceSets": {
- "description": "The matching references sets.",
- "type": "array",
- "items": {
- "$ref": "ReferenceSet"
- }
- },
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- }
- },
- "id": "SearchReferenceSetsResponse"
- },
- "SearchCallSetsRequest": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Only return call sets for which a substring of the name matches this\nstring.",
- "type": "string"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
- "format": "int32",
- "type": "integer"
- },
- "variantSetIds": {
- "description": "Restrict the query to call sets within the given variant sets. At least one\nID must be provided.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "SearchCallSetsRequest",
- "description": "The call set search request."
- },
- "ImportReadGroupSetsRequest": {
- "description": "The read group set import request.",
- "type": "object",
- "properties": {
- "sourceUris": {
- "description": "A list of URIs pointing at [BAM\nfiles](https://samtools.github.io/hts-specs/SAMv1.pdf)\nin Google Cloud Storage.\nThose URIs can include wildcards (*), but do not add or remove\nmatching files before import has completed.\n\nNote that Google Cloud Storage object listing is only eventually\nconsistent: files added may be not be immediately visible to\neveryone. Thus, if using a wildcard it is preferable not to start\nthe import immediately after the files are created.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "referenceSetId": {
- "description": "The reference set to which the imported read group sets are aligned to, if\nany. The reference names of this reference set must be a superset of those\nfound in the imported file headers. If no reference set id is provided, a\nbest effort is made to associate with a matching reference set.",
- "type": "string"
- },
- "partitionStrategy": {
- "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"
- }
- },
- "id": "ImportReadGroupSetsRequest"
- },
- "Policy": {
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
- "type": "object",
- "properties": {
- "bindings": {
- "type": "array",
- "items": {
- "$ref": "Binding"
- },
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error."
- },
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "type": "integer",
- "description": "Deprecated.",
- "format": "int32"
- }
- }
- },
- "SearchReadsRequest": {
- "type": "object",
- "properties": {
- "readGroupIds": {
- "description": "The IDs of the read groups within which to search for reads. All specified\nread groups must belong to the same read group sets. Must specify one of\n`readGroupSetIds` or `readGroupIds`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "end": {
- "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified.",
- "format": "int64",
- "type": "string"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.",
- "format": "int32",
- "type": "integer"
- },
- "start": {
- "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified.",
- "format": "int64",
- "type": "string"
- },
- "referenceName": {
- "description": "The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to\n`*`, only unmapped reads are returned. If unspecified, all reads (mapped\nand unmapped) are returned.",
- "type": "string"
- },
- "readGroupSetIds": {
- "description": "The IDs of the read groups sets within which to search for reads. All\nspecified read group sets must be aligned against a common set of reference\nsequences; this defines the genomic coordinates for the query. Must specify\none of `readGroupSetIds` or `readGroupIds`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "SearchReadsRequest",
- "description": "The read search request."
- },
- "CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest"
- },
- "Annotation": {
- "description": "An annotation describes a region of reference genome. The value of an\nannotation may be one of several canonical types, supplemented by arbitrary\ninfo tags. An annotation is not inherently associated with a specific\nsample or individual (though a client could choose to use annotations in\nthis way). Example canonical annotation types are `GENE` and\n`VARIANT`.",
- "type": "object",
- "properties": {
- "referenceName": {
- "description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.",
- "type": "string"
- },
- "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.",
- "format": "int64",
- "type": "string"
- },
- "transcript": {
- "$ref": "Transcript",
- "description": "A transcript value represents the assertion that a particular region of\nthe reference genome may be transcribed as RNA. An alternative splicing\npattern would be represented as a separate transcript object. This field\nis only set for annotations of type `TRANSCRIPT`."
- },
- "start": {
- "description": "The start position of the range on the reference, 0-based inclusive.",
- "format": "int64",
- "type": "string"
- },
- "annotationSetId": {
- "description": "The annotation set to which this annotation belongs.",
- "type": "string"
- },
- "name": {
- "description": "The display name of this annotation.",
- "type": "string"
- },
- "variant": {
- "$ref": "VariantAnnotation",
- "description": "A variant annotation, which describes the effect of a variant on the\ngenome, the coding sequence, and/or higher level consequences at the\norganism level e.g. pathogenicity. This field is only set for annotations\nof type `VARIANT`."
- },
- "id": {
- "type": "string",
- "description": "The server-generated annotation ID, unique across all annotations."
- },
- "referenceId": {
- "description": "The ID of the Google Genomics reference associated with this range.",
- "type": "string"
- },
- "reverseStrand": {
- "description": "Whether this range refers to the reverse strand, as opposed to the forward\nstrand. Note that regardless of this field, the start/end position of the\nrange always refer to the forward strand.",
- "type": "boolean"
- }
- },
- "id": "Annotation"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "description": "An OperationMetadata object. This will always be returned with the Operation.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "description": "If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an Empty response is returned.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "type": "string",
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`"
- }
- },
- "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": {
- "properties": {
- "readGroupSetIds": {
- "description": "IDs of the read group sets that were created.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ImportReadGroupSetsResponse",
- "description": "The read group set import response.",
- "type": "object"
- },
- "VariantCall": {
- "id": "VariantCall",
- "description": "A call represents the determination of genotype with respect to a particular\nvariant. It may include associated information such as quality and phasing.\nFor example, a call might assign a probability of 0.32 to the occurrence of\na SNP named rs1234 in a call set with the name NA12345.",
- "type": "object",
- "properties": {
- "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"
- },
- "genotype": {
- "description": "The genotype of this variant call. Each value represents either the value\nof the `referenceBases` field or a 1-based index into\n`alternateBases`. If a variant had a `referenceBases`\nvalue of `T` and an `alternateBases`\nvalue of `[\"A\", \"C\"]`, and the `genotype` was\n`[2, 1]`, that would mean the call\nrepresented the heterozygous value `CA` for this variant.\nIf the `genotype` was instead `[0, 1]`, the\nrepresented value would be `TA`. Ordering of the\ngenotype values is important if the `phaseset` is present.\nIf a genotype is not called (that is, a `.` is present in the\nGT string) -1 is returned.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- },
- "phaseset": {
- "description": "If this field is present, this variant call's genotype ordering implies\nthe phase of the bases and is consistent with any other variant calls in\nthe same reference sequence which have the same phaseset value.\nWhen importing data from VCF, if the genotype data was phased but no\nphase set was specified this field will be set to `*`.",
- "type": "string"
- },
- "info": {
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "description": "A map of additional variant call information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
- },
- "callSetName": {
- "description": "The name of the call set this variant call belongs to.",
- "type": "string"
- }
- }
- },
- "SearchVariantsResponse": {
- "properties": {
- "variants": {
- "type": "array",
- "items": {
- "$ref": "Variant"
- },
- "description": "The list of matching Variants."
- },
- "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",
- "description": "The variant search response.",
- "type": "object"
- },
- "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"
- },
- "sequence": {
- "type": "string",
- "description": "A substring of the bases that make up this reference."
- }
- },
- "id": "ListBasesResponse"
- },
- "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": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- }
- }
- },
- "UndeleteDatasetRequest": {
- "type": "object",
- "properties": {},
- "id": "UndeleteDatasetRequest"
- },
- "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"
- },
- "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.",
- "format": "int64",
- "type": "string"
- },
- "end": {
- "description": "The end position of the range on the reference, 0-based exclusive.",
- "format": "int64",
- "type": "string"
- },
- "referenceName": {
- "description": "The reference sequence name, for example `chr1`,\n`1`, or `chrX`.",
- "type": "string"
- }
- },
- "id": "Range"
- },
- "VariantSet": {
- "description": "A variant set is a collection of call sets and variants. It contains summary\nstatistics of those contents. A variant set belongs to a dataset.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "type": "object",
- "properties": {
- "name": {
- "description": "User-specified, mutable name.",
- "type": "string"
- },
- "referenceSetId": {
- "description": "The reference set to which the variant set is mapped. The reference set\ndescribes the alignment provenance of the variant set, while the\n`referenceBounds` describe the shape of the actual variant data. The\nreference set's reference names are a superset of those found in the\n`referenceBounds`.\n\nFor example, given a variant set that is mapped to the GRCh38 reference set\nand contains a single variant on reference 'X', `referenceBounds` would\ncontain only an entry for 'X', while the associated reference set\nenumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.",
- "type": "string"
- },
- "metadata": {
- "description": "The metadata associated with this variant set.",
- "type": "array",
- "items": {
- "$ref": "VariantSetMetadata"
- }
- },
- "referenceBounds": {
- "description": "A list of all references used by the variants in a variant set\nwith associated coordinate upper bounds for each one.",
- "type": "array",
- "items": {
- "$ref": "ReferenceBound"
- }
- },
- "id": {
- "description": "The server-generated variant set ID, unique across all variant sets.",
- "type": "string"
- },
- "description": {
- "description": "A textual description of this variant set.",
- "type": "string"
- },
- "datasetId": {
- "description": "The dataset to which this variant set belongs.",
- "type": "string"
- }
- },
- "id": "VariantSet"
+ "id": "TestIamPermissionsRequest"
}
},
"icons": {
@@ -3788,30 +3813,5 @@
"x16": "http://www.google.com/images/icons/product/search-16.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"
- },
- "https://www.googleapis.com/auth/devstorage.read_write": {
- "description": "Manage your data in Google Cloud Storage"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/genomics.readonly": {
- "description": "View Genomics data"
- }
- }
- }
- },
- "servicePath": "",
- "description": "Upload, process, query, and search Genomics data in the cloud.",
- "kind": "discovery#restDescription"
+ "version": "v1"
}
diff --git a/genomics/v1alpha2/genomics-api.json b/genomics/v1alpha2/genomics-api.json
index 7e2e549..336e676 100644
--- a/genomics/v1alpha2/genomics-api.json
+++ b/genomics/v1alpha2/genomics-api.json
@@ -1,16 +1,22 @@
{
+ "basePath": "",
+ "ownerDomain": "google.com",
"name": "genomics",
"batchPath": "batch",
- "revision": "20180123",
- "documentationLink": "https://cloud.google.com/genomics",
"id": "genomics:v1alpha2",
+ "documentationLink": "https://cloud.google.com/genomics",
+ "revision": "20180123",
"title": "Genomics API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"pipelines": {
"methods": {
"get": {
+ "flatPath": "v1alpha2/pipelines/{pipelineId}",
+ "path": "v1alpha2/pipelines/{pipelineId}",
+ "id": "genomics.pipelines.get",
+ "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project.",
"response": {
"$ref": "Pipeline"
},
@@ -20,34 +26,30 @@
"httpMethod": "GET",
"parameters": {
"pipelineId": {
- "location": "path",
- "description": "Caller must have READ access to the project in which this pipeline\nis defined.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path",
+ "description": "Caller must have READ access to the project in which this pipeline\nis defined."
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1alpha2/pipelines/{pipelineId}",
- "path": "v1alpha2/pipelines/{pipelineId}",
- "id": "genomics.pipelines.get",
- "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project."
+ ]
},
"setOperationStatus": {
"flatPath": "v1alpha2/pipelines:setOperationStatus",
- "id": "genomics.pipelines.setOperationStatus",
"path": "v1alpha2/pipelines:setOperationStatus",
+ "id": "genomics.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.",
- "httpMethod": "PUT",
- "parameterOrder": [],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [],
+ "httpMethod": "PUT",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -68,9 +70,9 @@
"type": "string"
},
"validationToken": {
- "format": "uint64",
"type": "string",
- "location": "query"
+ "location": "query",
+ "format": "uint64"
}
},
"scopes": [
@@ -83,13 +85,17 @@
},
"delete": {
"description": "Deletes a pipeline based on ID.\n\nCaller must have WRITE permission to the project.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "pipelineId"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "pipelineId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
"parameters": {
"pipelineId": {
"required": true,
@@ -98,31 +104,32 @@
"description": "Caller must have WRITE access to the project in which this pipeline\nis defined."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
"flatPath": "v1alpha2/pipelines/{pipelineId}",
- "id": "genomics.pipelines.delete",
- "path": "v1alpha2/pipelines/{pipelineId}"
+ "path": "v1alpha2/pipelines/{pipelineId}",
+ "id": "genomics.pipelines.delete"
},
"list": {
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListPipelinesResponse"
+ },
"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",
- "location": "query"
+ "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",
- "location": "query"
+ "type": "string"
},
"pageSize": {
+ "location": "query",
"description": "Number of pipelines to return at once. Defaults to 256, and max\nis 2048.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"projectId": {
"location": "query",
@@ -135,14 +142,9 @@
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1alpha2/pipelines",
- "path": "v1alpha2/pipelines",
"id": "genomics.pipelines.list",
- "description": "Lists pipelines.\n\nCaller must have READ permission to the project.",
- "response": {
- "$ref": "ListPipelinesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET"
+ "path": "v1alpha2/pipelines",
+ "description": "Lists pipelines.\n\nCaller must have READ permission to the project."
},
"create": {
"response": {
@@ -164,10 +166,6 @@
}
},
"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"
},
@@ -181,45 +179,17 @@
"parameters": {},
"flatPath": "v1alpha2/pipelines:run",
"path": "v1alpha2/pipelines:run",
- "id": "genomics.pipelines.run"
+ "id": "genomics.pipelines.run",
+ "description": "Runs a pipeline. If `pipelineId` is specified in the request, then\nrun a saved pipeline. If `ephemeralPipeline` is specified, then run\nthat pipeline once without saving a copy.\n\nThe caller must have READ permission to the project where the pipeline\nis stored and WRITE permission to the project where the pipeline will be\nrun, as VMs will be created and storage will be used.\n\nIf a pipeline operation is still running after 6 days, it will be canceled.",
+ "request": {
+ "$ref": "RunPipelineRequest"
+ }
}
}
},
"operations": {
"methods": {
- "cancel": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1alpha2/operations/{operationsId}:cancel",
- "path": "v1alpha2/{+name}:cancel",
- "id": "genomics.operations.cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.",
- "request": {
- "$ref": "CancelOperationRequest"
- }
- },
"list": {
- "path": "v1alpha2/{+name}",
- "id": "genomics.operations.list",
- "description": "Lists operations that match the specified filter in the request.",
"response": {
"$ref": "ListOperationsResponse"
},
@@ -233,32 +203,36 @@
],
"parameters": {
"name": {
+ "location": "path",
"description": "The name of the operation's parent resource.",
"required": true,
"type": "string",
- "pattern": "^operations$",
- "location": "path"
+ "pattern": "^operations$"
},
"pageToken": {
+ "location": "query",
"description": "The standard list page token.",
- "type": "string",
- "location": "query"
+ "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",
- "location": "query"
+ "type": "integer"
},
"filter": {
- "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`"
}
},
- "flatPath": "v1alpha2/operations"
+ "flatPath": "v1alpha2/operations",
+ "path": "v1alpha2/{+name}",
+ "id": "genomics.operations.list",
+ "description": "Lists operations that match the specified filter in the request."
},
"get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"response": {
"$ref": "Operation"
},
@@ -266,93 +240,56 @@
"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/genomics"
],
- "parameters": {
- "name": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1alpha2/operations/{operationsId}",
"path": "v1alpha2/{+name}",
- "id": "genomics.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ "id": "genomics.operations.get"
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1alpha2/operations/{operationsId}:cancel",
+ "id": "genomics.operations.cancel",
+ "path": "v1alpha2/{+name}:cancel"
}
}
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "description": "API key. Your API 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.",
@@ -365,36 +302,259 @@
"default": "true"
},
"bearer_token": {
- "description": "OAuth bearer token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth bearer token."
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ },
+ "prettyPrint": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
+ },
+ "$.xgafv": {
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format."
+ },
+ "alt": {
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response."
+ },
+ "key": {
+ "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": {
- "LoggingOptions": {
- "description": "The logging options for the pipeline run.",
+ "ComputeEngine": {
"type": "object",
"properties": {
- "gcsPath": {
- "description": "The location in Google Cloud Storage to which the pipeline logs\nwill be copied. Can be specified as a fully qualified directory\npath, in which case logs will be output with a unique identifier\nas the filename in that directory, or as a fully specified path,\nwhich must end in `.log`, in which case that path will be\nused, and the user must ensure that logs are not\noverwritten. Stdout and stderr logs from the run are also\ngenerated and output as `-stdout.log` and `-stderr.log`.",
+ "machineType": {
+ "description": "The machine type of the instance.",
+ "type": "string"
+ },
+ "diskNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The names of the disks that were created for this pipeline."
+ },
+ "instanceName": {
+ "description": "The instance on which the operation is running.",
+ "type": "string"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The availability zone in which the instance resides."
+ }
+ },
+ "id": "ComputeEngine",
+ "description": "Describes a Compute Engine resource that is being managed by a running\npipeline."
+ },
+ "ImportVariantsResponse": {
+ "description": "The variant data import response.",
+ "type": "object",
+ "properties": {
+ "callSetIds": {
+ "description": "IDs of the call sets created during the import.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ImportVariantsResponse"
+ },
+ "TimestampEvent": {
+ "description": "Stores the list of events and times they occured for major events in job\nexecution.",
+ "type": "object",
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "description": "The time this event occured.",
+ "format": "google-datetime"
+ },
+ "description": {
+ "description": "String indicating the type of event",
"type": "string"
}
},
- "id": "LoggingOptions"
+ "id": "TimestampEvent"
},
- "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.",
+ "LocalCopy": {
+ "description": "LocalCopy defines how a remote file should be copied to and from the VM.",
"type": "object",
"properties": {
- "pipelineArgs": {
- "$ref": "RunPipelineArgs",
- "description": "The arguments to use when running this pipeline."
+ "disk": {
+ "description": "Required. The name of the disk where this parameter is\nlocated. Can be the name of one of the disks specified in the\nResources field, or \"boot\", which represents the Docker\ninstance's boot disk and has a mount point of `/`.",
+ "type": "string"
},
+ "path": {
+ "type": "string",
+ "description": "Required. The path within the user's docker container where\nthis input should be localized to and from, relative to the specified\ndisk's mount point. For example: file.txt,"
+ }
+ },
+ "id": "LocalCopy"
+ },
+ "DockerExecutor": {
+ "description": "The Docker execuctor specification.",
+ "type": "object",
+ "properties": {
+ "cmd": {
+ "type": "string",
+ "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."
+ },
+ "imageName": {
+ "type": "string",
+ "description": "Required. Image name from either Docker Hub or Google Container Registry.\nUsers that run pipelines must have READ access to the image."
+ }
+ },
+ "id": "DockerExecutor"
+ },
+ "Disk": {
+ "type": "object",
+ "properties": {
+ "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": {
+ "type": "boolean",
+ "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."
+ },
+ "sizeGb": {
+ "description": "The size of the disk. Defaults to 500 (GB).\nThis field is not applicable for local SSD.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "mountPoint": {
+ "description": "Required at create time and cannot be overridden at run time.\nSpecifies the path in the docker container where files on\nthis disk should be located. For example, if `mountPoint`\nis `/mnt/disk`, and the parameter has `localPath`\n`inputs/file.txt`, the docker container can access the data at\n`/mnt/disk/inputs/file.txt`.",
+ "type": "string"
+ },
+ "readOnly": {
+ "description": "Specifies how a sourced-base persistent disk will be mounted. See\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances\nfor more details.\nCan only be set at create time.",
+ "type": "boolean"
+ },
+ "source": {
+ "description": "The full or partial URL of the persistent disk to attach. See\nhttps://cloud.google.com/compute/docs/reference/latest/instances#resource\nand\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#snapshots\nfor more details.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Required. The name of the disk that can be used in the pipeline\nparameters. Must be 1 - 63 characters.\nThe name \"boot\" is reserved for system use.",
+ "type": "string"
+ }
+ },
+ "id": "Disk",
+ "description": "A Google Compute Engine disk resource specification."
+ },
+ "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"
+ },
+ "PipelineParameter": {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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": {
+ "type": "string",
+ "description": "Human-readable description."
+ }
+ },
+ "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."
+ },
+ "LoggingOptions": {
+ "type": "object",
+ "properties": {
+ "gcsPath": {
+ "type": "string",
+ "description": "The location in Google Cloud Storage to which the pipeline logs\nwill be copied. Can be specified as a fully qualified directory\npath, in which case logs will be output with a unique identifier\nas the filename in that directory, or as a fully specified path,\nwhich must end in `.log`, in which case that path will be\nused, and the user must ensure that logs are not\noverwritten. Stdout and stderr logs from the run are also\ngenerated and output as `-stdout.log` and `-stderr.log`."
+ }
+ },
+ "id": "LoggingOptions",
+ "description": "The logging options for the pipeline run."
+ },
+ "RunPipelineRequest": {
+ "type": "object",
+ "properties": {
"pipelineId": {
"description": "The already created pipeline to run.",
"type": "string"
@@ -402,9 +562,14 @@
"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"
+ "id": "RunPipelineRequest",
+ "description": "The request to run a pipeline. If `pipelineId` is specified, it\nrefers to a saved pipeline created with CreatePipeline and set as\nthe `pipelineId` of the returned Pipeline object. If\n`ephemeralPipeline` is specified, that pipeline is run once\nwith the given args and not saved. It is an error to specify both\n`pipelineId` and `ephemeralPipeline`. `pipelineArgs`\nmust be specified."
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
@@ -412,6 +577,41 @@
"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": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "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": {
+ "type": "string",
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "description": "An OperationMetadata object. This will always be returned with the Operation."
+ },
+ "done": {
+ "type": "boolean",
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable."
+ }
+ },
+ "id": "Operation"
+ },
"RuntimeMetadata": {
"description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
"type": "object",
@@ -423,84 +623,48 @@
},
"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": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an Empty response is returned.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`",
- "type": "string"
- },
- "error": {
- "$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": "An OperationMetadata object. This will always be returned with the Operation."
- }
- },
- "id": "Operation"
- },
"ImportReadGroupSetsResponse": {
- "description": "The read group set import response.",
"type": "object",
"properties": {
"readGroupSetIds": {
- "description": "IDs of the read group sets that were created.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "IDs of the read group sets that were created."
}
},
- "id": "ImportReadGroupSetsResponse"
+ "id": "ImportReadGroupSetsResponse",
+ "description": "The read group set import response."
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
"code": {
+ "type": "integer",
"description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"message": {
- "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"
},
"details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
+ "type": "object",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
- },
- "type": "object"
- }
+ }
+ },
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
}
},
"id": "Status"
},
"ServiceAccount": {
- "description": "A Google Cloud Service Account.",
"type": "object",
"properties": {
"email": {
@@ -508,32 +672,40 @@
"type": "string"
},
"scopes": {
+ "description": "List of scopes to be enabled for this service account on the VM.\nThe following scopes are automatically included:\n\n* https://www.googleapis.com/auth/compute\n* https://www.googleapis.com/auth/devstorage.full_control\n* https://www.googleapis.com/auth/genomics\n* https://www.googleapis.com/auth/logging.write\n* https://www.googleapis.com/auth/monitoring.write",
"type": "array",
"items": {
"type": "string"
- },
- "description": "List of scopes to be enabled for this service account on the VM.\nThe following scopes are automatically included:\n\n* https://www.googleapis.com/auth/compute\n* https://www.googleapis.com/auth/devstorage.full_control\n* https://www.googleapis.com/auth/genomics\n* https://www.googleapis.com/auth/logging.write\n* https://www.googleapis.com/auth/monitoring.write"
+ }
}
},
- "id": "ServiceAccount"
+ "id": "ServiceAccount",
+ "description": "A Google Cloud Service Account."
},
"PipelineResources": {
"description": "The system resources for the pipeline run.",
"type": "object",
"properties": {
- "bootDiskSizeGb": {
- "description": "The size of the boot disk. Defaults to 10 (GB).",
- "format": "int32",
- "type": "integer"
+ "disks": {
+ "description": "Disks to attach.",
+ "type": "array",
+ "items": {
+ "$ref": "Disk"
+ }
},
- "minimumRamGb": {
- "description": "The minimum amount of RAM to use. Defaults to 3.75 (GB)",
- "format": "double",
- "type": "number"
+ "bootDiskSizeGb": {
+ "type": "integer",
+ "description": "The size of the boot disk. Defaults to 10 (GB).",
+ "format": "int32"
},
"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"
+ "type": "boolean",
+ "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."
+ },
+ "minimumRamGb": {
+ "type": "number",
+ "description": "The minimum amount of RAM to use. Defaults to 3.75 (GB)",
+ "format": "double"
},
"zones": {
"description": "List of Google Compute Engine availability zones to which resource\ncreation will restricted. If empty, any zone may be chosen.",
@@ -542,38 +714,46 @@
"type": "string"
}
},
- "acceleratorCount": {
- "description": "Optional. The number of accelerators of the specified type to attach.\nBy specifying this parameter, you will download and install the following\nthird-party software onto your managed Compute Engine instances:\nNVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit.",
- "format": "int64",
- "type": "string"
- },
- "acceleratorType": {
- "description": "Optional. The Compute Engine defined accelerator type.\nBy specifying this parameter, you will download and install the following\nthird-party software onto your managed Compute Engine instances: NVIDIA®\nTesla® drivers and NVIDIA® CUDA toolkit.\nPlease see https://cloud.google.com/compute/docs/gpus/ for a list of\navailable accelerator types.",
- "type": "string"
- },
"minimumCpuCores": {
"description": "The minimum number of cores to use. Defaults to 1.",
"format": "int32",
"type": "integer"
},
- "noAddress": {
- "description": "Whether to assign an external IP to the instance. This is an experimental\nfeature that may go away. Defaults to false.\nCorresponds to `--no_address` flag for [gcloud compute instances create]\n(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create).\nIn order to use this, must be true for both create time and run time.\nCannot be true at run time if false at create time. If you need to ssh into\na private IP VM for debugging, you can ssh to a public VM and then ssh into\nthe private VM's Internal IP. If noAddress is set, this pipeline run may\nonly load docker images from Google Container Registry and not Docker Hub.\nBefore using this, you must\n[configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).",
- "type": "boolean"
+ "acceleratorType": {
+ "type": "string",
+ "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."
},
- "disks": {
- "description": "Disks to attach.",
- "type": "array",
- "items": {
- "$ref": "Disk"
- }
+ "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"
+ },
+ "noAddress": {
+ "type": "boolean",
+ "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)."
}
},
"id": "PipelineResources"
},
"Pipeline": {
- "description": "The pipeline object. Represents a transformation from a set of input\nparameters to a set of output parameters. The transformation is defined\nas a docker image and command to run within that image. Each pipeline\nis run on a Google Compute Engine VM. A pipeline can be created with the\n`create` method and then later run with the `run` method, or a pipeline can\nbe defined and run all at once with the `run` method.",
"type": "object",
"properties": {
+ "resources": {
+ "$ref": "PipelineResources",
+ "description": "Required. Specifies resource requirements for the pipeline run.\nRequired fields:\n\n*\nminimumCpuCores\n\n*\nminimumRamGb"
+ },
+ "name": {
+ "description": "Required. A user specified pipeline name that does not have to be unique.\nThis name can be used for filtering Pipelines in ListPipelines.",
+ "type": "string"
+ },
+ "pipelineId": {
+ "type": "string",
+ "description": "Unique pipeline id that is generated by the service when CreatePipeline\nis called. Cannot be specified in the Pipeline used in the\nCreatePipelineRequest, and will be populated in the response to\nCreatePipeline and all subsequent Get and List calls. Indicates that the\nservice has registered this pipeline."
+ },
+ "projectId": {
+ "description": "Required. The project in which to create the pipeline. The caller must have\nWRITE access.",
+ "type": "string"
+ },
"outputParameters": {
"description": "Output parameters of the pipeline.",
"type": "array",
@@ -581,70 +761,33 @@
"$ref": "PipelineParameter"
}
},
- "docker": {
- "description": "Specifies the docker run information.",
- "$ref": "DockerExecutor"
- },
"description": {
- "type": "string",
- "description": "User-specified description."
+ "description": "User-specified description.",
+ "type": "string"
+ },
+ "docker": {
+ "$ref": "DockerExecutor",
+ "description": "Specifies the docker run information."
},
"inputParameters": {
- "description": "Input parameters of the pipeline.",
"type": "array",
"items": {
"$ref": "PipelineParameter"
- }
- },
- "resources": {
- "description": "Required. Specifies resource requirements for the pipeline run.\nRequired fields:\n\n*\nminimumCpuCores\n\n*\nminimumRamGb",
- "$ref": "PipelineResources"
- },
- "name": {
- "description": "Required. A user specified pipeline name that does not have to be unique.\nThis name can be used for filtering Pipelines in ListPipelines.",
- "type": "string"
- },
- "pipelineId": {
- "description": "Unique pipeline id that is generated by the service when CreatePipeline\nis called. Cannot be specified in the Pipeline used in the\nCreatePipelineRequest, and will be populated in the response to\nCreatePipeline and all subsequent Get and List calls. Indicates that the\nservice has registered this pipeline.",
- "type": "string"
- },
- "projectId": {
- "description": "Required. The project in which to create the pipeline. The caller must have\nWRITE access.",
- "type": "string"
+ },
+ "description": "Input parameters of the pipeline."
}
},
- "id": "Pipeline"
- },
- "OperationEvent": {
- "description": "An event that occurred during an Operation.",
- "type": "object",
- "properties": {
- "endTime": {
- "type": "string",
- "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"
- },
- "startTime": {
- "description": "Optional time of when event started.",
- "format": "google-datetime",
- "type": "string"
- },
- "description": {
- "description": "Required description of event.",
- "type": "string"
- }
- },
- "id": "OperationEvent"
+ "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."
},
"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"
- }
+ },
+ "type": "object"
},
"image": {
"type": "string"
@@ -665,10 +808,10 @@
"type": "object"
},
"disks": {
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "type": "object"
+ }
},
"machineType": {
"type": "string"
@@ -677,28 +820,31 @@
"type": "string"
}
},
- "id": "ControllerConfig"
+ "id": "ControllerConfig",
+ "description": "Stores the information that the controller will fetch from the\nserver in order to run. Should only be used by VMs created by the\nPipelines Service and not by end users."
},
- "ListOperationsResponse": {
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
+ "OperationEvent": {
+ "description": "An event that occurred during an Operation.",
"type": "object",
"properties": {
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
+ "endTime": {
+ "type": "string",
+ "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"
},
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
+ "startTime": {
+ "type": "string",
+ "description": "Optional time of when event started.",
+ "format": "google-datetime"
+ },
+ "description": {
+ "type": "string",
+ "description": "Required description of event."
}
- }
+ },
+ "id": "OperationEvent"
},
"RepeatedString": {
- "id": "RepeatedString",
"type": "object",
"properties": {
"values": {
@@ -707,44 +853,38 @@
"type": "string"
}
}
- }
+ },
+ "id": "RepeatedString"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "The standard List next-page token."
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ }
+ },
+ "id": "ListOperationsResponse"
},
"OperationMetadata": {
"description": "Metadata describing an Operation.",
"type": "object",
"properties": {
- "runtimeMetadata": {
- "description": "Runtime metadata on this Operation.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
- "type": "object"
- },
- "createTime": {
- "description": "The time at which the job was submitted to the Genomics service.",
- "format": "google-datetime",
- "type": "string"
- },
"projectId": {
- "description": "The Google Cloud Project in which the job is scoped.",
- "type": "string"
+ "type": "string",
+ "description": "The Google Cloud Project in which the job is scoped."
},
"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"
+ "type": "string",
+ "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation."
},
"events": {
"type": "array",
@@ -753,18 +893,43 @@
},
"description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export."
},
+ "endTime": {
+ "type": "string",
+ "description": "The time at which the job stopped running.",
+ "format": "google-datetime"
+ },
"startTime": {
"description": "The time at which the job began to run.",
"format": "google-datetime",
"type": "string"
},
"request": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
"description": "The original request that started the operation. 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",
+ "type": "object"
+ },
+ "runtimeMetadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "Runtime metadata on this Operation.",
+ "type": "object"
+ },
+ "createTime": {
+ "type": "string",
+ "description": "The time at which the job was submitted to the Genomics service.",
+ "format": "google-datetime"
+ },
+ "labels": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optionally provided by the caller when submitting the request that creates\nthe operation."
}
},
"id": "OperationMetadata"
@@ -774,15 +939,15 @@
"type": "object",
"properties": {
"nextPageToken": {
- "description": "The token to use to get the next page of results.",
- "type": "string"
+ "type": "string",
+ "description": "The token to use to get the next page of results."
},
"pipelines": {
- "description": "The matched pipelines.",
"type": "array",
"items": {
"$ref": "Pipeline"
- }
+ },
+ "description": "The matched pipelines."
}
},
"id": "ListPipelinesResponse"
@@ -791,40 +956,14 @@
"description": "The pipeline run arguments.",
"type": "object",
"properties": {
- "clientId": {
- "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": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Pipeline input arguments; keys are defined in the pipeline documentation.\nAll input parameters that do not have default values must be specified.\nIf parameters with defaults are specified here, the defaults will be\noverridden."
- },
- "labels": {
- "description": "Labels to apply to this pipeline run. Labels will also be applied to\ncompute resources (VM, disks) created by this pipeline run. When listing\noperations, operations can filtered by labels.\nLabel keys may not be empty; label values may be empty. Non-empty labels\nmust be 1-63 characters long, and comply with [RFC1035]\n(https://www.ietf.org/rfc/rfc1035.txt).\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "logging": {
- "$ref": "LoggingOptions",
- "description": "Required. Logging options. Used by the service to communicate results\nto the user."
- },
"keepVmAliveOnFailureDuration": {
"description": "How long to keep the VM up after a failure (for example docker command\nfailed, copying input or output files failed, etc). While the VM is up, one\ncan ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.",
"format": "google-duration",
"type": "string"
},
"resources": {
- "description": "Specifies resource requirements/overrides for the pipeline run.",
- "$ref": "PipelineResources"
+ "$ref": "PipelineResources",
+ "description": "Specifies resource requirements/overrides for the pipeline run."
},
"outputs": {
"additionalProperties": {
@@ -834,16 +973,47 @@
"type": "object"
},
"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"
+ "type": "string",
+ "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."
+ },
+ "clientId": {
+ "type": "string",
+ "description": "This field is deprecated. Use `labels` instead. Client-specified pipeline\noperation identifier."
+ },
+ "serviceAccount": {
+ "$ref": "ServiceAccount",
+ "description": "The Google Cloud Service Account that will be used to access data and\nservices. By default, the compute service account associated with\n`projectId` is used."
+ },
+ "inputs": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Pipeline input arguments; keys are defined in the pipeline documentation.\nAll input parameters that do not have default values must be specified.\nIf parameters with defaults are specified here, the defaults will be\noverridden.",
+ "type": "object"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels to apply to this pipeline run. Labels will also be applied to\ncompute resources (VM, disks) created by this pipeline run. When listing\noperations, operations can filtered by labels.\nLabel keys may not be empty; label values may be empty. Non-empty labels\nmust be 1-63 characters long, and comply with [RFC1035]\n(https://www.ietf.org/rfc/rfc1035.txt).\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
+ "type": "object"
+ },
+ "logging": {
+ "$ref": "LoggingOptions",
+ "description": "Required. Logging options. Used by the service to communicate results\nto the user."
}
},
"id": "RunPipelineArgs"
},
"SetOperationStatusRequest": {
- "description": "Request to set operation status. Should only be used by VMs\ncreated by the Pipelines Service and not by end users.",
"type": "object",
"properties": {
+ "timestampEvents": {
+ "type": "array",
+ "items": {
+ "$ref": "TimestampEvent"
+ }
+ },
"operationId": {
"type": "string"
},
@@ -894,178 +1064,10 @@
"UNAVAILABLE",
"DATA_LOSS"
]
- },
- "timestampEvents": {
- "type": "array",
- "items": {
- "$ref": "TimestampEvent"
- }
}
},
- "id": "SetOperationStatusRequest"
- },
- "ComputeEngine": {
- "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
- "type": "object",
- "properties": {
- "machineType": {
- "description": "The machine type of the instance.",
- "type": "string"
- },
- "diskNames": {
- "description": "The names of the disks that were created for this pipeline.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "instanceName": {
- "description": "The instance on which the operation is running.",
- "type": "string"
- },
- "zone": {
- "description": "The availability zone in which the instance resides.",
- "type": "string"
- }
- },
- "id": "ComputeEngine"
- },
- "ImportVariantsResponse": {
- "description": "The variant data import response.",
- "type": "object",
- "properties": {
- "callSetIds": {
- "description": "IDs of the call sets created during the import.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ImportVariantsResponse"
- },
- "TimestampEvent": {
- "description": "Stores the list of events and times they occured for major events in job\nexecution.",
- "type": "object",
- "properties": {
- "description": {
- "description": "String indicating the type of event",
- "type": "string"
- },
- "timestamp": {
- "description": "The time this event occured.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "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 `/`.",
- "type": "string"
- },
- "path": {
- "description": "Required. The path within the user's docker container where\nthis input should be localized to and from, relative to the specified\ndisk's mount point. For example: file.txt,",
- "type": "string"
- }
- },
- "id": "LocalCopy"
- },
- "DockerExecutor": {
- "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"
- }
- },
- "id": "DockerExecutor",
- "description": "The Docker execuctor specification.",
- "type": "object"
- },
- "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": {}
- },
- "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": {
- "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"
- },
- "autoDelete": {
- "description": "Deprecated. Disks created by the Pipelines API will be deleted at the end\nof the pipeline run, regardless of what this field is set to.",
- "type": "boolean"
- },
- "sizeGb": {
- "type": "integer",
- "description": "The size of the disk. Defaults to 500 (GB).\nThis field is not applicable for local SSD.",
- "format": "int32"
- },
- "mountPoint": {
- "description": "Required at create time and cannot be overridden at run time.\nSpecifies the path in the docker container where files on\nthis disk should be located. For example, if `mountPoint`\nis `/mnt/disk`, and the parameter has `localPath`\n`inputs/file.txt`, the docker container can access the data at\n`/mnt/disk/inputs/file.txt`.",
- "type": "string"
- },
- "readOnly": {
- "type": "boolean",
- "description": "Specifies how a sourced-base persistent disk will be mounted. See\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances\nfor more details.\nCan only be set at create time."
- },
- "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"
- }
- },
- "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": {
- "defaultValue": {
- "description": "The default value for this parameter. Can be overridden at runtime.\nIf `localCopy` is present, then this must be a Google Cloud Storage path\nbeginning with `gs://`.",
- "type": "string"
- },
- "name": {
- "description": "Required. Name of the parameter - the pipeline runner uses this string\nas the key to the input and output maps in RunPipeline.",
- "type": "string"
- },
- "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"
+ "id": "SetOperationStatusRequest",
+ "description": "Request to set operation status. Should only be used by VMs\ncreated by the Pipelines Service and not by end users."
}
},
"icons": {
@@ -1090,10 +1092,8 @@
}
}
},
- "servicePath": "",
- "description": "Upload, process, query, and search Genomics data in the cloud.",
"kind": "discovery#restDescription",
- "rootUrl": "https://genomics.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com"
+ "description": "Upload, process, query, and search Genomics data in the cloud.",
+ "servicePath": "",
+ "rootUrl": "https://genomics.googleapis.com/"
}
diff --git a/gmail/v1/gmail-api.json b/gmail/v1/gmail-api.json
index d6bafaf..b88cf02 100644
--- a/gmail/v1/gmail-api.json
+++ b/gmail/v1/gmail-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/yLmXjwrCZrd7tYs9N17TGZKIRRE\"",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/I3MPWRx_y8dp4vc05XZkrZnF0UM\"",
"discoveryVersion": "v1",
"id": "gmail:v1",
"name": "gmail",
"version": "v1",
- "revision": "20170913",
+ "revision": "20180123",
"title": "Gmail API",
"description": "Access Gmail mailboxes including sending user email.",
"ownerDomain": "google.com",
@@ -457,6 +457,10 @@
"type": "object",
"description": "Labels are used to categorize messages and threads within the user's mailbox.",
"properties": {
+ "color": {
+ "$ref": "LabelColor",
+ "description": "The Color to assign to the label. Only available for labels with type User. Will not be set if the label doesn't have both a text_color and background_color configured."
+ },
"id": {
"type": "string",
"description": "The immutable ID of the label.",
@@ -548,6 +552,20 @@
}
}
},
+ "LabelColor": {
+ "id": "LabelColor",
+ "type": "object",
+ "properties": {
+ "backgroundColor": {
+ "type": "string",
+ "description": "The background color represented as hex string #RRGGBB (ex #000000). Only a restricted predefined set of color values are allowed. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c"
+ },
+ "textColor": {
+ "type": "string",
+ "description": "The text color of the label, represented as hex string. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c"
+ }
+ }
+ },
"ListDraftsResponse": {
"id": "ListDraftsResponse",
"type": "object",
diff --git a/gmail/v1/gmail-gen.go b/gmail/v1/gmail-gen.go
index 4a22964..ff3a804 100644
--- a/gmail/v1/gmail-gen.go
+++ b/gmail/v1/gmail-gen.go
@@ -789,6 +789,11 @@
// Label: Labels are used to categorize messages and threads within the
// user's mailbox.
type Label struct {
+ // Color: The Color to assign to the label. Only available for labels
+ // with type User. Will not be set if the label doesn't have both a
+ // text_color and background_color configured.
+ Color *LabelColor `json:"color,omitempty"`
+
// Id: The immutable ID of the label.
Id string `json:"id,omitempty"`
@@ -843,7 +848,7 @@
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "Id") to
+ // ForceSendFields is a list of field names (e.g. "Color") 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
@@ -851,7 +856,7 @@
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Id") to include in API
+ // NullFields is a list of field names (e.g. "Color") 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
@@ -866,6 +871,60 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type LabelColor struct {
+ // BackgroundColor: The background color represented as hex string
+ // #RRGGBB (ex #000000). Only a restricted predefined set of color
+ // values are allowed. Only the following predefined set of color values
+ // are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef,
+ // #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692,
+ // #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0,
+ // #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3,
+ // #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b,
+ // #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21,
+ // #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
+ // #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b,
+ // #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587,
+ // #41236d, #83334c
+ BackgroundColor string `json:"backgroundColor,omitempty"`
+
+ // TextColor: The text color of the label, represented as hex string.
+ // Only the following predefined set of color values are allowed:
+ // #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3,
+ // #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8,
+ // #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de,
+ // #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2,
+ // #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83,
+ // #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041,
+ // #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16,
+ // #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
+ // #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d,
+ // #83334c
+ TextColor string `json:"textColor,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "BackgroundColor") 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. "BackgroundColor") 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 *LabelColor) MarshalJSON() ([]byte, error) {
+ type NoMethod LabelColor
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type ListDraftsResponse struct {
// Drafts: List of drafts.
Drafts []*Draft `json:"drafts,omitempty"`
diff --git a/iam/v1/iam-api.json b/iam/v1/iam-api.json
index 3e36e75..71e6221 100644
--- a/iam/v1/iam-api.json
+++ b/iam/v1/iam-api.json
@@ -1,426 +1,11 @@
{
+ "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"
- },
- "CreateServiceAccountKeyRequest": {
- "description": "The service account key create request.",
- "type": "object",
- "properties": {
- "privateKeyType": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "TYPE_PKCS12_FILE",
- "TYPE_GOOGLE_CREDENTIALS_FILE"
- ],
- "description": "The output format of the private key. The default value is\n`TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File\nformat.",
- "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."
- ]
- },
- "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"
- },
- "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": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
- "type": "object",
- "properties": {
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- },
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Deprecated.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Policy"
- },
- "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": {
- "description": "Policy delta between the original policy and the newly set policy.",
- "$ref": "PolicyDelta"
- }
- },
- "id": "AuditData"
- },
- "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": {
- "enumDescriptions": [
- "Unspecified.",
- "Addition of a Binding.",
- "Removal of a Binding."
- ],
- "enum": [
- "ACTION_UNSPECIFIED",
- "ADD",
- "REMOVE"
- ],
- "description": "The action that was performed on a Binding.\nRequired",
- "type": "string"
- },
- "member": {
- "description": "A single identity requesting access for a Cloud Platform resource.\nFollows the same format of Binding.members.\nRequired",
- "type": "string"
- }
- },
- "id": "BindingDelta"
- },
- "QueryAuditableServicesRequest": {
- "description": "A request to get the list of auditable services for a resource.",
- "type": "object",
- "properties": {
- "fullResourceName": {
- "description": "Required. The full resource name to query from the list of auditable\nservices.\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": "QueryAuditableServicesRequest"
- },
- "UndeleteRoleRequest": {
- "properties": {
- "etag": {
- "description": "Used to perform a consistent read-modify-write.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "UndeleteRoleRequest",
- "description": "The request to undelete an existing role.",
- "type": "object"
- },
- "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"
- },
- "Role": {
- "description": "A role in the Identity and Access Management API.",
- "type": "object",
- "properties": {
- "includedPermissions": {
- "description": "The names of the permissions this role grants when bound in an IAM policy.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "description": {
- "description": "Optional. A human-readable description for the role.",
- "type": "string"
- },
- "etag": {
- "description": "Used to perform a consistent read-modify-write.",
- "format": "byte",
- "type": "string"
- },
- "stage": {
- "enumDescriptions": [
- "The user has indicated this role is currently in an alpha phase.",
- "The user has indicated this role is currently in a beta phase.",
- "The user has indicated this role is generally available.",
- "The user has indicated this role is being deprecated.",
- "This role is disabled and will not contribute permissions to any members\nit is granted to in policies.",
- "The user has indicated this role is currently in an eap phase."
- ],
- "enum": [
- "ALPHA",
- "BETA",
- "GA",
- "DEPRECATED",
- "DISABLED",
- "EAP"
- ],
- "description": "The current launch stage of the role.",
- "type": "string"
- },
- "name": {
- "description": "The name of the role.\n\nWhen Role is used in CreateRole, the role name must not be set.\n\nWhen Role is used in output and other input such as UpdateRole, the role\nname is the complete path, e.g., roles/logging.viewer for curated roles\nand organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.",
- "type": "string"
- },
- "deleted": {
- "description": "The current deleted state of the role. This field is read only.\nIt will be ignored in calls to CreateRole and UpdateRole.",
- "type": "boolean"
- },
- "title": {
- "description": "Optional. A human-readable title for the role. Typically this\nis limited to 100 UTF-8 bytes.",
- "type": "string"
- }
- },
- "id": "Role"
- },
- "QueryAuditableServicesResponse": {
- "description": "A response containing a list of auditable services for a resource.",
- "type": "object",
- "properties": {
- "services": {
- "description": "The auditable services for a resource.",
- "type": "array",
- "items": {
- "$ref": "AuditableService"
- }
- }
- },
- "id": "QueryAuditableServicesResponse"
- },
- "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"
- },
- "QueryGrantableRolesRequest": {
- "description": "The grantable role query request.",
- "type": "object",
- "properties": {
- "fullResourceName": {
- "description": "Required. The full resource name to query from the list of grantable roles.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
- "type": "string"
- },
- "pageToken": {
- "description": "Optional pagination token returned in an earlier\nQueryGrantableRolesResponse.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional limit on the number of roles to include in the response.",
- "format": "int32",
- "type": "integer"
- },
- "view": {
- "enum": [
- "BASIC",
- "FULL"
- ],
- "type": "string",
- "enumDescriptions": [
- "Omits the `included_permissions` field.\nThis is the default value.",
- "Returns all fields."
- ]
- }
- },
- "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"
- },
- "uniqueId": {
- "description": "@OutputOnly The unique and stable id of the service account.",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "@OutputOnly The OAuth2 client id for the service account.\nThis is used in conjunction with the OAuth2 clientconfig API to make\nthree legged OAuth2 (3LO) flows to access the data of Google users.",
- "type": "string"
- },
- "displayName": {
- "description": "Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.",
- "type": "string"
- },
- "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.",
- "type": "object",
- "properties": {
- "roleId": {
- "description": "The role id to use for this role.",
- "type": "string"
- },
- "role": {
- "$ref": "Role",
- "description": "The Role resource to create."
- }
- },
- "id": "CreateRoleRequest"
- },
- "QueryTestablePermissionsRequest": {
- "description": "A request to get permissions which can be tested on a resource.",
- "type": "object",
- "properties": {
- "fullResourceName": {
- "description": "Required. The full resource name to query from the list of testable\npermissions.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
- "type": "string"
- },
- "pageToken": {
- "description": "Optional pagination token returned in an earlier\nQueryTestablePermissionsRequest.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional limit on the number of permissions to include in the response.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "QueryTestablePermissionsRequest"
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "ListServiceAccountKeysResponse": {
- "description": "The service account keys list response.",
- "type": "object",
- "properties": {
- "keys": {
- "description": "The public keys for the service account.",
- "type": "array",
- "items": {
- "$ref": "ServiceAccountKey"
- }
- }
- },
- "id": "ListServiceAccountKeysResponse"
- },
"ServiceAccountKey": {
"description": "Represents a service account key.\n\nA service account has two sets of key-pairs: user-managed, and\nsystem-managed.\n\nUser-managed key-pairs can be created and deleted by users. Users are\nresponsible for rotating these keys periodically to ensure security of\ntheir service accounts. Users retain the private key of these key-pairs,\nand Google retains ONLY the public key.\n\nSystem-managed key-pairs are managed automatically by Google, and rotated\ndaily without user intervention. The private key never leaves Google's\nservers to maximize security.\n\nPublic keys for all service accounts are also published at the OAuth2\nService Account API.",
"type": "object",
"properties": {
- "privateKeyData": {
- "description": "The private key data. Only provided in `CreateServiceAccountKey`\nresponses. Make sure to keep the private key data secure because it\nallows for the assertion of the service account identity.\nWhen decoded, the private key data can be used to authenticate with\nGoogle API client libraries and with\n\u003ca href=\"/sdk/gcloud/reference/auth/activate-service-account\"\u003egcloud\nauth activate-service-account\u003c/a\u003e.",
- "format": "byte",
- "type": "string"
- },
- "publicKeyData": {
- "description": "The public key data. Only provided in `GetServiceAccountKey` responses.",
- "format": "byte",
- "type": "string"
- },
"name": {
"description": "The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.",
"type": "string"
@@ -431,42 +16,54 @@
"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",
- "enumDescriptions": [
- "An unspecified key algorithm.",
- "1k RSA Key.",
- "2k RSA Key."
- ]
+ "type": "string"
+ },
+ "validAfterTime": {
+ "description": "The key can be used after this timestamp.",
+ "format": "google-datetime",
+ "type": "string"
},
"privateKeyType": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TYPE_PKCS12_FILE",
+ "TYPE_GOOGLE_CREDENTIALS_FILE"
+ ],
"description": "The output format for the private key.\nOnly provided in `CreateServiceAccountKey` responses, not\nin `GetServiceAccountKey` or `ListServiceAccountKey` responses.\n\nGoogle never exposes system-managed private keys, and never retains\nuser-managed private keys.",
"type": "string",
"enumDescriptions": [
"Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
"PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.",
"Google Credentials File format."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "TYPE_PKCS12_FILE",
- "TYPE_GOOGLE_CREDENTIALS_FILE"
]
},
- "validAfterTime": {
- "description": "The key can be used after this timestamp.",
- "format": "google-datetime",
+ "privateKeyData": {
+ "description": "The private key data. Only provided in `CreateServiceAccountKey`\nresponses. Make sure to keep the private key data secure because it\nallows for the assertion of the service account identity.\nWhen decoded, the private key data can be used to authenticate with\nGoogle API client libraries and with\n\u003ca href=\"/sdk/gcloud/reference/auth/activate-service-account\"\u003egcloud\nauth activate-service-account\u003c/a\u003e.",
+ "format": "byte",
+ "type": "string"
+ },
+ "publicKeyData": {
+ "description": "The public key data. Only provided in `GetServiceAccountKey` responses.",
+ "format": "byte",
"type": "string"
}
},
"id": "ServiceAccountKey"
},
"SignBlobResponse": {
+ "description": "The service account sign blob response.",
+ "type": "object",
"properties": {
"signature": {
"description": "The signed blob.",
@@ -478,66 +75,7 @@
"type": "string"
}
},
- "id": "SignBlobResponse",
- "description": "The service account sign blob response.",
- "type": "object"
- },
- "Permission": {
- "description": "A permission which can be included by a role.",
- "type": "object",
- "properties": {
- "onlyInPredefinedRoles": {
- "description": "This permission can ONLY be used in predefined roles.",
- "type": "boolean"
- },
- "title": {
- "description": "The title of this Permission.",
- "type": "string"
- },
- "description": {
- "description": "A brief description of what this Permission is used for.",
- "type": "string"
- },
- "customRolesSupportLevel": {
- "enum": [
- "SUPPORTED",
- "TESTING",
- "NOT_SUPPORTED"
- ],
- "description": "The current custom role support level.",
- "type": "string",
- "enumDescriptions": [
- "Permission is fully supported for custom role use.",
- "Permission is being tested to check custom role compatibility.",
- "Permission is not supported for custom role use."
- ]
- },
- "apiDisabled": {
- "description": "The service API associated with the permission is not enabled.",
- "type": "boolean"
- },
- "stage": {
- "enumDescriptions": [
- "The permission is currently in an alpha phase.",
- "The permission is currently in a beta phase.",
- "The permission is generally available.",
- "The permission is being deprecated."
- ],
- "enum": [
- "ALPHA",
- "BETA",
- "GA",
- "DEPRECATED"
- ],
- "description": "The current launch stage of the permission.",
- "type": "string"
- },
- "name": {
- "description": "The name of this Permission.",
- "type": "string"
- }
- },
- "id": "Permission"
+ "id": "SignBlobResponse"
},
"SignJwtRequest": {
"description": "The service account sign JWT request.",
@@ -550,10 +88,76 @@
},
"id": "SignJwtRequest"
},
- "PolicyDelta": {
- "description": "The difference delta between two policies.",
+ "Permission": {
+ "description": "A permission which can be included by a role.",
"type": "object",
"properties": {
+ "description": {
+ "description": "A brief description of what this Permission is used for.",
+ "type": "string"
+ },
+ "customRolesSupportLevel": {
+ "enumDescriptions": [
+ "Permission is fully supported for custom role use.",
+ "Permission is being tested to check custom role compatibility.",
+ "Permission is not supported for custom role use."
+ ],
+ "enum": [
+ "SUPPORTED",
+ "TESTING",
+ "NOT_SUPPORTED"
+ ],
+ "description": "The current custom role support level.",
+ "type": "string"
+ },
+ "apiDisabled": {
+ "description": "The service API associated with the permission is not enabled.",
+ "type": "boolean"
+ },
+ "stage": {
+ "enum": [
+ "ALPHA",
+ "BETA",
+ "GA",
+ "DEPRECATED"
+ ],
+ "description": "The current launch stage of the permission.",
+ "type": "string",
+ "enumDescriptions": [
+ "The permission is currently in an alpha phase.",
+ "The permission is currently in a beta phase.",
+ "The permission is generally available.",
+ "The permission is being deprecated."
+ ]
+ },
+ "name": {
+ "description": "The name of this Permission.",
+ "type": "string"
+ },
+ "onlyInPredefinedRoles": {
+ "description": "This permission can ONLY be used in predefined roles.",
+ "type": "boolean"
+ },
+ "title": {
+ "description": "The title of this Permission.",
+ "type": "string"
+ }
+ },
+ "id": "Permission"
+ },
+ "AuditableService": {
+ "description": "Contains information about an auditable service.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Public name of the service.\nFor example, the service name for Cloud IAM is 'iam.googleapis.com'.",
+ "type": "string"
+ }
+ },
+ "id": "AuditableService"
+ },
+ "PolicyDelta": {
+ "properties": {
"bindingDeltas": {
"description": "The delta for Bindings between two policies.",
"type": "array",
@@ -562,17 +166,8 @@
}
}
},
- "id": "PolicyDelta"
- },
- "AuditableService": {
- "properties": {
- "name": {
- "description": "Public name of the service.\nFor example, the service name for Cloud IAM is 'iam.googleapis.com'.",
- "type": "string"
- }
- },
- "id": "AuditableService",
- "description": "Contains information about an auditable service.",
+ "id": "PolicyDelta",
+ "description": "The difference delta between two policies.",
"type": "object"
},
"ListServiceAccountsResponse": {
@@ -651,12 +246,419 @@
}
},
"id": "QueryTestablePermissionsResponse"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "CreateServiceAccountKeyRequest": {
+ "description": "The service account key create request.",
+ "type": "object",
+ "properties": {
+ "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. The default value is\n`TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File\nformat.",
+ "type": "string"
+ },
+ "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"
+ ]
+ }
+ },
+ "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": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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": {
+ "description": "One delta entry for Binding. Each individual change (only one member in each\nentry) to a binding will be a separate entry.",
+ "type": "object",
+ "properties": {
+ "action": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Addition of a Binding.",
+ "Removal of a Binding."
+ ],
+ "enum": [
+ "ACTION_UNSPECIFIED",
+ "ADD",
+ "REMOVE"
+ ],
+ "description": "The action that was performed on a Binding.\nRequired",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "BindingDelta"
+ },
+ "QueryAuditableServicesRequest": {
+ "properties": {
+ "fullResourceName": {
+ "description": "Required. The full resource name to query from the list of auditable\nservices.\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": "QueryAuditableServicesRequest",
+ "description": "A request to get the list of auditable services for a resource.",
+ "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": {
+ "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` ."
+ }
+ },
+ "id": "CreateServiceAccountRequest",
+ "description": "The service account create request.",
+ "type": "object"
+ },
+ "Role": {
+ "description": "A role in the Identity and Access Management API.",
+ "type": "object",
+ "properties": {
+ "includedPermissions": {
+ "description": "The names of the permissions this role grants when bound in an IAM policy.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "Optional. A human-readable description for the role.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "Used to perform a consistent read-modify-write.",
+ "format": "byte",
+ "type": "string"
+ },
+ "stage": {
+ "enumDescriptions": [
+ "The user has indicated this role is currently in an alpha phase.",
+ "The user has indicated this role is currently in a beta phase.",
+ "The user has indicated this role is generally available.",
+ "The user has indicated this role is being deprecated.",
+ "This role is disabled and will not contribute permissions to any members\nit is granted to in policies.",
+ "The user has indicated this role is currently in an eap phase."
+ ],
+ "enum": [
+ "ALPHA",
+ "BETA",
+ "GA",
+ "DEPRECATED",
+ "DISABLED",
+ "EAP"
+ ],
+ "description": "The current launch stage of the role.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the role.\n\nWhen Role is used in CreateRole, the role name must not be set.\n\nWhen Role is used in output and other input such as UpdateRole, the role\nname is the complete path, e.g., roles/logging.viewer for curated roles\nand organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.",
+ "type": "string"
+ },
+ "deleted": {
+ "description": "The current deleted state of the role. This field is read only.\nIt will be ignored in calls to CreateRole and UpdateRole.",
+ "type": "boolean"
+ },
+ "title": {
+ "description": "Optional. A human-readable title for the role. Typically this\nis limited to 100 UTF-8 bytes.",
+ "type": "string"
+ }
+ },
+ "id": "Role"
+ },
+ "QueryAuditableServicesResponse": {
+ "description": "A response containing a list of auditable services for a resource.",
+ "type": "object",
+ "properties": {
+ "services": {
+ "description": "The auditable services for a resource.",
+ "type": "array",
+ "items": {
+ "$ref": "AuditableService"
+ }
+ }
+ },
+ "id": "QueryAuditableServicesResponse"
+ },
+ "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"
+ },
+ "QueryGrantableRolesRequest": {
+ "description": "The grantable role query request.",
+ "type": "object",
+ "properties": {
+ "pageSize": {
+ "description": "Optional limit on the number of roles to include in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "view": {
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Omits the `included_permissions` field.\nThis is the default value.",
+ "Returns all fields."
+ ]
+ },
+ "fullResourceName": {
+ "description": "Required. The full resource name to query from the list of grantable roles.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Optional pagination token returned in an earlier\nQueryGrantableRolesResponse.",
+ "type": "string"
+ }
+ },
+ "id": "QueryGrantableRolesRequest"
+ },
+ "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": {
+ "etag": {
+ "description": "Used to perform a consistent read-modify-write.",
+ "format": "byte",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nRequests using `-` as a wildcard for the `PROJECT_ID` will infer the\nproject from the `account` and the `ACCOUNT` value can be the `email`\naddress or the `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.",
+ "type": "string"
+ },
+ "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"
+ },
+ "uniqueId": {
+ "description": "@OutputOnly The unique and stable id of the service account.",
+ "type": "string"
+ },
+ "oauth2ClientId": {
+ "description": "@OutputOnly The OAuth2 client id for the service account.\nThis is used in conjunction with the OAuth2 clientconfig API to make\nthree legged OAuth2 (3LO) flows to access the data of Google users.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.",
+ "type": "string"
+ }
+ },
+ "id": "ServiceAccount"
+ },
+ "CreateRoleRequest": {
+ "properties": {
+ "roleId": {
+ "description": "The role id to use for this role.",
+ "type": "string"
+ },
+ "role": {
+ "description": "The Role resource to create.",
+ "$ref": "Role"
+ }
+ },
+ "id": "CreateRoleRequest",
+ "description": "The request to create a new role.",
+ "type": "object"
+ },
+ "ListServiceAccountKeysResponse": {
+ "description": "The service account keys list response.",
+ "type": "object",
+ "properties": {
+ "keys": {
+ "description": "The public keys for the service account.",
+ "type": "array",
+ "items": {
+ "$ref": "ServiceAccountKey"
+ }
+ }
+ },
+ "id": "ListServiceAccountKeysResponse"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsResponse"
+ },
+ "QueryTestablePermissionsRequest": {
+ "description": "A request to get permissions which can be tested on a resource.",
+ "type": "object",
+ "properties": {
+ "fullResourceName": {
+ "description": "Required. The full resource name to query from the list of testable\npermissions.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Optional pagination token returned in an earlier\nQueryTestablePermissionsRequest.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional limit on the number of permissions to include in the response.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "QueryTestablePermissionsRequest"
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"canonicalName": "iam",
"auth": {
@@ -676,480 +678,9 @@
"title": "Google Identity and Access Management (IAM) API",
"ownerName": "Google",
"resources": {
- "roles": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListRolesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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": {
- "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}`",
- "type": "string",
- "location": "query"
- },
- "showDeleted": {
- "location": "query",
- "description": "Include Roles that have been deleted.",
- "type": "boolean"
- }
- },
- "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",
- "parameters": {
- "name": {
- "pattern": "^roles/[^/]+$",
- "location": "path",
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/roles/{rolesId}",
- "path": "v1/{+name}",
- "id": "iam.roles.get",
- "description": "Gets a Role definition."
- },
- "queryGrantableRoles": {
- "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",
- "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."
- }
- }
- },
- "permissions": {
- "methods": {
- "queryTestablePermissions": {
- "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"
- },
- "response": {
- "$ref": "QueryTestablePermissionsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {}
- }
- }
- },
- "organizations": {
- "resources": {
- "roles": {
- "methods": {
- "delete": {
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
- "id": "iam.organizations.roles.delete",
- "path": "v1/{+name}",
- "description": "Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^organizations/[^/]+/roles/[^/]+$",
- "location": "path",
- "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "required": true,
- "type": "string"
- },
- "etag": {
- "description": "Used to perform a consistent read-modify-write.",
- "format": "byte",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "iam.organizations.roles.list",
- "path": "v1/{+parent}/roles",
- "description": "Lists the Roles defined on a resource.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListRolesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$"
- },
- "showDeleted": {
- "description": "Include Roles that have been deleted.",
- "type": "boolean",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional pagination token returned in an earlier ListRolesResponse.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional limit on the number of roles to include in the response.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Optional view for the returned Role objects.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}/roles"
- },
- "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": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}/roles",
- "path": "v1/{+parent}/roles",
- "id": "iam.organizations.roles.create",
- "description": "Creates a new Role.",
- "request": {
- "$ref": "CreateRoleRequest"
- }
- },
- "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": {
- "id": "iam.organizations.roles.get",
- "path": "v1/{+name}",
- "description": "Gets a Role definition.",
- "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}"
- },
- "patch": {
- "id": "iam.organizations.roles.patch",
- "path": "v1/{+name}",
- "request": {
- "$ref": "Role"
- },
- "description": "Updates a Role definition.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Role"
- },
- "parameters": {
- "updateMask": {
- "description": "A mask describing which fields in the Role have changed.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/roles/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}"
- }
- }
- }
- }
- },
- "iamPolicies": {
- "methods": {
- "queryAuditableServices": {
- "response": {
- "$ref": "QueryAuditableServicesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/iamPolicies:queryAuditableServices",
- "path": "v1/iamPolicies:queryAuditableServices",
- "id": "iam.iamPolicies.queryAuditableServices",
- "description": "Returns a list of services that support service level audit logging\nconfiguration for the given resource.",
- "request": {
- "$ref": "QueryAuditableServicesRequest"
- }
- }
- }
- },
"projects": {
"resources": {
"serviceAccounts": {
- "resources": {
- "keys": {
- "methods": {
- "delete": {
- "description": "Deletes a ServiceAccountKey.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
- "location": "path",
- "description": "The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
- "path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.keys.delete"
- },
- "list": {
- "response": {
- "$ref": "ListServiceAccountKeysResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nUsing `-` as a wildcard for the `PROJECT_ID`, will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path"
- },
- "keyTypes": {
- "location": "query",
- "enum": [
- "KEY_TYPE_UNSPECIFIED",
- "USER_MANAGED",
- "SYSTEM_MANAGED"
- ],
- "description": "Filters the types of keys the user wants to include in the list\nresponse. Duplicate key types are not allowed. If no key type\nis provided, all keys are returned.",
- "type": "string",
- "repeated": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
- "path": "v1/{+name}/keys",
- "id": "iam.projects.serviceAccounts.keys.list",
- "description": "Lists ServiceAccountKeys."
- },
- "get": {
- "response": {
- "$ref": "ServiceAccountKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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"
- }
- },
- "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": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ServiceAccountKey"
- },
- "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}/keys",
- "id": "iam.projects.serviceAccounts.keys.create",
- "path": "v1/{+name}/keys",
- "request": {
- "$ref": "CreateServiceAccountKeyRequest"
- },
- "description": "Creates a ServiceAccountKey\nand returns it."
- }
- }
- }
- },
"methods": {
"list": {
"response": {
@@ -1159,9 +690,6 @@
"name"
],
"httpMethod": "GET",
- "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`.",
@@ -1171,27 +699,26 @@
"location": "path"
},
"pageToken": {
+ "location": "query",
"description": "Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
+ "location": "query",
"description": "Optional limit on the number of service accounts to include in the\nresponse. Further accounts can subsequently be obtained by including the\nListServiceAccountsResponse.next_page_token\nin a subsequent request.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/serviceAccounts",
"path": "v1/{+name}/serviceAccounts",
"id": "iam.projects.serviceAccounts.list",
"description": "Lists ServiceAccounts for a project."
},
"signBlob": {
- "request": {
- "$ref": "SignBlobRequest"
- },
- "description": "Signs a blob using a service account's system-managed private key.",
"response": {
"$ref": "SignBlobResponse"
},
@@ -1199,62 +726,9 @@
"name"
],
"httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob",
- "path": "v1/{+name}:signBlob",
- "id": "iam.projects.serviceAccounts.signBlob"
- },
- "setIamPolicy": {
- "description": "Sets the IAM access control policy for a\nServiceAccount.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
- }
- },
- "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": {
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
@@ -1264,21 +738,22 @@
"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"
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob",
+ "path": "v1/{+name}:signBlob",
+ "id": "iam.projects.serviceAccounts.signBlob",
+ "description": "Signs a blob using a service account's system-managed private key.",
+ "request": {
+ "$ref": "SignBlobRequest"
+ }
},
"create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"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`.",
@@ -1292,13 +767,69 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/serviceAccounts",
- "id": "iam.projects.serviceAccounts.create",
"path": "v1/{+name}/serviceAccounts",
+ "id": "iam.projects.serviceAccounts.create",
"request": {
"$ref": "CreateServiceAccountRequest"
},
"description": "Creates a ServiceAccount\nand returns it."
},
+ "signJwt": {
+ "response": {
+ "$ref": "SignJwtResponse"
+ },
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt",
+ "path": "v1/{+name}:signJwt",
+ "id": "iam.projects.serviceAccounts.signJwt",
+ "description": "Signs a JWT using a service account's system-managed private key.\n\nIf no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an\nan expiry time of one hour by default. If you request an expiry time of\nmore than one hour, the request will fail.",
+ "request": {
+ "$ref": "SignJwtRequest"
+ }
+ },
+ "setIamPolicy": {
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the IAM access control policy for a\nServiceAccount.",
+ "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/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy",
+ "id": "iam.projects.serviceAccounts.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy"
+ },
"getIamPolicy": {
"description": "Returns the IAM access control policy for a\nServiceAccount.",
"response": {
@@ -1308,18 +839,18 @@
"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/[^/]+/serviceAccounts/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
+ }
+ },
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
"id": "iam.projects.serviceAccounts.getIamPolicy"
@@ -1350,34 +881,41 @@
"description": "Gets a ServiceAccount."
},
"update": {
- "response": {
+ "request": {
"$ref": "ServiceAccount"
},
+ "description": "Updates a ServiceAccount.\n\nCurrently, only the following fields are updatable:\n`display_name` .\nThe `etag` is mandatory.",
+ "httpMethod": "PUT",
"parameterOrder": [
"name"
],
- "httpMethod": "PUT",
+ "response": {
+ "$ref": "ServiceAccount"
+ },
"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/[^/]+$"
+ "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.update",
- "request": {
- "$ref": "ServiceAccount"
- },
- "description": "Updates a ServiceAccount.\n\nCurrently, only the following fields are updatable:\n`display_name` .\nThe `etag` is mandatory."
+ "path": "v1/{+name}"
},
"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"
},
@@ -1385,9 +923,6 @@
"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.",
@@ -1397,48 +932,255 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "iam.projects.serviceAccounts.testIamPermissions",
- "description": "Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- }
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"delete": {
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
- "id": "iam.projects.serviceAccounts.delete",
- "path": "v1/{+name}",
"description": "Deletes a ServiceAccount.",
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "DELETE",
+ "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",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.delete"
+ }
+ },
+ "resources": {
+ "keys": {
+ "methods": {
+ "delete": {
+ "id": "iam.projects.serviceAccounts.keys.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a ServiceAccountKey.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListServiceAccountKeysResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "keyTypes": {
+ "enum": [
+ "KEY_TYPE_UNSPECIFIED",
+ "USER_MANAGED",
+ "SYSTEM_MANAGED"
+ ],
+ "description": "Filters the types of keys the user wants to include in the list\nresponse. Duplicate key types are not allowed. If no key type\nis provided, all keys are returned.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "name": {
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nUsing `-` as a wildcard for the `PROJECT_ID`, will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
+ "path": "v1/{+name}/keys",
+ "id": "iam.projects.serviceAccounts.keys.list",
+ "description": "Lists ServiceAccountKeys."
+ },
+ "get": {
+ "response": {
+ "$ref": "ServiceAccountKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "publicKeyType": {
+ "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",
+ "location": "query"
+ },
+ "name": {
+ "location": "path",
+ "description": "The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.\n\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.keys.get",
+ "description": "Gets the ServiceAccountKey\nby key id."
+ },
+ "create": {
+ "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": {
+ "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"
+ }
+ }
+ }
+ }
}
}
},
"roles": {
"methods": {
+ "create": {
+ "request": {
+ "$ref": "CreateRoleRequest"
+ },
+ "description": "Creates a new Role.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Role"
+ },
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/roles",
+ "id": "iam.projects.roles.create",
+ "path": "v1/{+parent}/roles"
+ },
+ "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": {
+ "description": "Gets a Role definition.",
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/roles/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.roles.get"
+ },
"patch": {
- "description": "Updates a Role definition.",
"request": {
"$ref": "Role"
},
+ "description": "Updates a Role definition.",
"response": {
"$ref": "Role"
},
@@ -1446,9 +1188,6 @@
"name"
],
"httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"updateMask": {
"description": "A mask describing which fields in the Role have changed.",
@@ -1464,93 +1203,43 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
"path": "v1/{+name}",
"id": "iam.projects.roles.patch"
},
- "undelete": {
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/roles/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/roles/{rolesId}:undelete",
- "path": "v1/{+name}:undelete",
- "id": "iam.projects.roles.undelete",
- "request": {
- "$ref": "UndeleteRoleRequest"
- },
- "description": "Undelete a Role, bringing it back in its previous state."
- },
- "get": {
- "description": "Gets a Role definition.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Role"
- },
- "parameters": {
- "name": {
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/roles/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
- "id": "iam.projects.roles.get",
- "path": "v1/{+name}"
- },
"delete": {
"description": "Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Role"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
"parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/roles/[^/]+$"
- },
"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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
- "id": "iam.projects.roles.delete",
- "path": "v1/{+name}"
+ "path": "v1/{+name}",
+ "id": "iam.projects.roles.delete"
},
"list": {
"flatPath": "v1/projects/{projectsId}/roles",
@@ -1565,6 +1254,222 @@
],
"httpMethod": "GET",
"parameters": {
+ "showDeleted": {
+ "description": "Include Roles that have been deleted.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional pagination token returned in an earlier ListRolesResponse.",
+ "type": "string"
+ },
+ "pageSize": {
+ "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": {
+ "location": "path",
+ "description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "roles": {
+ "methods": {
+ "queryGrantableRoles": {
+ "flatPath": "v1/roles:queryGrantableRoles",
+ "path": "v1/roles:queryGrantableRoles",
+ "id": "iam.roles.queryGrantableRoles",
+ "request": {
+ "$ref": "QueryGrantableRolesRequest"
+ },
+ "description": "Queries roles that can be granted on a particular resource.\nA role is grantable if it can be used as the role in a binding for a policy\nfor that resource.",
+ "response": {
+ "$ref": "QueryGrantableRolesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "path": "v1/roles",
+ "id": "iam.roles.list",
+ "description": "Lists the Roles defined on a resource.",
+ "response": {
+ "$ref": "ListRolesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "Optional pagination token returned in an earlier ListRolesResponse.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional limit on the number of roles to include in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "view": {
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Optional view for the returned Role objects.",
+ "type": "string",
+ "location": "query"
+ },
+ "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": {
+ "location": "query",
+ "description": "Include Roles that have been deleted.",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/roles"
+ },
+ "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": {
+ "description": "Lists the permissions testable on a resource.\nA permission is testable if it can be tested for an identity on a resource.",
+ "request": {
+ "$ref": "QueryTestablePermissionsRequest"
+ },
+ "response": {
+ "$ref": "QueryTestablePermissionsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/permissions:queryTestablePermissions",
+ "path": "v1/permissions:queryTestablePermissions",
+ "id": "iam.permissions.queryTestablePermissions"
+ }
+ }
+ },
+ "organizations": {
+ "resources": {
+ "roles": {
+ "methods": {
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
+ "path": "v1/{+name}",
+ "id": "iam.organizations.roles.delete"
+ },
+ "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": {
+ "parent": {
+ "description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ },
+ "showDeleted": {
+ "description": "Include Roles that have been deleted.",
+ "type": "boolean",
+ "location": "query"
+ },
"pageToken": {
"description": "Optional pagination token returned in an earlier ListRolesResponse.",
"type": "string",
@@ -1584,39 +1489,30 @@
],
"description": "Optional view for the returned Role objects.",
"type": "string"
- },
- "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": {
- "description": "Include Roles that have been deleted.",
- "type": "boolean",
- "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ "flatPath": "v1/organizations/{organizationsId}/roles",
+ "path": "v1/{+parent}/roles",
+ "id": "iam.organizations.roles.list"
},
"create": {
+ "flatPath": "v1/organizations/{organizationsId}/roles",
+ "path": "v1/{+parent}/roles",
+ "id": "iam.organizations.roles.create",
"request": {
"$ref": "CreateRoleRequest"
},
"description": "Creates a new Role.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
"response": {
"$ref": "Role"
},
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
"parameters": {
"parent": {
- "pattern": "^projects/[^/]+$",
+ "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,
@@ -1625,38 +1521,159 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "undelete": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
],
- "flatPath": "v1/projects/{projectsId}/roles",
- "id": "iam.projects.roles.create",
- "path": "v1/{+parent}/roles"
+ "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",
+ "id": "iam.organizations.roles.undelete",
+ "path": "v1/{+name}:undelete",
+ "request": {
+ "$ref": "UndeleteRoleRequest"
+ },
+ "description": "Undelete a Role, bringing it back in its previous state."
+ },
+ "get": {
+ "description": "Gets a Role definition.",
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/roles/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
+ "path": "v1/{+name}",
+ "id": "iam.organizations.roles.get"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "description": "A mask describing which fields in the Role have changed.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "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}",
+ "path": "v1/{+name}",
+ "id": "iam.organizations.roles.patch",
+ "request": {
+ "$ref": "Role"
+ },
+ "description": "Updates a Role definition."
}
}
}
}
+ },
+ "iamPolicies": {
+ "methods": {
+ "queryAuditableServices": {
+ "response": {
+ "$ref": "QueryAuditableServicesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/iamPolicies:queryAuditableServices",
+ "path": "v1/iamPolicies:queryAuditableServices",
+ "id": "iam.iamPolicies.queryAuditableServices",
+ "description": "Returns a list of services that support service level audit logging\nconfiguration for the given resource.",
+ "request": {
+ "$ref": "QueryAuditableServicesRequest"
+ }
+ }
+ }
}
},
"parameters": {
- "pp": {
+ "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"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
+ "default": "true",
+ "location": "query"
},
"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": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
@@ -1664,32 +1681,32 @@
"location": "query"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
"enumDescriptions": [
@@ -1706,32 +1723,15 @@
"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"
}
},
"version": "v1",
"baseUrl": "https://iam.googleapis.com/",
- "servicePath": "",
- "description": "Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls.",
"kind": "discovery#restDescription",
+ "description": "Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls.",
+ "servicePath": "",
"basePath": "",
"id": "iam:v1",
"documentationLink": "https://cloud.google.com/iam/",
- "revision": "20180118",
- "discoveryVersion": "v1",
- "version_module": true
+ "revision": "20180118"
}
diff --git a/kgsearch/v1/kgsearch-api.json b/kgsearch/v1/kgsearch-api.json
index 654a75b..0f5d860 100644
--- a/kgsearch/v1/kgsearch-api.json
+++ b/kgsearch/v1/kgsearch-api.json
@@ -1,16 +1,4 @@
{
- "rootUrl": "https://kgsearch.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "kgsearch",
- "batchPath": "batch",
- "revision": "20180104",
- "documentationLink": "https://developers.google.com/knowledge-graph/",
- "id": "kgsearch:v1",
- "title": "Knowledge Graph Search API",
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "version_module": true,
"resources": {
"entities": {
"methods": {
@@ -22,44 +10,44 @@
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
+ "prefix": {
+ "location": "query",
+ "description": "Enables prefix match against names and aliases of entities",
+ "type": "boolean"
+ },
+ "query": {
+ "location": "query",
+ "description": "The literal query string for search.",
+ "type": "string"
+ },
+ "types": {
+ "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": {
- "location": "query",
"description": "The list of language codes (defined in ISO 693) to run the query with,\ne.g. 'en'.",
"type": "string",
- "repeated": true
+ "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",
"type": "string",
- "repeated": true
+ "repeated": true,
+ "location": "query"
},
"limit": {
- "location": "query",
"description": "Limits the number of entities to be returned.",
"format": "int32",
- "type": "integer"
- },
- "prefix": {
- "type": "boolean",
- "location": "query",
- "description": "Enables prefix match against names and aliases of entities"
- },
- "query": {
- "type": "string",
- "location": "query",
- "description": "The literal query string for search."
- },
- "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
+ "type": "integer",
+ "location": "query"
}
},
"flatPath": "v1/entities:search",
@@ -70,52 +58,15 @@
}
},
"parameters": {
- "alt": {
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response."
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "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": {
- "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."
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
},
"bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
- "location": "query",
- "description": "OAuth bearer token."
+ "location": "query"
},
"upload_protocol": {
"location": "query",
@@ -128,37 +79,75 @@
"type": "boolean",
"default": "true"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
"fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
+ "location": "query"
+ },
+ "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",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
+ "type": "string"
},
"callback": {
- "type": "string",
"location": "query",
- "description": "JSONP"
+ "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": {
+ "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": {
"SearchResponse": {
+ "description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities.",
"type": "object",
"properties": {
"@context": {
@@ -166,29 +155,40 @@
"type": "any"
},
"itemListElement": {
+ "description": "The item list of search results.",
"type": "array",
"items": {
"type": "any"
- },
- "description": "The item list of search results."
+ }
},
"@type": {
- "type": "any",
- "description": "The schema type of top-level JSON-LD object, e.g. ItemList."
+ "description": "The schema type of top-level JSON-LD object, e.g. ItemList.",
+ "type": "any"
}
},
- "id": "SearchResponse",
- "description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities."
+ "id": "SearchResponse"
}
},
- "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://kgsearch.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Searches the Google Knowledge Graph for entities.",
- "servicePath": ""
+ "servicePath": "",
+ "rootUrl": "https://kgsearch.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "kgsearch",
+ "batchPath": "batch",
+ "revision": "20180104",
+ "documentationLink": "https://developers.google.com/knowledge-graph/",
+ "id": "kgsearch:v1",
+ "title": "Knowledge Graph Search API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "version_module": true
}
diff --git a/language/v1/language-api.json b/language/v1/language-api.json
index 283a3ca..bea651b 100644
--- a/language/v1/language-api.json
+++ b/language/v1/language-api.json
@@ -1,4 +1,7 @@
{
+ "servicePath": "",
+ "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
+ "kind": "discovery#restDescription",
"basePath": "",
"revision": "20180121",
"documentationLink": "https://cloud.google.com/natural-language/",
@@ -6,10 +9,77 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "AnnotateTextRequest": {
+ "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string"
+ },
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ },
+ "features": {
+ "description": "The enabled features.",
+ "$ref": "Features"
+ }
+ },
+ "id": "AnnotateTextRequest"
+ },
+ "AnalyzeSentimentRequest": {
+ "description": "The sentiment analysis request message.",
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "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."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ]
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeSentimentRequest"
+ },
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "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",
@@ -20,15 +90,6 @@
},
"type": "object"
}
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
}
},
"id": "Status"
@@ -61,15 +122,9 @@
"id": "Features"
},
"Document": {
+ "description": "################################################################ #\n\nRepresents the input to API methods.",
+ "type": "object",
"properties": {
- "gcsContentUri": {
- "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
- "type": "string"
- },
- "language": {
- "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
- "type": "string"
- },
"type": {
"enumDescriptions": [
"The content type is not specified.",
@@ -87,23 +142,27 @@
"content": {
"description": "The content of the input in string format.",
"type": "string"
+ },
+ "gcsContentUri": {
+ "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
+ "type": "string"
+ },
+ "language": {
+ "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
+ "type": "string"
}
},
- "id": "Document",
- "description": "################################################################ #\n\nRepresents the input to API methods.",
- "type": "object"
+ "id": "Document"
},
"AnalyzeEntitiesRequest": {
"description": "The entity analysis request message.",
"type": "object",
"properties": {
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ },
"encodingType": {
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
"enum": [
"NONE",
"UTF8",
@@ -111,55 +170,48 @@
"UTF32"
],
"description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ]
}
},
"id": "AnalyzeEntitiesRequest"
},
"ClassifyTextRequest": {
- "properties": {
- "document": {
- "$ref": "Document",
- "description": "Input document."
- }
- },
- "id": "ClassifyTextRequest",
"description": "The document classification request message.",
- "type": "object"
- },
- "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"
- },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "ClassifyTextRequest"
+ },
+ "AnalyzeEntitySentimentResponse": {
+ "properties": {
"entities": {
"description": "The recognized entities in the input document with associated sentiments.",
"type": "array",
"items": {
"$ref": "Entity"
}
+ },
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
}
},
- "id": "AnalyzeEntitySentimentResponse"
+ "id": "AnalyzeEntitySentimentResponse",
+ "description": "The entity-level sentiment analysis response message.",
+ "type": "object"
},
"AnalyzeSentimentResponse": {
- "description": "The sentiment analysis response message.",
- "type": "object",
"properties": {
- "sentences": {
- "description": "The sentiment for all the sentences in the document.",
- "type": "array",
- "items": {
- "$ref": "Sentence"
- }
- },
"documentSentiment": {
"$ref": "Sentiment",
"description": "The overall sentiment of the input document."
@@ -167,9 +219,18 @@
"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"
+ "id": "AnalyzeSentimentResponse",
+ "description": "The sentiment analysis response message.",
+ "type": "object"
},
"AnalyzeSyntaxResponse": {
"description": "The syntax analysis response message.",
@@ -197,7 +258,24 @@
"id": "AnalyzeSyntaxResponse"
},
"AnnotateTextResponse": {
+ "description": "The text annotations response message.",
+ "type": "object",
"properties": {
+ "categories": {
+ "description": "Categories identified in the input document.",
+ "type": "array",
+ "items": {
+ "$ref": "ClassificationCategory"
+ }
+ },
+ "documentSentiment": {
+ "$ref": "Sentiment",
+ "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
+ },
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
"entities": {
"description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
"type": "array",
@@ -218,26 +296,9 @@
"items": {
"$ref": "Token"
}
- },
- "categories": {
- "description": "Categories identified in the input document.",
- "type": "array",
- "items": {
- "$ref": "ClassificationCategory"
- }
- },
- "documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
- },
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
}
},
- "id": "AnnotateTextResponse",
- "description": "The text annotations response message.",
- "type": "object"
+ "id": "AnnotateTextResponse"
},
"DependencyEdge": {
"description": "Represents dependency parse tree information for a token. (For more\ninformation on dependency labels, see\nhttp://www.aclweb.org/anthology/P13-2017",
@@ -426,6 +487,8 @@
"id": "DependencyEdge"
},
"TextSpan": {
+ "description": "Represents an output piece of text.",
+ "type": "object",
"properties": {
"beginOffset": {
"description": "The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.",
@@ -437,11 +500,11 @@
"type": "string"
}
},
- "id": "TextSpan",
- "description": "Represents an output piece of text.",
- "type": "object"
+ "id": "TextSpan"
},
"Token": {
+ "description": "Represents the smallest syntactic building block of the text.",
+ "type": "object",
"properties": {
"partOfSpeech": {
"$ref": "PartOfSpeech",
@@ -460,21 +523,19 @@
"type": "string"
}
},
- "id": "Token",
- "description": "Represents the smallest syntactic building block of the text.",
- "type": "object"
+ "id": "Token"
},
"EntityMention": {
+ "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
+ "type": "object",
"properties": {
- "sentiment": {
- "$ref": "Sentiment",
- "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document."
- },
"text": {
"$ref": "TextSpan",
"description": "The mention text."
},
"type": {
+ "description": "The type of the entity mention.",
+ "type": "string",
"enumDescriptions": [
"Unknown",
"Proper name",
@@ -484,14 +545,14 @@
"TYPE_UNKNOWN",
"PROPER",
"COMMON"
- ],
- "description": "The type of the entity mention.",
- "type": "string"
+ ]
+ },
+ "sentiment": {
+ "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document.",
+ "$ref": "Sentiment"
}
},
- "id": "EntityMention",
- "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
- "type": "object"
+ "id": "EntityMention"
},
"ClassifyTextResponse": {
"description": "The document classification response message.",
@@ -508,19 +569,19 @@
"id": "ClassifyTextResponse"
},
"Sentence": {
- "description": "Represents a sentence in the input document.",
- "type": "object",
"properties": {
- "sentiment": {
- "$ref": "Sentiment",
- "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence."
- },
"text": {
"description": "The sentence text.",
"$ref": "TextSpan"
+ },
+ "sentiment": {
+ "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence.",
+ "$ref": "Sentiment"
}
},
- "id": "Sentence"
+ "id": "Sentence",
+ "description": "Represents a sentence in the input document.",
+ "type": "object"
},
"Sentiment": {
"description": "Represents the feeling associated with the entire text or entities in\nthe text.",
@@ -543,11 +604,13 @@
"description": "The entity-level sentiment analysis request message.",
"type": "object",
"properties": {
- "document": {
- "$ref": "Document",
- "description": "Input document."
- },
"encodingType": {
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
"description": "The encoding type used by the API to calculate offsets.",
"type": "string",
"enumDescriptions": [
@@ -555,95 +618,17 @@
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
]
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
}
},
"id": "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": {
- "proper": {
- "description": "The grammatical properness.",
- "type": "string",
- "enumDescriptions": [
- "Proper is not applicable in the analyzed language or is not predicted.",
- "Proper",
- "Not proper"
- ],
- "enum": [
- "PROPER_UNKNOWN",
- "PROPER",
- "NOT_PROPER"
- ]
- },
- "case": {
- "enumDescriptions": [
- "Case is not applicable in the analyzed language or is not predicted.",
- "Accusative",
- "Adverbial",
- "Complementive",
- "Dative",
- "Genitive",
- "Instrumental",
- "Locative",
- "Nominative",
- "Oblique",
- "Partitive",
- "Prepositional",
- "Reflexive",
- "Relative",
- "Vocative"
- ],
- "enum": [
- "CASE_UNKNOWN",
- "ACCUSATIVE",
- "ADVERBIAL",
- "COMPLEMENTIVE",
- "DATIVE",
- "GENITIVE",
- "INSTRUMENTAL",
- "LOCATIVE",
- "NOMINATIVE",
- "OBLIQUE",
- "PARTITIVE",
- "PREPOSITIONAL",
- "REFLEXIVE_CASE",
- "RELATIVE_CASE",
- "VOCATIVE"
- ],
- "description": "The grammatical case.",
- "type": "string"
- },
- "tense": {
- "enum": [
- "TENSE_UNKNOWN",
- "CONDITIONAL_TENSE",
- "FUTURE",
- "PAST",
- "PRESENT",
- "IMPERFECT",
- "PLUPERFECT"
- ],
- "description": "The grammatical tense.",
- "type": "string",
- "enumDescriptions": [
- "Tense is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Future",
- "Past",
- "Present",
- "Imperfect",
- "Pluperfect"
- ]
- },
"reciprocity": {
"enumDescriptions": [
"Reciprocity is not applicable in the analyzed language or is not\npredicted.",
@@ -723,12 +708,6 @@
"type": "string"
},
"aspect": {
- "enum": [
- "ASPECT_UNKNOWN",
- "PERFECTIVE",
- "IMPERFECTIVE",
- "PROGRESSIVE"
- ],
"description": "The grammatical aspect.",
"type": "string",
"enumDescriptions": [
@@ -736,6 +715,12 @@
"Perfective",
"Imperfective",
"Progressive"
+ ],
+ "enum": [
+ "ASPECT_UNKNOWN",
+ "PERFECTIVE",
+ "IMPERFECTIVE",
+ "PROGRESSIVE"
]
},
"mood": {
@@ -761,8 +746,6 @@
"type": "string"
},
"tag": {
- "description": "The part of speech tag.",
- "type": "string",
"enumDescriptions": [
"Unknown",
"Adjective",
@@ -794,9 +777,13 @@
"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",
@@ -808,18 +795,9 @@
"FEMININE",
"MASCULINE",
"NEUTER"
- ],
- "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",
@@ -828,10 +806,93 @@
"REFLEXIVE_PERSON"
],
"description": "The grammatical person.",
+ "type": "string",
+ "enumDescriptions": [
+ "Person is not applicable in the analyzed language or is not predicted.",
+ "First",
+ "Second",
+ "Third",
+ "Reflexive"
+ ]
+ },
+ "proper": {
+ "enumDescriptions": [
+ "Proper is not applicable in the analyzed language or is not predicted.",
+ "Proper",
+ "Not proper"
+ ],
+ "enum": [
+ "PROPER_UNKNOWN",
+ "PROPER",
+ "NOT_PROPER"
+ ],
+ "description": "The grammatical properness.",
"type": "string"
+ },
+ "case": {
+ "enumDescriptions": [
+ "Case is not applicable in the analyzed language or is not predicted.",
+ "Accusative",
+ "Adverbial",
+ "Complementive",
+ "Dative",
+ "Genitive",
+ "Instrumental",
+ "Locative",
+ "Nominative",
+ "Oblique",
+ "Partitive",
+ "Prepositional",
+ "Reflexive",
+ "Relative",
+ "Vocative"
+ ],
+ "enum": [
+ "CASE_UNKNOWN",
+ "ACCUSATIVE",
+ "ADVERBIAL",
+ "COMPLEMENTIVE",
+ "DATIVE",
+ "GENITIVE",
+ "INSTRUMENTAL",
+ "LOCATIVE",
+ "NOMINATIVE",
+ "OBLIQUE",
+ "PARTITIVE",
+ "PREPOSITIONAL",
+ "REFLEXIVE_CASE",
+ "RELATIVE_CASE",
+ "VOCATIVE"
+ ],
+ "description": "The grammatical case.",
+ "type": "string"
+ },
+ "tense": {
+ "enum": [
+ "TENSE_UNKNOWN",
+ "CONDITIONAL_TENSE",
+ "FUTURE",
+ "PAST",
+ "PRESENT",
+ "IMPERFECT",
+ "PLUPERFECT"
+ ],
+ "description": "The grammatical tense.",
+ "type": "string",
+ "enumDescriptions": [
+ "Tense is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Future",
+ "Past",
+ "Present",
+ "Imperfect",
+ "Pluperfect"
+ ]
}
},
- "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": {
"description": "Represents a category returned from the text classifier.",
@@ -853,11 +914,9 @@
"description": "The syntax analysis request message.",
"type": "object",
"properties": {
- "document": {
- "$ref": "Document",
- "description": "Input document."
- },
"encodingType": {
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string",
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
@@ -869,50 +928,37 @@
"UTF8",
"UTF16",
"UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
+ ]
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
}
},
"id": "AnalyzeSyntaxRequest"
},
"AnalyzeEntitiesResponse": {
+ "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"
}
+ },
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
}
},
- "id": "AnalyzeEntitiesResponse",
- "description": "The entity analysis response message.",
- "type": "object"
+ "id": "AnalyzeEntitiesResponse"
},
"Entity": {
"description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
"type": "object",
"properties": {
- "sentiment": {
- "$ref": "Sentiment",
- "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the aggregate sentiment expressed for this\nentity in the provided document."
- },
- "mentions": {
- "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
- "type": "array",
- "items": {
- "$ref": "EntityMention"
- }
- },
- "name": {
- "description": "The representative name for the entity.",
- "type": "string"
- },
"type": {
"enumDescriptions": [
"Unknown",
@@ -948,72 +994,29 @@
"description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.",
"format": "float",
"type": "number"
+ },
+ "sentiment": {
+ "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the aggregate sentiment expressed for this\nentity in the provided document.",
+ "$ref": "Sentiment"
+ },
+ "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"
}
},
"id": "Entity"
- },
- "AnnotateTextRequest": {
- "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
- "type": "object",
- "properties": {
- "encodingType": {
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
- },
- "features": {
- "description": "The enabled features.",
- "$ref": "Features"
- }
- },
- "id": "AnnotateTextRequest"
- },
- "AnalyzeSentimentRequest": {
- "description": "The sentiment analysis request message.",
- "type": "object",
- "properties": {
- "encodingType": {
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate sentence offsets.",
- "type": "string"
- },
- "document": {
- "description": "Input document.",
- "$ref": "Document"
- }
- },
- "id": "AnalyzeSentimentRequest"
}
},
"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",
@@ -1038,26 +1041,9 @@
"resources": {
"documents": {
"methods": {
- "analyzeSyntax": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeSyntaxResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/documents:analyzeSyntax",
- "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."
- },
"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"
@@ -1072,9 +1058,7 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
- "flatPath": "v1/documents:annotateText",
- "path": "v1/documents:annotateText",
- "id": "language.documents.annotateText"
+ "flatPath": "v1/documents:annotateText"
},
"classifyText": {
"httpMethod": "POST",
@@ -1096,6 +1080,10 @@
"description": "Classifies a document into categories."
},
"analyzeSentiment": {
+ "description": "Analyzes the sentiment of the provided text.",
+ "request": {
+ "$ref": "AnalyzeSentimentRequest"
+ },
"response": {
"$ref": "AnalyzeSentimentResponse"
},
@@ -1108,11 +1096,7 @@
"parameters": {},
"flatPath": "v1/documents:analyzeSentiment",
"path": "v1/documents:analyzeSentiment",
- "id": "language.documents.analyzeSentiment",
- "description": "Analyzes the sentiment of the provided text.",
- "request": {
- "$ref": "AnalyzeSentimentRequest"
- }
+ "id": "language.documents.analyzeSentiment"
},
"analyzeEntitySentiment": {
"response": {
@@ -1134,6 +1118,10 @@
"description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions."
},
"analyzeEntities": {
+ "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
+ "request": {
+ "$ref": "AnalyzeEntitiesRequest"
+ },
"response": {
"$ref": "AnalyzeEntitiesResponse"
},
@@ -1146,91 +1134,47 @@
"parameters": {},
"flatPath": "v1/documents:analyzeEntities",
"path": "v1/documents:analyzeEntities",
- "id": "language.documents.analyzeEntities",
- "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
+ "id": "language.documents.analyzeEntities"
+ },
+ "analyzeSyntax": {
"request": {
- "$ref": "AnalyzeEntitiesRequest"
- }
+ "$ref": "AnalyzeSyntaxRequest"
+ },
+ "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnalyzeSyntaxResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/documents:analyzeSyntax",
+ "id": "language.documents.analyzeSyntax",
+ "path": "v1/documents:analyzeSyntax"
}
}
}
},
"parameters": {
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "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": {
- "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"
+ "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"
},
+ "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",
@@ -1241,11 +1185,67 @@
"type": "boolean",
"default": "true",
"location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
}
},
"version": "v1",
- "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"
+ "baseUrl": "https://language.googleapis.com/"
}
diff --git a/language/v1beta1/language-api.json b/language/v1beta1/language-api.json
index 5abc502..ed9d1b9 100644
--- a/language/v1beta1/language-api.json
+++ b/language/v1beta1/language-api.json
@@ -1,509 +1,11 @@
{
+ "revision": "20180121",
+ "documentationLink": "https://cloud.google.com/natural-language/",
+ "id": "language:v1beta1",
+ "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "EntityMention": {
- "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
- "type": "object",
- "properties": {
- "text": {
- "$ref": "TextSpan",
- "description": "The mention text."
- },
- "type": {
- "enumDescriptions": [
- "Unknown",
- "Proper name",
- "Common noun (or noun compound)"
- ],
- "enum": [
- "TYPE_UNKNOWN",
- "PROPER",
- "COMMON"
- ],
- "description": "The type of the entity mention.",
- "type": "string"
- }
- },
- "id": "EntityMention"
- },
- "Features": {
- "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
- "type": "object",
- "properties": {
- "extractEntities": {
- "description": "Extract entities.",
- "type": "boolean"
- },
- "extractSyntax": {
- "description": "Extract syntax information.",
- "type": "boolean"
- },
- "extractDocumentSentiment": {
- "description": "Extract document-level sentiment.",
- "type": "boolean"
- }
- },
- "id": "Features"
- },
- "Document": {
- "properties": {
- "type": {
- "enumDescriptions": [
- "The content type is not specified.",
- "Plain text",
- "HTML"
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "PLAIN_TEXT",
- "HTML"
- ],
- "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
- "type": "string"
- },
- "content": {
- "description": "The content of the input in string format.",
- "type": "string"
- },
- "gcsContentUri": {
- "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
- "type": "string"
- },
- "language": {
- "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
- "type": "string"
- }
- },
- "id": "Document",
- "description": "################################################################ #\n\nRepresents the input to API methods.",
- "type": "object"
- },
- "Sentence": {
- "description": "Represents a sentence in the input document.",
- "type": "object",
- "properties": {
- "sentiment": {
- "$ref": "Sentiment",
- "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence."
- },
- "text": {
- "$ref": "TextSpan",
- "description": "The sentence text."
- }
- },
- "id": "Sentence"
- },
- "AnalyzeEntitiesRequest": {
- "description": "The entity analysis request message.",
- "type": "object",
- "properties": {
- "document": {
- "$ref": "Document",
- "description": "Input document."
- },
- "encodingType": {
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
- }
- },
- "id": "AnalyzeEntitiesRequest"
- },
- "Sentiment": {
- "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
- "type": "object",
- "properties": {
- "polarity": {
- "description": "DEPRECATED FIELD - This field is being deprecated in\nfavor of score. Please refer to our documentation at\nhttps://cloud.google.com/natural-language/docs for more information.",
- "format": "float",
- "type": "number"
- },
- "score": {
- "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
- "format": "float",
- "type": "number"
- },
- "magnitude": {
- "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
- "format": "float",
- "type": "number"
- }
- },
- "id": "Sentiment"
- },
- "PartOfSpeech": {
- "properties": {
- "form": {
- "enumDescriptions": [
- "Form is not applicable in the analyzed language or is not predicted.",
- "Adnomial",
- "Auxiliary",
- "Complementizer",
- "Final ending",
- "Gerund",
- "Realis",
- "Irrealis",
- "Short form",
- "Long form",
- "Order form",
- "Specific form"
- ],
- "enum": [
- "FORM_UNKNOWN",
- "ADNOMIAL",
- "AUXILIARY",
- "COMPLEMENTIZER",
- "FINAL_ENDING",
- "GERUND",
- "REALIS",
- "IRREALIS",
- "SHORT",
- "LONG",
- "ORDER",
- "SPECIFIC"
- ],
- "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": {
- "description": "The grammatical voice.",
- "type": "string",
- "enumDescriptions": [
- "Voice is not applicable in the analyzed language or is not predicted.",
- "Active",
- "Causative",
- "Passive"
- ],
- "enum": [
- "VOICE_UNKNOWN",
- "ACTIVE",
- "CAUSATIVE",
- "PASSIVE"
- ]
- },
- "aspect": {
- "enumDescriptions": [
- "Aspect is not applicable in the analyzed language or is not predicted.",
- "Perfective",
- "Imperfective",
- "Progressive"
- ],
- "enum": [
- "ASPECT_UNKNOWN",
- "PERFECTIVE",
- "IMPERFECTIVE",
- "PROGRESSIVE"
- ],
- "description": "The grammatical aspect.",
- "type": "string"
- },
- "mood": {
- "enumDescriptions": [
- "Mood is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Imperative",
- "Indicative",
- "Interrogative",
- "Jussive",
- "Subjunctive"
- ],
- "enum": [
- "MOOD_UNKNOWN",
- "CONDITIONAL_MOOD",
- "IMPERATIVE",
- "INDICATIVE",
- "INTERROGATIVE",
- "JUSSIVE",
- "SUBJUNCTIVE"
- ],
- "description": "The grammatical mood.",
- "type": "string"
- },
- "tag": {
- "enumDescriptions": [
- "Unknown",
- "Adjective",
- "Adposition (preposition and postposition)",
- "Adverb",
- "Conjunction",
- "Determiner",
- "Noun (common and proper)",
- "Cardinal number",
- "Pronoun",
- "Particle or other function word",
- "Punctuation",
- "Verb (all tenses and modes)",
- "Other: foreign words, typos, abbreviations",
- "Affix"
- ],
- "enum": [
- "UNKNOWN",
- "ADJ",
- "ADP",
- "ADV",
- "CONJ",
- "DET",
- "NOUN",
- "NUM",
- "PRON",
- "PRT",
- "PUNCT",
- "VERB",
- "X",
- "AFFIX"
- ],
- "description": "The part of speech tag.",
- "type": "string"
- },
- "gender": {
- "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": {
- "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": {
- "description": "The grammatical properness.",
- "type": "string",
- "enumDescriptions": [
- "Proper is not applicable in the analyzed language or is not predicted.",
- "Proper",
- "Not proper"
- ],
- "enum": [
- "PROPER_UNKNOWN",
- "PROPER",
- "NOT_PROPER"
- ]
- },
- "case": {
- "description": "The grammatical case.",
- "type": "string",
- "enumDescriptions": [
- "Case is not applicable in the analyzed language or is not predicted.",
- "Accusative",
- "Adverbial",
- "Complementive",
- "Dative",
- "Genitive",
- "Instrumental",
- "Locative",
- "Nominative",
- "Oblique",
- "Partitive",
- "Prepositional",
- "Reflexive",
- "Relative",
- "Vocative"
- ],
- "enum": [
- "CASE_UNKNOWN",
- "ACCUSATIVE",
- "ADVERBIAL",
- "COMPLEMENTIVE",
- "DATIVE",
- "GENITIVE",
- "INSTRUMENTAL",
- "LOCATIVE",
- "NOMINATIVE",
- "OBLIQUE",
- "PARTITIVE",
- "PREPOSITIONAL",
- "REFLEXIVE_CASE",
- "RELATIVE_CASE",
- "VOCATIVE"
- ]
- },
- "tense": {
- "enumDescriptions": [
- "Tense is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Future",
- "Past",
- "Present",
- "Imperfect",
- "Pluperfect"
- ],
- "enum": [
- "TENSE_UNKNOWN",
- "CONDITIONAL_TENSE",
- "FUTURE",
- "PAST",
- "PRESENT",
- "IMPERFECT",
- "PLUPERFECT"
- ],
- "description": "The grammatical tense.",
- "type": "string"
- },
- "reciprocity": {
- "description": "The grammatical reciprocity.",
- "type": "string",
- "enumDescriptions": [
- "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
- "Reciprocal",
- "Non-reciprocal"
- ],
- "enum": [
- "RECIPROCITY_UNKNOWN",
- "RECIPROCAL",
- "NON_RECIPROCAL"
- ]
- }
- },
- "id": "PartOfSpeech",
- "description": "Represents part of speech information for a token.",
- "type": "object"
- },
- "AnalyzeSyntaxRequest": {
- "description": "The syntax analysis request message.",
- "type": "object",
- "properties": {
- "encodingType": {
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
- }
- },
- "id": "AnalyzeSyntaxRequest"
- },
- "AnalyzeSentimentResponse": {
- "description": "The sentiment analysis response message.",
- "type": "object",
- "properties": {
- "sentences": {
- "description": "The sentiment for all the sentences in the document.",
- "type": "array",
- "items": {
- "$ref": "Sentence"
- }
- },
- "documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment of the input document."
- },
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- }
- },
- "id": "AnalyzeSentimentResponse"
- },
- "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"
- },
- "AnalyzeSyntaxResponse": {
- "properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "sentences": {
- "description": "Sentences in the input document.",
- "type": "array",
- "items": {
- "$ref": "Sentence"
- }
- },
- "tokens": {
- "description": "Tokens, along with their syntactic information, in the input document.",
- "type": "array",
- "items": {
- "$ref": "Token"
- }
- }
- },
- "id": "AnalyzeSyntaxResponse",
- "description": "The syntax analysis response message.",
- "type": "object"
- },
"Entity": {
- "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
- "type": "object",
"properties": {
"mentions": {
"description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
@@ -541,11 +43,11 @@
"type": "string"
},
"metadata": {
- "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",
"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.",
@@ -553,19 +55,38 @@
"type": "number"
}
},
- "id": "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"
},
- "AnnotateTextRequest": {
- "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
+ "AnalyzeSyntaxResponse": {
+ "description": "The syntax analysis response message.",
"type": "object",
"properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
+ "sentences": {
+ "description": "Sentences in the input document.",
+ "type": "array",
+ "items": {
+ "$ref": "Sentence"
+ }
+ },
+ "tokens": {
+ "description": "Tokens, along with their syntactic information, in the input document.",
+ "type": "array",
+ "items": {
+ "$ref": "Token"
+ }
+ }
+ },
+ "id": "AnalyzeSyntaxResponse"
+ },
+ "AnnotateTextRequest": {
+ "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",
@@ -573,27 +94,58 @@
"UTF32"
],
"description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ]
},
"document": {
- "$ref": "Document",
- "description": "Input document."
+ "description": "Input document.",
+ "$ref": "Document"
},
"features": {
"description": "The enabled features.",
"$ref": "Features"
}
},
- "id": "AnnotateTextRequest"
+ "id": "AnnotateTextRequest",
+ "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
+ "type": "object"
+ },
+ "AnalyzeSentimentRequest": {
+ "properties": {
+ "encodingType": {
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.",
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ]
+ },
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ }
+ },
+ "id": "AnalyzeSentimentRequest",
+ "description": "The sentiment analysis request message.",
+ "type": "object"
},
"AnnotateTextResponse": {
"description": "The text annotations response message.",
"type": "object",
"properties": {
- "documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
- },
"language": {
"description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
"type": "string"
@@ -618,49 +170,17 @@
"items": {
"$ref": "Entity"
}
+ },
+ "documentSentiment": {
+ "$ref": "Sentiment",
+ "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
}
},
"id": "AnnotateTextResponse"
},
- "AnalyzeSentimentRequest": {
- "properties": {
- "encodingType": {
- "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.",
- "type": "string",
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ]
- },
- "document": {
- "description": "Input document.",
- "$ref": "Document"
- }
- },
- "id": "AnalyzeSentimentRequest",
- "description": "The sentiment analysis request message.",
- "type": "object"
- },
"DependencyEdge": {
- "description": "Represents dependency parse tree information for a token.",
- "type": "object",
"properties": {
- "headTokenIndex": {
- "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
- "format": "int32",
- "type": "integer"
- },
"label": {
- "description": "The parse label for the token.",
- "type": "string",
"enumDescriptions": [
"Unknown",
"Abbreviation modifier",
@@ -830,10 +350,19 @@
"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"
+ "id": "DependencyEdge",
+ "description": "Represents dependency parse tree information for a token.",
+ "type": "object"
},
"TextSpan": {
"properties": {
@@ -852,32 +381,36 @@
"type": "object"
},
"Token": {
- "description": "Represents the smallest syntactic building block of the text.",
- "type": "object",
"properties": {
+ "lemma": {
+ "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
+ "type": "string"
+ },
"partOfSpeech": {
"$ref": "PartOfSpeech",
"description": "Parts of speech tag for this token."
},
"text": {
- "description": "The token text.",
- "$ref": "TextSpan"
+ "$ref": "TextSpan",
+ "description": "The token text."
},
"dependencyEdge": {
"$ref": "DependencyEdge",
"description": "Dependency tree parse for this token."
- },
- "lemma": {
- "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
- "type": "string"
}
},
- "id": "Token"
+ "id": "Token",
+ "description": "Represents the smallest syntactic building block of the text.",
+ "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",
@@ -893,13 +426,484 @@
"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"
+ },
+ "EntityMention": {
+ "properties": {
+ "text": {
+ "description": "The mention text.",
+ "$ref": "TextSpan"
+ },
+ "type": {
+ "enum": [
+ "TYPE_UNKNOWN",
+ "PROPER",
+ "COMMON"
+ ],
+ "description": "The type of the entity mention.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Proper name",
+ "Common noun (or noun compound)"
+ ]
+ }
+ },
+ "id": "EntityMention",
+ "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
+ "type": "object"
+ },
+ "Features": {
+ "properties": {
+ "extractSyntax": {
+ "description": "Extract syntax information.",
+ "type": "boolean"
+ },
+ "extractDocumentSentiment": {
+ "description": "Extract document-level sentiment.",
+ "type": "boolean"
+ },
+ "extractEntities": {
+ "description": "Extract entities.",
+ "type": "boolean"
+ }
+ },
+ "id": "Features",
+ "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
+ "type": "object"
+ },
+ "Document": {
+ "description": "################################################################ #\n\nRepresents the input to API methods.",
+ "type": "object",
+ "properties": {
+ "gcsContentUri": {
+ "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
+ "type": "string"
+ },
+ "language": {
+ "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
+ "type": "string"
+ },
+ "type": {
+ "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"
+ },
+ "Sentence": {
+ "properties": {
+ "sentiment": {
+ "$ref": "Sentiment",
+ "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence."
+ },
+ "text": {
+ "description": "The sentence text.",
+ "$ref": "TextSpan"
+ }
+ },
+ "id": "Sentence",
+ "description": "Represents a sentence in the input document.",
+ "type": "object"
+ },
+ "Sentiment": {
+ "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
+ "type": "object",
+ "properties": {
+ "magnitude": {
+ "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
+ "format": "float",
+ "type": "number"
+ },
+ "polarity": {
+ "description": "DEPRECATED FIELD - This field is being deprecated in\nfavor of score. Please refer to our documentation at\nhttps://cloud.google.com/natural-language/docs for more information.",
+ "format": "float",
+ "type": "number"
+ },
+ "score": {
+ "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "Sentiment"
+ },
+ "AnalyzeEntitiesRequest": {
+ "properties": {
+ "encodingType": {
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string"
+ },
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ }
+ },
+ "id": "AnalyzeEntitiesRequest",
+ "description": "The entity analysis request message.",
+ "type": "object"
+ },
+ "PartOfSpeech": {
+ "properties": {
+ "form": {
+ "enumDescriptions": [
+ "Form is not applicable in the analyzed language or is not predicted.",
+ "Adnomial",
+ "Auxiliary",
+ "Complementizer",
+ "Final ending",
+ "Gerund",
+ "Realis",
+ "Irrealis",
+ "Short form",
+ "Long form",
+ "Order form",
+ "Specific form"
+ ],
+ "enum": [
+ "FORM_UNKNOWN",
+ "ADNOMIAL",
+ "AUXILIARY",
+ "COMPLEMENTIZER",
+ "FINAL_ENDING",
+ "GERUND",
+ "REALIS",
+ "IRREALIS",
+ "SHORT",
+ "LONG",
+ "ORDER",
+ "SPECIFIC"
+ ],
+ "description": "The grammatical form.",
+ "type": "string"
+ },
+ "number": {
+ "enum": [
+ "NUMBER_UNKNOWN",
+ "SINGULAR",
+ "PLURAL",
+ "DUAL"
+ ],
+ "description": "The grammatical number.",
+ "type": "string",
+ "enumDescriptions": [
+ "Number is not applicable in the analyzed language or is not predicted.",
+ "Singular",
+ "Plural",
+ "Dual"
+ ]
+ },
+ "voice": {
+ "enumDescriptions": [
+ "Voice is not applicable in the analyzed language or is not predicted.",
+ "Active",
+ "Causative",
+ "Passive"
+ ],
+ "enum": [
+ "VOICE_UNKNOWN",
+ "ACTIVE",
+ "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"
+ ]
+ },
+ "proper": {
+ "enum": [
+ "PROPER_UNKNOWN",
+ "PROPER",
+ "NOT_PROPER"
+ ],
+ "description": "The grammatical properness.",
+ "type": "string",
+ "enumDescriptions": [
+ "Proper is not applicable in the analyzed language or is not predicted.",
+ "Proper",
+ "Not proper"
+ ]
+ },
+ "case": {
+ "enumDescriptions": [
+ "Case is not applicable in the analyzed language or is not predicted.",
+ "Accusative",
+ "Adverbial",
+ "Complementive",
+ "Dative",
+ "Genitive",
+ "Instrumental",
+ "Locative",
+ "Nominative",
+ "Oblique",
+ "Partitive",
+ "Prepositional",
+ "Reflexive",
+ "Relative",
+ "Vocative"
+ ],
+ "enum": [
+ "CASE_UNKNOWN",
+ "ACCUSATIVE",
+ "ADVERBIAL",
+ "COMPLEMENTIVE",
+ "DATIVE",
+ "GENITIVE",
+ "INSTRUMENTAL",
+ "LOCATIVE",
+ "NOMINATIVE",
+ "OBLIQUE",
+ "PARTITIVE",
+ "PREPOSITIONAL",
+ "REFLEXIVE_CASE",
+ "RELATIVE_CASE",
+ "VOCATIVE"
+ ],
+ "description": "The grammatical case.",
+ "type": "string"
+ },
+ "tense": {
+ "enum": [
+ "TENSE_UNKNOWN",
+ "CONDITIONAL_TENSE",
+ "FUTURE",
+ "PAST",
+ "PRESENT",
+ "IMPERFECT",
+ "PLUPERFECT"
+ ],
+ "description": "The grammatical tense.",
+ "type": "string",
+ "enumDescriptions": [
+ "Tense is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Future",
+ "Past",
+ "Present",
+ "Imperfect",
+ "Pluperfect"
+ ]
+ },
+ "reciprocity": {
+ "enumDescriptions": [
+ "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
+ "Reciprocal",
+ "Non-reciprocal"
+ ],
+ "enum": [
+ "RECIPROCITY_UNKNOWN",
+ "RECIPROCAL",
+ "NON_RECIPROCAL"
+ ],
+ "description": "The grammatical reciprocity.",
+ "type": "string"
+ }
+ },
+ "id": "PartOfSpeech",
+ "description": "Represents part of speech information for a token.",
+ "type": "object"
+ },
+ "AnalyzeSyntaxRequest": {
+ "description": "The syntax analysis request message.",
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string"
+ },
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ }
+ },
+ "id": "AnalyzeSyntaxRequest"
+ },
+ "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": {
+ "description": "The entity analysis response message.",
+ "type": "object",
+ "properties": {
+ "entities": {
+ "description": "The recognized entities in the input document.",
+ "type": "array",
+ "items": {
+ "$ref": "Entity"
+ }
+ },
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ }
+ },
+ "id": "AnalyzeEntitiesResponse"
}
},
"protocol": "rest",
@@ -911,11 +915,11 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-language": {
- "description": "Apply machine learning models to reveal the structure and meaning of text"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-language": {
+ "description": "Apply machine learning models to reveal the structure and meaning of text"
}
}
}
@@ -929,26 +933,13 @@
"resources": {
"documents": {
"methods": {
- "annotateText": {
- "path": "v1beta1/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"
- },
- "response": {
- "$ref": "AnnotateTextResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta1/documents:annotateText"
- },
"analyzeEntities": {
+ "path": "v1beta1/documents:analyzeEntities",
+ "id": "language.documents.analyzeEntities",
+ "request": {
+ "$ref": "AnalyzeEntitiesRequest"
+ },
+ "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
"response": {
"$ref": "AnalyzeEntitiesResponse"
},
@@ -959,112 +950,98 @@
"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",
- "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."
+ "flatPath": "v1beta1/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.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"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",
- "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."
+ "path": "v1beta1/documents:analyzeSyntax"
},
"analyzeSentiment": {
- "request": {
- "$ref": "AnalyzeSentimentRequest"
- },
- "description": "Analyzes the sentiment of the provided text.",
"response": {
"$ref": "AnalyzeSentimentResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
+ "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"
+ }
+ },
+ "annotateText": {
+ "response": {
+ "$ref": "AnnotateTextResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/documents:analyzeSentiment",
- "path": "v1beta1/documents:analyzeSentiment",
- "id": "language.documents.analyzeSentiment"
+ "flatPath": "v1beta1/documents:annotateText",
+ "path": "v1beta1/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."
}
}
}
},
"parameters": {
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1072,38 +1049,61 @@
],
"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.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"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.",
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
"type": "string",
"location": "query"
},
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
"pp": {
"location": "query",
"description": "Pretty-print response.",
"type": "boolean",
"default": "true"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
}
},
"version": "v1beta1",
"baseUrl": "https://language.googleapis.com/",
+ "servicePath": "",
"kind": "discovery#restDescription",
"description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
- "servicePath": "",
- "basePath": "",
- "revision": "20180121",
- "documentationLink": "https://cloud.google.com/natural-language/",
- "id": "language:v1beta1",
- "discoveryVersion": "v1"
+ "basePath": ""
}
diff --git a/language/v1beta2/language-api.json b/language/v1beta2/language-api.json
index 49eb8af..b4fec32 100644
--- a/language/v1beta2/language-api.json
+++ b/language/v1beta2/language-api.json
@@ -1,391 +1,18 @@
{
- "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"
- }
- }
- }
- },
- "rootUrl": "https://language.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "language",
- "batchPath": "batch",
- "title": "Google Cloud Natural Language API",
- "ownerName": "Google",
- "resources": {
- "documents": {
- "methods": {
- "annotateText": {
- "description": "A convenience method that provides all syntax, sentiment, entity, and\nclassification features in one call.",
- "request": {
- "$ref": "AnnotateTextRequest"
- },
- "response": {
- "$ref": "AnnotateTextResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta2/documents:annotateText",
- "path": "v1beta2/documents:annotateText",
- "id": "language.documents.annotateText"
- },
- "classifyText": {
- "description": "Classifies a document into categories.",
- "request": {
- "$ref": "ClassifyTextRequest"
- },
- "response": {
- "$ref": "ClassifyTextResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta2/documents:classifyText",
- "path": "v1beta2/documents:classifyText",
- "id": "language.documents.classifyText"
- },
- "analyzeSentiment": {
- "response": {
- "$ref": "AnalyzeSentimentResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/documents:analyzeSentiment",
- "path": "v1beta2/documents:analyzeSentiment",
- "id": "language.documents.analyzeSentiment",
- "request": {
- "$ref": "AnalyzeSentimentRequest"
- },
- "description": "Analyzes the sentiment of the provided text."
- },
- "analyzeEntitySentiment": {
- "request": {
- "$ref": "AnalyzeEntitySentimentRequest"
- },
- "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions.",
- "response": {
- "$ref": "AnalyzeEntitySentimentResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/documents:analyzeEntitySentiment",
- "path": "v1beta2/documents:analyzeEntitySentiment",
- "id": "language.documents.analyzeEntitySentiment"
- },
- "analyzeEntities": {
- "flatPath": "v1beta2/documents:analyzeEntities",
- "path": "v1beta2/documents:analyzeEntities",
- "id": "language.documents.analyzeEntities",
- "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
- "request": {
- "$ref": "AnalyzeEntitiesRequest"
- },
- "response": {
- "$ref": "AnalyzeEntitiesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {}
- },
- "analyzeSyntax": {
- "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",
- "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."
- }
- }
- }
- },
- "parameters": {
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- }
- },
- "version": "v1beta2",
- "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": "20180121",
- "documentationLink": "https://cloud.google.com/natural-language/",
- "id": "language:v1beta2",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "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": {
- "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": {
- "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"
- }
- }
- },
- "id": "Entity"
- },
- "AnnotateTextRequest": {
- "properties": {
- "features": {
- "description": "The enabled features.",
- "$ref": "Features"
- },
- "encodingType": {
- "type": "string",
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets."
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
- }
- },
- "id": "AnnotateTextRequest",
- "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
- "type": "object"
- },
- "AnalyzeSentimentRequest": {
- "description": "The sentiment analysis request message.",
- "type": "object",
- "properties": {
- "encodingType": {
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.",
- "type": "string"
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
- }
- },
- "id": "AnalyzeSentimentRequest"
- },
- "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"
- },
"Features": {
+ "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
+ "type": "object",
"properties": {
+ "extractEntities": {
+ "description": "Extract entities.",
+ "type": "boolean"
+ },
"classifyText": {
- "type": "boolean",
- "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)."
+ "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.",
@@ -398,23 +25,17 @@
"extractEntitySentiment": {
"description": "Extract entities and their associated sentiment.",
"type": "boolean"
- },
- "extractEntities": {
- "description": "Extract entities.",
- "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"
+ "id": "Features"
},
"Document": {
"description": "################################################################ #\n\nRepresents the input to API methods.",
"type": "object",
"properties": {
"language": {
- "type": "string",
- "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned."
+ "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
+ "type": "string"
},
"type": {
"description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
@@ -442,11 +63,12 @@
"id": "Document"
},
"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.",
@@ -458,56 +80,48 @@
"UTF8",
"UTF16",
"UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
+ ]
},
"document": {
"$ref": "Document",
"description": "Input document."
}
- }
+ },
+ "id": "AnalyzeEntitiesRequest"
},
"ClassifyTextRequest": {
- "properties": {
- "document": {
- "description": "Input document.",
- "$ref": "Document"
- }
- },
- "id": "ClassifyTextRequest",
"description": "The document classification request message.",
- "type": "object"
- },
- "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"
- },
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ }
+ },
+ "id": "ClassifyTextRequest"
+ },
+ "AnalyzeEntitySentimentResponse": {
+ "properties": {
"entities": {
"description": "The recognized entities in the input document with associated sentiments.",
"type": "array",
"items": {
"$ref": "Entity"
}
+ },
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
}
},
- "id": "AnalyzeEntitySentimentResponse"
+ "id": "AnalyzeEntitySentimentResponse",
+ "description": "The entity-level sentiment analysis response message.",
+ "type": "object"
},
"AnalyzeSentimentResponse": {
"description": "The sentiment analysis response message.",
"type": "object",
"properties": {
- "sentences": {
- "description": "The sentiment for all the sentences in the document.",
- "type": "array",
- "items": {
- "$ref": "Sentence"
- }
- },
"documentSentiment": {
"$ref": "Sentiment",
"description": "The overall sentiment of the input document."
@@ -515,25 +129,29 @@
"language": {
"description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
"type": "string"
+ },
+ "sentences": {
+ "description": "The sentiment for all the sentences in the document.",
+ "type": "array",
+ "items": {
+ "$ref": "Sentence"
+ }
}
},
"id": "AnalyzeSentimentResponse"
},
"AnalyzeSyntaxResponse": {
- "id": "AnalyzeSyntaxResponse",
- "description": "The syntax analysis response message.",
- "type": "object",
"properties": {
"language": {
"description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
"type": "string"
},
"sentences": {
+ "description": "Sentences in the input document.",
"type": "array",
"items": {
"$ref": "Sentence"
- },
- "description": "Sentences in the input document."
+ }
},
"tokens": {
"description": "Tokens, along with their syntactic information, in the input document.",
@@ -542,25 +160,19 @@
"$ref": "Token"
}
}
- }
+ },
+ "id": "AnalyzeSyntaxResponse",
+ "description": "The syntax analysis response message.",
+ "type": "object"
},
"AnnotateTextResponse": {
- "description": "The text annotations response message.",
- "type": "object",
"properties": {
- "entities": {
- "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
- "type": "array",
- "items": {
- "$ref": "Entity"
- }
- },
"sentences": {
+ "description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
"type": "array",
"items": {
"$ref": "Sentence"
- },
- "description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax."
+ }
},
"tokens": {
"description": "Tokens, along with their syntactic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
@@ -583,98 +195,27 @@
"language": {
"description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
"type": "string"
+ },
+ "entities": {
+ "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
+ "type": "array",
+ "items": {
+ "$ref": "Entity"
+ }
}
},
- "id": "AnnotateTextResponse"
+ "id": "AnnotateTextResponse",
+ "description": "The text annotations response message.",
+ "type": "object"
},
"DependencyEdge": {
"properties": {
+ "headTokenIndex": {
+ "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
+ "format": "int32",
+ "type": "integer"
+ },
"label": {
- "enum": [
- "UNKNOWN",
- "ABBREV",
- "ACOMP",
- "ADVCL",
- "ADVMOD",
- "AMOD",
- "APPOS",
- "ATTR",
- "AUX",
- "AUXPASS",
- "CC",
- "CCOMP",
- "CONJ",
- "CSUBJ",
- "CSUBJPASS",
- "DEP",
- "DET",
- "DISCOURSE",
- "DOBJ",
- "EXPL",
- "GOESWITH",
- "IOBJ",
- "MARK",
- "MWE",
- "MWV",
- "NEG",
- "NN",
- "NPADVMOD",
- "NSUBJ",
- "NSUBJPASS",
- "NUM",
- "NUMBER",
- "P",
- "PARATAXIS",
- "PARTMOD",
- "PCOMP",
- "POBJ",
- "POSS",
- "POSTNEG",
- "PRECOMP",
- "PRECONJ",
- "PREDET",
- "PREF",
- "PREP",
- "PRONL",
- "PRT",
- "PS",
- "QUANTMOD",
- "RCMOD",
- "RCMODREL",
- "RDROP",
- "REF",
- "REMNANT",
- "REPARANDUM",
- "ROOT",
- "SNUM",
- "SUFF",
- "TMOD",
- "TOPIC",
- "VMOD",
- "VOCATIVE",
- "XCOMP",
- "SUFFIX",
- "TITLE",
- "ADVPHMOD",
- "AUXCAUS",
- "AUXVV",
- "DTMOD",
- "FOREIGN",
- "KW",
- "LIST",
- "NOMC",
- "NOMCSUBJ",
- "NOMCSUBJPASS",
- "NUMC",
- "COP",
- "DISLOCATED",
- "ASP",
- "GMOD",
- "GOBJ",
- "INFMOD",
- "MES",
- "NCOMP"
- ],
"description": "The parse label for the token.",
"type": "string",
"enumDescriptions": [
@@ -761,45 +302,99 @@
"Infinitival modifier",
"Measure",
"Nominal complement of a noun"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "ABBREV",
+ "ACOMP",
+ "ADVCL",
+ "ADVMOD",
+ "AMOD",
+ "APPOS",
+ "ATTR",
+ "AUX",
+ "AUXPASS",
+ "CC",
+ "CCOMP",
+ "CONJ",
+ "CSUBJ",
+ "CSUBJPASS",
+ "DEP",
+ "DET",
+ "DISCOURSE",
+ "DOBJ",
+ "EXPL",
+ "GOESWITH",
+ "IOBJ",
+ "MARK",
+ "MWE",
+ "MWV",
+ "NEG",
+ "NN",
+ "NPADVMOD",
+ "NSUBJ",
+ "NSUBJPASS",
+ "NUM",
+ "NUMBER",
+ "P",
+ "PARATAXIS",
+ "PARTMOD",
+ "PCOMP",
+ "POBJ",
+ "POSS",
+ "POSTNEG",
+ "PRECOMP",
+ "PRECONJ",
+ "PREDET",
+ "PREF",
+ "PREP",
+ "PRONL",
+ "PRT",
+ "PS",
+ "QUANTMOD",
+ "RCMOD",
+ "RCMODREL",
+ "RDROP",
+ "REF",
+ "REMNANT",
+ "REPARANDUM",
+ "ROOT",
+ "SNUM",
+ "SUFF",
+ "TMOD",
+ "TOPIC",
+ "VMOD",
+ "VOCATIVE",
+ "XCOMP",
+ "SUFFIX",
+ "TITLE",
+ "ADVPHMOD",
+ "AUXCAUS",
+ "AUXVV",
+ "DTMOD",
+ "FOREIGN",
+ "KW",
+ "LIST",
+ "NOMC",
+ "NOMCSUBJ",
+ "NOMCSUBJPASS",
+ "NUMC",
+ "COP",
+ "DISLOCATED",
+ "ASP",
+ "GMOD",
+ "GOBJ",
+ "INFMOD",
+ "MES",
+ "NCOMP"
]
- },
- "headTokenIndex": {
- "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
- "format": "int32",
- "type": "integer"
}
},
"id": "DependencyEdge",
"description": "Represents dependency parse tree information for a token.",
"type": "object"
},
- "Token": {
- "description": "Represents the smallest syntactic building block of the text.",
- "type": "object",
- "properties": {
- "partOfSpeech": {
- "$ref": "PartOfSpeech",
- "description": "Parts of speech tag for this token."
- },
- "text": {
- "description": "The token text.",
- "$ref": "TextSpan"
- },
- "dependencyEdge": {
- "$ref": "DependencyEdge",
- "description": "Dependency tree parse for this token."
- },
- "lemma": {
- "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
- "type": "string"
- }
- },
- "id": "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.",
@@ -810,7 +405,33 @@
"description": "The content of the output text.",
"type": "string"
}
- }
+ },
+ "id": "TextSpan",
+ "description": "Represents an output piece of text.",
+ "type": "object"
+ },
+ "Token": {
+ "description": "Represents the smallest syntactic building block of the text.",
+ "type": "object",
+ "properties": {
+ "text": {
+ "$ref": "TextSpan",
+ "description": "The token text."
+ },
+ "dependencyEdge": {
+ "$ref": "DependencyEdge",
+ "description": "Dependency tree parse for this token."
+ },
+ "lemma": {
+ "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
+ "type": "string"
+ },
+ "partOfSpeech": {
+ "description": "Parts of speech tag for this token.",
+ "$ref": "PartOfSpeech"
+ }
+ },
+ "id": "Token"
},
"ClassifyTextResponse": {
"description": "The document classification response message.",
@@ -827,14 +448,7 @@
"id": "ClassifyTextResponse"
},
"EntityMention": {
- "id": "EntityMention",
- "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
- "type": "object",
"properties": {
- "sentiment": {
- "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document.",
- "$ref": "Sentiment"
- },
"text": {
"$ref": "TextSpan",
"description": "The mention text."
@@ -852,8 +466,15 @@
"PROPER",
"COMMON"
]
+ },
+ "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."
}
- }
+ },
+ "id": "EntityMention",
+ "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
+ "type": "object"
},
"Sentence": {
"description": "Represents a sentence in the input document.",
@@ -864,8 +485,8 @@
"$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"
@@ -880,18 +501,26 @@
"type": "number"
},
"magnitude": {
- "type": "number",
"description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
- "format": "float"
+ "format": "float",
+ "type": "number"
}
},
"id": "Sentiment"
},
"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",
@@ -899,26 +528,90 @@
"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"
+ "id": "AnalyzeEntitySentimentRequest",
+ "description": "The entity-level sentiment analysis request message.",
+ "type": "object"
},
"PartOfSpeech": {
"description": "Represents part of speech information for a token.",
"type": "object",
"properties": {
+ "tag": {
+ "description": "The part of speech tag.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Adjective",
+ "Adposition (preposition and postposition)",
+ "Adverb",
+ "Conjunction",
+ "Determiner",
+ "Noun (common and proper)",
+ "Cardinal number",
+ "Pronoun",
+ "Particle or other function word",
+ "Punctuation",
+ "Verb (all tenses and modes)",
+ "Other: foreign words, typos, abbreviations",
+ "Affix"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "ADJ",
+ "ADP",
+ "ADV",
+ "CONJ",
+ "DET",
+ "NOUN",
+ "NUM",
+ "PRON",
+ "PRT",
+ "PUNCT",
+ "VERB",
+ "X",
+ "AFFIX"
+ ]
+ },
+ "gender": {
+ "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": {
+ "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": {
+ "description": "The grammatical properness.",
+ "type": "string",
"enumDescriptions": [
"Proper is not applicable in the analyzed language or is not predicted.",
"Proper",
@@ -928,9 +621,7 @@
"PROPER_UNKNOWN",
"PROPER",
"NOT_PROPER"
- ],
- "description": "The grammatical properness.",
- "type": "string"
+ ]
},
"case": {
"enumDescriptions": [
@@ -971,15 +662,6 @@
"type": "string"
},
"tense": {
- "enum": [
- "TENSE_UNKNOWN",
- "CONDITIONAL_TENSE",
- "FUTURE",
- "PAST",
- "PRESENT",
- "IMPERFECT",
- "PLUPERFECT"
- ],
"description": "The grammatical tense.",
"type": "string",
"enumDescriptions": [
@@ -990,6 +672,15 @@
"Present",
"Imperfect",
"Pluperfect"
+ ],
+ "enum": [
+ "TENSE_UNKNOWN",
+ "CONDITIONAL_TENSE",
+ "FUTURE",
+ "PAST",
+ "PRESENT",
+ "IMPERFECT",
+ "PLUPERFECT"
]
},
"reciprocity": {
@@ -1007,8 +698,6 @@
]
},
"form": {
- "description": "The grammatical form.",
- "type": "string",
"enumDescriptions": [
"Form is not applicable in the analyzed language or is not predicted.",
"Adnomial",
@@ -1036,15 +725,11 @@
"LONG",
"ORDER",
"SPECIFIC"
- ]
+ ],
+ "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",
@@ -1052,15 +737,15 @@
"DUAL"
],
"description": "The grammatical number.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Number is not applicable in the analyzed language or is not predicted.",
+ "Singular",
+ "Plural",
+ "Dual"
+ ]
},
"voice": {
- "enumDescriptions": [
- "Voice is not applicable in the analyzed language or is not predicted.",
- "Active",
- "Causative",
- "Passive"
- ],
"enum": [
"VOICE_UNKNOWN",
"ACTIVE",
@@ -1068,15 +753,15 @@
"PASSIVE"
],
"description": "The grammatical voice.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Voice is not applicable in the analyzed language or is not predicted.",
+ "Active",
+ "Causative",
+ "Passive"
+ ]
},
"aspect": {
- "enumDescriptions": [
- "Aspect is not applicable in the analyzed language or is not predicted.",
- "Perfective",
- "Imperfective",
- "Progressive"
- ],
"enum": [
"ASPECT_UNKNOWN",
"PERFECTIVE",
@@ -1084,7 +769,13 @@
"PROGRESSIVE"
],
"description": "The grammatical aspect.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Aspect is not applicable in the analyzed language or is not predicted.",
+ "Perfective",
+ "Imperfective",
+ "Progressive"
+ ]
},
"mood": {
"description": "The grammatical mood.",
@@ -1107,83 +798,11 @@
"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": {
- "enum": [
- "GENDER_UNKNOWN",
- "FEMININE",
- "MASCULINE",
- "NEUTER"
- ],
- "description": "The grammatical gender.",
- "type": "string",
- "enumDescriptions": [
- "Gender is not applicable in the analyzed language or is not predicted.",
- "Feminine",
- "Masculine",
- "Neuter"
- ]
- },
- "person": {
- "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"
}
},
"id": "PartOfSpeech"
},
"ClassificationCategory": {
- "description": "Represents a category returned from the text classifier.",
- "type": "object",
"properties": {
"confidence": {
"description": "The classifier's confidence of the category. Number represents how certain\nthe classifier is that this category represents the given text.",
@@ -1195,12 +814,19 @@
"type": "string"
}
},
- "id": "ClassificationCategory"
+ "id": "ClassificationCategory",
+ "description": "Represents a category returned from the text classifier.",
+ "type": "object"
},
"AnalyzeSyntaxRequest": {
- "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",
@@ -1208,13 +834,7 @@
"UTF32"
],
"description": "The encoding type used by the API to calculate offsets.",
- "type": "string",
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ]
+ "type": "string"
},
"document": {
"$ref": "Document",
@@ -1222,7 +842,8 @@
}
},
"id": "AnalyzeSyntaxRequest",
- "description": "The syntax analysis request message."
+ "description": "The syntax analysis request message.",
+ "type": "object"
},
"AnalyzeEntitiesResponse": {
"description": "The entity analysis response message.",
@@ -1233,19 +854,398 @@
"type": "string"
},
"entities": {
+ "description": "The recognized entities in the input document.",
"type": "array",
"items": {
"$ref": "Entity"
- },
- "description": "The recognized entities in the input document."
+ }
}
},
"id": "AnalyzeEntitiesResponse"
+ },
+ "Entity": {
+ "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
+ "type": "object",
+ "properties": {
+ "mentions": {
+ "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityMention"
+ }
+ },
+ "name": {
+ "description": "The representative name for the entity.",
+ "type": "string"
+ },
+ "type": {
+ "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": {
+ "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."
+ }
+ },
+ "id": "Entity"
+ },
+ "AnnotateTextRequest": {
+ "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "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"
+ },
+ "features": {
+ "description": "The enabled features.",
+ "$ref": "Features"
+ }
+ },
+ "id": "AnnotateTextRequest"
+ },
+ "AnalyzeSentimentRequest": {
+ "description": "The 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",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.",
+ "type": "string"
+ }
+ },
+ "id": "AnalyzeSentimentRequest"
+ },
+ "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"
}
},
"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": "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"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://language.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "language",
+ "batchPath": "batch",
+ "title": "Google Cloud Natural Language API",
+ "ownerName": "Google",
+ "resources": {
+ "documents": {
+ "methods": {
+ "annotateText": {
+ "request": {
+ "$ref": "AnnotateTextRequest"
+ },
+ "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",
+ "path": "v1beta2/documents:annotateText",
+ "id": "language.documents.annotateText"
+ },
+ "classifyText": {
+ "flatPath": "v1beta2/documents:classifyText",
+ "id": "language.documents.classifyText",
+ "path": "v1beta2/documents:classifyText",
+ "request": {
+ "$ref": "ClassifyTextRequest"
+ },
+ "description": "Classifies a document into categories.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ClassifyTextResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "analyzeSentiment": {
+ "request": {
+ "$ref": "AnalyzeSentimentRequest"
+ },
+ "description": "Analyzes the sentiment of the provided text.",
+ "response": {
+ "$ref": "AnalyzeSentimentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/documents:analyzeSentiment",
+ "path": "v1beta2/documents:analyzeSentiment",
+ "id": "language.documents.analyzeSentiment"
+ },
+ "analyzeEntitySentiment": {
+ "response": {
+ "$ref": "AnalyzeEntitySentimentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/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."
+ },
+ "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": "v1beta2/documents:analyzeEntities",
+ "path": "v1beta2/documents:analyzeEntities",
+ "id": "language.documents.analyzeEntities"
+ },
+ "analyzeSyntax": {
+ "response": {
+ "$ref": "AnalyzeSyntaxResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/documents:analyzeSyntax",
+ "path": "v1beta2/documents:analyzeSyntax",
+ "id": "language.documents.analyzeSyntax",
+ "request": {
+ "$ref": "AnalyzeSyntaxRequest"
+ },
+ "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "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"
+ }
+ },
+ "version": "v1beta2",
+ "baseUrl": "https://language.googleapis.com/",
+ "servicePath": "",
+ "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "documentationLink": "https://cloud.google.com/natural-language/",
+ "revision": "20180121",
+ "id": "language:v1beta2"
}
diff --git a/logging/v2/logging-api.json b/logging/v2/logging-api.json
index 4ea1d88..dece5ce 100644
--- a/logging/v2/logging-api.json
+++ b/logging/v2/logging-api.json
@@ -1,17 +1,219 @@
{
- "baseUrl": "https://logging.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Writes log entries and manages your Stackdriver Logging configuration.",
- "servicePath": "",
"basePath": "",
- "revision": "20180123",
"id": "logging:v2",
"documentationLink": "https://cloud.google.com/logging/docs/",
+ "revision": "20180123",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "MonitoredResource": {
+ "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
+ "type": "object"
+ }
+ },
+ "id": "MonitoredResource"
+ },
+ "LogSink": {
+ "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.",
+ "type": "object",
+ "properties": {
+ "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."
+ },
+ "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"
+ },
+ "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": {
+ "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."
+ },
+ "endTime": {
+ "description": "Deprecated. This field is ignored when creating or updating sinks.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "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"
+ },
+ "outputVersionFormat": {
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified format version that will default to V2.",
+ "LogEntry version 2 format.",
+ "LogEntry version 1 format."
+ ],
+ "enum": [
+ "VERSION_FORMAT_UNSPECIFIED",
+ "V2",
+ "V1"
+ ],
+ "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"
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of log names. For example, \"projects/my-project/syslog\" or \"organizations/123/cloudresourcemanager.googleapis.com%2Factivity\"."
+ }
+ },
+ "id": "ListLogsResponse"
+ },
+ "HttpRequest": {
+ "type": "object",
+ "properties": {
+ "cacheFillBytes": {
+ "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
+ "format": "int64",
+ "type": "string"
+ },
+ "requestMethod": {
+ "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
+ "type": "string"
+ },
+ "requestSize": {
+ "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
+ "format": "int64",
+ "type": "string"
+ },
+ "responseSize": {
+ "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
+ "format": "int64",
+ "type": "string"
+ },
+ "protocol": {
+ "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"",
+ "type": "string"
+ },
+ "requestUrl": {
+ "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\".",
+ "type": "string"
+ },
+ "remoteIp": {
+ "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".",
+ "type": "string"
+ },
+ "serverIp": {
+ "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.",
+ "type": "string"
+ },
+ "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"
+ },
+ "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",
+ "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message."
+ },
+ "ListSinksResponse": {
+ "description": "Result returned from ListSinks.",
+ "type": "object",
+ "properties": {
+ "sinks": {
+ "type": "array",
+ "items": {
+ "$ref": "LogSink"
+ },
+ "description": "A list of sinks."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken."
+ }
+ },
+ "id": "ListSinksResponse"
+ },
+ "MonitoredResourceDescriptor": {
+ "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "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": {
+ "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": {
+ "type": "string",
+ "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\"."
+ },
+ "displayName": {
+ "type": "string",
+ "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\"."
+ },
+ "description": {
+ "type": "string",
+ "description": "Optional. A detailed description of the monitored resource type that might be used in documentation."
+ }
+ },
+ "id": "MonitoredResourceDescriptor"
+ },
"LogEntrySourceLocation": {
- "description": "Additional information about the source code location that produced the log entry.",
"type": "object",
"properties": {
"file": {
@@ -19,8 +221,8 @@
"type": "string"
},
"function": {
- "description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).",
- "type": "string"
+ "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)."
},
"line": {
"description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.",
@@ -28,7 +230,8 @@
"type": "string"
}
},
- "id": "LogEntrySourceLocation"
+ "id": "LogEntrySourceLocation",
+ "description": "Additional information about the source code location that produced the log entry."
},
"ListLogEntriesResponse": {
"description": "Result returned from ListLogEntries.",
@@ -49,11 +252,9 @@
"id": "ListLogEntriesResponse"
},
"LogLine": {
- "description": "Application log line emitted while processing a request.",
"type": "object",
"properties": {
"severity": {
- "description": "Severity of this log entry.",
"type": "string",
"enumDescriptions": [
"(0) The log entry has no assigned severity level.",
@@ -76,7 +277,8 @@
"CRITICAL",
"ALERT",
"EMERGENCY"
- ]
+ ],
+ "description": "Severity of this log entry."
},
"logMessage": {
"type": "string",
@@ -87,34 +289,35 @@
"description": "Where in the source code this log message was written."
},
"time": {
- "type": "string",
"description": "Approximate time when this log entry was made.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "LogLine"
+ "id": "LogLine",
+ "description": "Application log line emitted while processing a request."
},
"Linear": {
- "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).",
"type": "object",
"properties": {
+ "offset": {
+ "type": "number",
+ "description": "Lower bound of the first bucket.",
+ "format": "double"
+ },
"numFiniteBuckets": {
+ "type": "integer",
"description": "Must be greater than 0.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"width": {
"description": "Must be greater than 0.",
"format": "double",
"type": "number"
- },
- "offset": {
- "description": "Lower bound of the first bucket.",
- "format": "double",
- "type": "number"
}
},
- "id": "Linear"
+ "id": "Linear",
+ "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1))."
},
"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 {}.",
@@ -123,6 +326,8 @@
"id": "Empty"
},
"SourceLocation": {
+ "description": "Specifies a location in a source code file.",
+ "type": "object",
"properties": {
"file": {
"type": "string",
@@ -138,74 +343,72 @@
"type": "string"
}
},
- "id": "SourceLocation",
- "description": "Specifies a location in a source code file.",
- "type": "object"
+ "id": "SourceLocation"
},
"ListLogEntriesRequest": {
"description": "The parameters to ListLogEntries.",
"type": "object",
"properties": {
- "projectIds": {
+ "pageToken": {
+ "type": "string",
+ "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."
+ },
+ "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."
+ },
+ "resourceNames": {
"type": "array",
"items": {
"type": "string"
},
- "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."
+ "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."
},
- "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": {
- "type": "integer",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
- "format": "int32"
- },
- "orderBy": {
- "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.",
- "type": "string"
- },
- "resourceNames": {
- "description": "Required. Names of one or more parent resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nProjects listed in the project_ids field are added to this list.",
+ "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",
"items": {
"type": "string"
}
+ },
+ "filter": {
+ "type": "string",
+ "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."
}
},
"id": "ListLogEntriesRequest"
},
"Explicit": {
- "id": "Explicit",
- "description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
"type": "object",
"properties": {
"bounds": {
- "description": "The values must be monotonically increasing.",
"type": "array",
"items": {
- "format": "double",
- "type": "number"
- }
+ "type": "number",
+ "format": "double"
+ },
+ "description": "The values must be monotonically increasing."
}
- }
+ },
+ "id": "Explicit",
+ "description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets."
},
"SourceReference": {
"description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
"type": "object",
"properties": {
- "repository": {
- "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
- "type": "string"
- },
"revisionId": {
"description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
"type": "string"
+ },
+ "repository": {
+ "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
+ "type": "string"
}
},
"id": "SourceReference"
@@ -221,14 +424,14 @@
"type": "object",
"properties": {
"growthFactor": {
+ "type": "number",
"description": "Must be greater than 1.",
- "format": "double",
- "type": "number"
+ "format": "double"
},
"scale": {
+ "type": "number",
"description": "Must be greater than 0.",
- "format": "double",
- "type": "number"
+ "format": "double"
},
"numFiniteBuckets": {
"description": "Must be greater than 0.",
@@ -261,11 +464,11 @@
"type": "boolean"
},
"labels": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.",
- "type": "object"
+ "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",
@@ -276,35 +479,36 @@
"description": "The parameters to WriteLogEntries."
},
"LabelDescriptor": {
- "id": "LabelDescriptor",
- "description": "A description of a label.",
"type": "object",
"properties": {
+ "key": {
+ "description": "The label key.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "A human-readable description for the label."
+ },
"valueType": {
+ "enum": [
+ "STRING",
+ "BOOL",
+ "INT64"
+ ],
"description": "The type of data that can be assigned to the label.",
"type": "string",
"enumDescriptions": [
"A variable-length string. This is the default.",
"Boolean; true or false.",
"A 64-bit signed integer."
- ],
- "enum": [
- "STRING",
- "BOOL",
- "INT64"
]
- },
- "key": {
- "description": "The label key.",
- "type": "string"
- },
- "description": {
- "description": "A human-readable description for the label.",
- "type": "string"
}
- }
+ },
+ "id": "LabelDescriptor",
+ "description": "A description of a label."
},
"BucketOptions": {
+ "type": "object",
"properties": {
"exponentialBuckets": {
"$ref": "Exponential",
@@ -315,43 +519,66 @@
"description": "The linear bucket."
},
"explicitBuckets": {
- "description": "The explicit buckets.",
- "$ref": "Explicit"
+ "$ref": "Explicit",
+ "description": "The explicit buckets."
}
},
"id": "BucketOptions",
- "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
- "type": "object"
+ "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite."
},
"ListLogMetricsResponse": {
- "description": "Result returned from ListLogMetrics.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
- },
"metrics": {
- "description": "A list of logs-based metrics.",
"type": "array",
"items": {
"$ref": "LogMetric"
- }
+ },
+ "description": "A list of logs-based metrics."
+ },
+ "nextPageToken": {
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
+ "type": "string"
}
},
- "id": "ListLogMetricsResponse"
+ "id": "ListLogMetricsResponse",
+ "description": "Result returned from ListLogMetrics."
},
"MetricDescriptor": {
"description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
"type": "object",
"properties": {
- "metricKind": {
+ "name": {
+ "type": "string",
+ "description": "The resource name of the metric descriptor."
+ },
+ "type": {
+ "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n",
+ "type": "string"
+ },
+ "valueType": {
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ],
+ "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.",
+ "type": "string",
"enumDescriptions": [
"Do not use this default value.",
- "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."
- ],
+ "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a Distribution.",
+ "The value is money."
+ ]
+ },
+ "metricKind": {
"enum": [
"METRIC_KIND_UNSPECIFIED",
"GAUGE",
@@ -359,7 +586,13 @@
"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"
+ "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."
+ ]
},
"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.",
@@ -379,47 +612,16 @@
"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"
},
"LogEntry": {
- "description": "An individual entry in a log.",
"type": "object",
"properties": {
"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"
+ "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.",
@@ -432,8 +634,8 @@
"type": "string"
},
"logName": {
- "description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\nA project number may optionally be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.",
- "type": "string"
+ "type": "string",
+ "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."
},
"httpRequest": {
"$ref": "HttpRequest",
@@ -444,12 +646,12 @@
"description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error."
},
"jsonPayload": {
- "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"
- }
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
+ "type": "object"
},
"operation": {
"$ref": "LogEntryOperation",
@@ -465,22 +667,22 @@
},
"protoPayload": {
"additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
},
"description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.",
"type": "object"
},
+ "trace": {
+ "type": "string",
+ "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824"
+ },
"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"
- },
- "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"
+ "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry."
},
"severity": {
"enum": [
@@ -513,46 +715,21 @@
"description": "Optional. Source code location information associated with the log entry, if any."
}
},
- "id": "LogEntry"
+ "id": "LogEntry",
+ "description": "An individual entry in a log."
},
"RequestLog": {
+ "description": "Complete log information about a single HTTP request to an App Engine application.",
+ "type": "object",
"properties": {
- "versionId": {
- "description": "Version of the application that handled this request.",
- "type": "string"
- },
- "moduleId": {
- "description": "Module of the application that handled this request.",
- "type": "string"
- },
- "endTime": {
- "description": "Time when the request finished.",
- "format": "google-datetime",
- "type": "string"
- },
- "userAgent": {
- "description": "User agent that made the request.",
- "type": "string"
- },
- "wasLoadingRequest": {
- "description": "Whether this was a loading request for the instance.",
- "type": "boolean"
- },
- "sourceReference": {
- "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.",
- "type": "array",
- "items": {
- "$ref": "SourceReference"
- }
- },
"responseSize": {
+ "type": "string",
"description": "Size in bytes sent back to client by request.",
- "format": "int64",
- "type": "string"
+ "format": "int64"
},
"traceId": {
- "description": "Stackdriver Trace identifier for this request.",
- "type": "string"
+ "type": "string",
+ "description": "Stackdriver Trace identifier for this request."
},
"line": {
"description": "A list of log lines emitted by the application while serving this request.",
@@ -561,56 +738,56 @@
"$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"
},
"nickname": {
- "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.",
- "type": "string"
+ "type": "string",
+ "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21."
+ },
+ "pendingTime": {
+ "type": "string",
+ "description": "Time this request spent in the pending request queue.",
+ "format": "google-duration"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included."
},
"status": {
"description": "HTTP response status code. Example: 200, 404.",
"format": "int32",
"type": "integer"
},
- "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"
- },
"taskName": {
- "description": "Task name of the request, in the case of an offline request.",
- "type": "string"
+ "type": "string",
+ "description": "Task name of the request, in the case of an offline request."
},
"urlMapEntry": {
- "description": "File or class that handled the request.",
- "type": "string"
+ "type": "string",
+ "description": "File or class that handled the request."
},
"instanceIndex": {
+ "type": "integer",
"description": "If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"finished": {
"type": "boolean",
"description": "Whether this request is finished or active."
},
"host": {
- "description": "Internet host and port number of the resource being requested.",
- "type": "string"
+ "type": "string",
+ "description": "Internet host and port number of the resource being requested."
},
"httpVersion": {
"description": "HTTP version of request. Example: \"HTTP/1.1\".",
@@ -631,42 +808,78 @@
"type": "string"
},
"appId": {
- "description": "Application that handled this request.",
- "type": "string"
+ "type": "string",
+ "description": "Application that handled this request."
},
"appEngineRelease": {
- "description": "App Engine release version.",
- "type": "string"
+ "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",
- "type": "number"
+ "format": "double"
},
"instanceId": {
- "type": "string",
- "description": "An identifier for the instance that handled the request."
+ "description": "An identifier for the instance that handled the request.",
+ "type": "string"
},
"megaCycles": {
+ "type": "string",
"description": "Number of CPU megacycles used to process request.",
- "format": "int64",
- "type": "string"
+ "format": "int64"
},
"first": {
"description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.",
"type": "boolean"
+ },
+ "versionId": {
+ "description": "Version of the application that handled this request.",
+ "type": "string"
+ },
+ "moduleId": {
+ "type": "string",
+ "description": "Module of the application that handled this request."
+ },
+ "endTime": {
+ "description": "Time when the request finished.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "userAgent": {
+ "description": "User agent that made the request.",
+ "type": "string"
+ },
+ "wasLoadingRequest": {
+ "type": "boolean",
+ "description": "Whether this was a loading request for the instance."
+ },
+ "sourceReference": {
+ "type": "array",
+ "items": {
+ "$ref": "SourceReference"
+ },
+ "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories."
}
},
- "id": "RequestLog",
- "description": "Complete log information about a single HTTP request to an App Engine application.",
- "type": "object"
+ "id": "RequestLog"
},
"LogExclusion": {
+ "description": "Specifies a set of log entries that are not to be stored in Stackdriver Logging. If your project receives a large volume of logs, you might be able to use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Audit log entries and log entries from Amazon Web Services are never excluded.",
+ "type": "object",
"properties": {
+ "name": {
+ "type": "string",
+ "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."
+ },
+ "description": {
+ "description": "Optional. A description of this exclusion.",
+ "type": "string"
+ },
"filter": {
"type": "string",
"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"
@@ -674,98 +887,61 @@
"disabled": {
"description": "Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can use exclusions.patch to change the value of this field.",
"type": "boolean"
- },
- "name": {
- "description": "Required. A client-assigned identifier, such as \"load-balancer-exclusion\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.",
- "type": "string"
- },
- "description": {
- "description": "Optional. A description of this exclusion.",
- "type": "string"
}
},
- "id": "LogExclusion",
- "description": "Specifies a set of log entries that are not to be stored in Stackdriver Logging. If your project receives a large volume of logs, you might be able to use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Audit log entries and log entries from Amazon Web Services are never excluded.",
- "type": "object"
+ "id": "LogExclusion"
},
"ListMonitoredResourceDescriptorsResponse": {
"description": "Result returned from ListMonitoredResourceDescriptors.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
+ "type": "string"
+ },
"resourceDescriptors": {
"description": "A list of resource descriptors.",
"type": "array",
"items": {
"$ref": "MonitoredResourceDescriptor"
}
- },
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
}
},
"id": "ListMonitoredResourceDescriptorsResponse"
},
"ListExclusionsResponse": {
+ "description": "Result returned from ListExclusions.",
+ "type": "object",
"properties": {
"exclusions": {
- "description": "A list of exclusions.",
"type": "array",
"items": {
"$ref": "LogExclusion"
- }
+ },
+ "description": "A list of exclusions."
},
"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": "ListExclusionsResponse",
- "description": "Result returned from ListExclusions.",
- "type": "object"
- },
- "LogEntryOperation": {
- "type": "object",
- "properties": {
- "producer": {
- "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".",
- "type": "string"
- },
- "first": {
- "description": "Optional. Set this to True if this is the first log entry in the operation.",
- "type": "boolean"
- },
- "last": {
- "description": "Optional. Set this to True if this is the last log entry in the operation.",
- "type": "boolean"
- },
- "id": {
- "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
- "type": "string"
- }
- },
- "id": "LogEntryOperation",
- "description": "Additional information about a potentially long-running operation with which a log entry is associated."
+ "id": "ListExclusionsResponse"
},
"LogMetric": {
"description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.",
"type": "object",
"properties": {
- "description": {
- "description": "Optional. A description of this metric, which is used in documentation.",
- "type": "string"
+ "valueExtractor": {
+ "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": {
- "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"
+ "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\"."
},
"labelExtractors": {
"type": "object",
@@ -774,235 +950,55 @@
},
"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."
},
- "metricDescriptor": {
- "description": "Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of \"1\". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.",
- "$ref": "MetricDescriptor"
- },
"version": {
- "enum": [
- "V2",
- "V1"
- ],
- "description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.",
"type": "string",
"enumDescriptions": [
"Stackdriver Logging API v2.",
"Stackdriver Logging API v1."
- ]
+ ],
+ "enum": [
+ "V2",
+ "V1"
+ ],
+ "description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed."
+ },
+ "metricDescriptor": {
+ "$ref": "MetricDescriptor",
+ "description": "Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of \"1\". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description."
},
"filter": {
- "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters.",
- "type": "string"
+ "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."
}
},
"id": "LogMetric"
},
- "MonitoredResource": {
+ "LogEntryOperation": {
+ "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
+ "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"
+ "last": {
+ "type": "boolean",
+ "description": "Optional. Set this to True if this is the last log entry in the operation."
},
- "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",
- "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": {
- "properties": {
- "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"
- },
- "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": {
- "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": {
+ "id": {
"type": "string",
- "enumDescriptions": [
- "An unspecified format version that will default to V2.",
- "LogEntry version 2 format.",
- "LogEntry version 1 format."
- ],
- "enum": [
- "VERSION_FORMAT_UNSPECIFIED",
- "V2",
- "V1"
- ],
- "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.",
- "type": "object"
- },
- "ListLogsResponse": {
- "description": "Result returned from ListLogs.",
- "type": "object",
- "properties": {
- "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"
- }
+ "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation."
},
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
- }
- },
- "id": "ListLogsResponse"
- },
- "HttpRequest": {
- "type": "object",
- "properties": {
- "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"
+ "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\"."
},
- "userAgent": {
- "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".",
- "type": "string"
- },
- "cacheFillBytes": {
- "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
- "format": "int64",
- "type": "string"
- },
- "requestMethod": {
- "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
- "type": "string"
- },
- "protocol": {
- "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"",
- "type": "string"
- },
- "responseSize": {
- "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
- "format": "int64",
- "type": "string"
- },
- "requestSize": {
- "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
- "format": "int64",
- "type": "string"
- },
- "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.",
+ "first": {
+ "description": "Optional. Set this to True if this is the first log entry in the operation.",
"type": "boolean"
- },
- "cacheHit": {
- "description": "Whether or not an entity was served from cache (with or without validation).",
- "type": "boolean"
- },
- "cacheValidatedWithOriginServer": {
- "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.",
- "type": "boolean"
- },
- "status": {
- "description": "The response code indicating the status of response. Examples: 200, 404.",
- "format": "int32",
- "type": "integer"
- },
- "referer": {
- "description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
- "type": "string"
}
},
- "id": "HttpRequest",
- "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message."
- },
- "ListSinksResponse": {
- "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": {
- "type": "array",
- "items": {
- "$ref": "LogSink"
- },
- "description": "A list of sinks."
- }
- },
- "id": "ListSinksResponse",
- "description": "Result returned from ListSinks."
- },
- "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": {
- "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"
- }
- }
- },
- "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"
+ "id": "LogEntryOperation"
}
},
"protocol": "rest",
@@ -1014,9 +1010,6 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
},
@@ -1028,6 +1021,9 @@
},
"https://www.googleapis.com/auth/logging.write": {
"description": "Submit log data for your projects"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -1042,225 +1038,38 @@
"resources": {
"folders": {
"resources": {
- "exclusions": {
- "methods": {
- "delete": {
- "path": "v2/{+name}",
- "id": "logging.folders.exclusions.delete",
- "description": "Deletes an exclusion.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^folders/[^/]+/exclusions/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}"
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListExclusionsResponse"
- },
- "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 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/[^/]+$"
- }
- },
- "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",
- "description": "Lists all the exclusions in a parent resource."
- },
- "get": {
- "response": {
- "$ref": "LogExclusion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/exclusions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.folders.exclusions.get",
- "description": "Gets the description of an exclusion."
- },
- "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": {
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/exclusions/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\"."
- }
- },
- "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": {
- "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": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "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",
- "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."
- }
- }
- },
"logs": {
"methods": {
- "delete": {
- "path": "v2/{+logName}",
- "id": "logging.folders.logs.delete",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "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}"
- },
"list": {
"flatPath": "v2/folders/{foldersId}/logs",
"id": "logging.folders.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",
- "parameterOrder": [
- "parent"
- ],
"response": {
"$ref": "ListLogsResponse"
},
+ "parameterOrder": [
+ "parent"
+ ],
"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": "^folders/[^/]+$",
- "location": "path"
- },
"pageToken": {
"type": "string",
"location": "query",
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
},
"pageSize": {
+ "location": "query",
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
+ },
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
}
},
"scopes": [
@@ -1269,6 +1078,32 @@
"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": "^folders/[^/]+/logs/[^/]+$"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/logs/{logsId}",
+ "path": "v2/{+logName}",
+ "id": "logging.folders.logs.delete",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
}
}
},
@@ -1301,34 +1136,31 @@
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
},
"list": {
- "path": "v2/{+parent}/sinks",
- "id": "logging.folders.sinks.list",
- "description": "Lists sinks.",
+ "httpMethod": "GET",
"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": {
+ "required": true,
+ "type": "string",
"pattern": "^folders/[^/]+$",
"location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string"
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
},
"pageToken": {
+ "type": "string",
"location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32"
}
},
"scopes": [
@@ -1337,28 +1169,31 @@
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
],
- "flatPath": "v2/folders/{foldersId}/sinks"
+ "flatPath": "v2/folders/{foldersId}/sinks",
+ "id": "logging.folders.sinks.list",
+ "path": "v2/{+parent}/sinks",
+ "description": "Lists sinks."
},
"create": {
- "response": {
- "$ref": "LogSink"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "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/[^/]+$",
- "location": "path"
+ "pattern": "^folders/[^/]+$"
},
"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"
+ "location": "query",
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink."
}
},
"scopes": [
@@ -1366,22 +1201,31 @@
"https://www.googleapis.com/auth/logging.admin"
],
"flatPath": "v2/folders/{foldersId}/sinks",
- "path": "v2/{+parent}/sinks",
"id": "logging.folders.sinks.create",
+ "path": "v2/{+parent}/sinks",
"request": {
"$ref": "LogSink"
},
"description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink."
},
"get": {
+ "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.folders.sinks.get",
"description": "Gets a sink.",
- "httpMethod": "GET",
- "parameterOrder": [
- "sinkName"
- ],
"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",
@@ -1390,60 +1234,9 @@
"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": {
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "sinkName": {
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/sinks/[^/]+$"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "updateMask": {
- "location": "query",
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.folders.sinks.patch",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field."
- },
- "update": {
- "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"
@@ -1454,18 +1247,54 @@
"parameterOrder": [
"sinkName"
],
- "httpMethod": "PUT",
+ "httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
],
"parameters": {
"sinkName": {
+ "required": true,
+ "type": "string",
"pattern": "^folders/[^/]+/sinks/[^/]+$",
"location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
+ },
+ "uniqueWriterIdentity": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false."
+ },
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "format": "google-fieldmask"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.folders.sinks.patch"
+ },
+ "update": {
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "sinkName": {
+ "location": "path",
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^folders/[^/]+/sinks/[^/]+$"
},
"uniqueWriterIdentity": {
"location": "query",
@@ -1473,13 +1302,180 @@
"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",
- "type": "string"
+ "format": "google-fieldmask"
}
},
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.folders.sinks.update"
+ }
+ }
+ },
+ "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": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32"
+ }
+ },
+ "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": {
+ "location": "path",
+ "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+/exclusions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ]
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameters": {
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
+ "format": "google-fieldmask"
+ },
+ "name": {
+ "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}",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "description": "Changes one or more properties of an existing exclusion."
+ },
+ "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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\"."
+ }
+ },
+ "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.",
+ "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": "^folders/[^/]+/exclusions/[^/]+$"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.folders.exclusions.delete"
}
}
}
@@ -1487,64 +1483,59 @@
},
"exclusions": {
"methods": {
+ "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": {
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.exclusions.delete",
+ "description": "Deletes an exclusion."
+ },
"list": {
"description": "Lists all the exclusions in a parent resource.",
+ "httpMethod": "GET",
"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.",
+ "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",
- "location": "query"
+ "pattern": "^[^/]+/[^/]+$"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
},
"pageSize": {
"type": "integer",
"location": "query",
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32"
- },
- "parent": {
- "description": "Required. The 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"
- },
- "get": {
- "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.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": "^[^/]+/[^/]+/exclusions/[^/]+$",
- "location": "path"
}
},
"scopes": [
@@ -1552,51 +1543,86 @@
"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",
+ "id": "logging.exclusions.list",
+ "path": "v2/{+parent}/exclusions"
},
- "patch": {
- "request": {
- "$ref": "LogExclusion"
- },
- "description": "Changes one or more properties of an existing exclusion.",
- "response": {
- "$ref": "LogExclusion"
- },
+ "get": {
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "LogExclusion"
+ },
"parameters": {
- "updateMask": {
- "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
"name": {
- "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$",
"location": "path",
- "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "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"
+ "type": "string",
+ "pattern": "^[^/]+/[^/]+/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/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
+ "id": "logging.exclusions.get",
+ "path": "v2/{+name}",
+ "description": "Gets the description of an exclusion."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\"."
+ },
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
+ "format": "google-fieldmask"
+ }
+ },
"flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
+ "id": "logging.exclusions.patch",
"path": "v2/{+name}",
- "id": "logging.exclusions.patch"
+ "description": "Changes one or more properties of an existing exclusion.",
+ "request": {
+ "$ref": "LogExclusion"
+ }
},
"create": {
- "response": {
+ "request": {
"$ref": "LogExclusion"
},
+ "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "LogExclusion"
+ },
"parameters": {
"parent": {
"location": "path",
@@ -1611,72 +1637,42 @@
"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": {
- "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
- "id": "logging.exclusions.delete",
- "path": "v2/{+name}",
- "description": "Deletes an exclusion.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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"
- ]
+ "path": "v2/{+parent}/exclusions"
}
}
},
"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"
],
- "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"
- }
- },
"flatPath": "v2/monitoredResourceDescriptors",
"path": "v2/monitoredResourceDescriptors",
- "id": "logging.monitoredResourceDescriptors.list"
+ "id": "logging.monitoredResourceDescriptors.list",
+ "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging."
}
}
},
@@ -1684,34 +1680,26 @@
"resources": {
"logs": {
"methods": {
- "delete": {
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "logName"
- ],
+ "list": {
"response": {
- "$ref": "Empty"
+ "$ref": "ListLogsResponse"
},
- "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"
- }
- },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
+ "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/{logsId}",
- "id": "logging.organizations.logs.delete",
- "path": "v2/{+logName}"
- },
- "list": {
"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.",
@@ -1719,48 +1707,92 @@
"type": "integer"
},
"parent": {
+ "required": true,
+ "type": "string",
"pattern": "^organizations/[^/]+$",
"location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "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"
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
}
},
+ "flatPath": "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."
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "logName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "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."
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}",
+ "id": "logging.organizations.logs.delete",
+ "path": "v2/{+logName}",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "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"
],
- "flatPath": "v2/organizations/{organizationsId}/logs",
- "path": "v2/{+parent}/logs",
- "id": "logging.organizations.logs.list",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "response": {
- "$ref": "ListLogsResponse"
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^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"
+ },
+ "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"
+ }
},
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET"
- }
- }
- },
- "sinks": {
- "methods": {
- "create": {
"flatPath": "v2/organizations/{organizationsId}/sinks",
"path": "v2/{+parent}/sinks",
- "id": "logging.organizations.sinks.create",
+ "id": "logging.organizations.sinks.list"
+ },
+ "create": {
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
"request": {
"$ref": "LogSink"
},
- "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"
},
@@ -1768,40 +1800,44 @@
"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": {
- "type": "boolean",
- "location": "query",
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink."
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
- ]
+ ],
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\"."
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.organizations.sinks.create"
},
"get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "sinkName"
- ],
+ "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": "^organizations/[^/]+/sinks/[^/]+$"
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
}
},
"scopes": [
@@ -1811,9 +1847,8 @@
"https://www.googleapis.com/auth/logging.read"
],
"flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "id": "logging.organizations.sinks.get",
"path": "v2/{+sinkName}",
- "description": "Gets a sink."
+ "id": "logging.organizations.sinks.get"
},
"patch": {
"request": {
@@ -1829,22 +1864,22 @@
},
"parameters": {
"sinkName": {
- "pattern": "^organizations/[^/]+/sinks/[^/]+$",
"location": "path",
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"required": true,
- "type": "string"
+ "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",
- "location": "query"
+ "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",
- "type": "string"
+ "format": "google-fieldmask"
}
},
"scopes": [
@@ -1863,164 +1898,69 @@
"response": {
"$ref": "LogSink"
},
- "parameters": {
- "sinkName": {
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/sinks/[^/]+$"
- },
- "uniqueWriterIdentity": {
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean",
- "location": "query"
- },
- "updateMask": {
- "location": "query",
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
],
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "id": "logging.organizations.sinks.update",
- "path": "v2/{+sinkName}",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field."
- },
- "delete": {
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "Empty"
- },
"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"
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
+ },
+ "uniqueWriterIdentity": {
+ "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"
}
},
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "id": "logging.organizations.sinks.update",
+ "path": "v2/{+sinkName}",
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ }
+ },
+ "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"
],
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "id": "logging.organizations.sinks.delete",
- "path": "v2/{+sinkName}"
- },
- "list": {
- "path": "v2/{+parent}/sinks",
- "id": "logging.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": {
- "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",
+ "sinkName": {
"required": true,
"type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/organizations/{organizationsId}/sinks"
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.organizations.sinks.delete"
}
}
},
"exclusions": {
"methods": {
- "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": "^organizations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/organizations/{organizationsId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.organizations.exclusions.create",
- "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": {
- "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
- "id": "logging.organizations.exclusions.delete",
- "path": "v2/{+name}",
- "description": "Deletes an exclusion.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/exclusions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ]
- },
"list": {
- "description": "Lists all the exclusions in a parent resource.",
"response": {
"$ref": "ListExclusionsResponse"
},
@@ -2028,41 +1968,38 @@
"parent"
],
"httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
],
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
"flatPath": "v2/organizations/{organizationsId}/exclusions",
"path": "v2/{+parent}/exclusions",
- "id": "logging.organizations.exclusions.list"
+ "id": "logging.organizations.exclusions.list",
+ "description": "Lists all the exclusions in a parent resource."
},
"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"
},
@@ -2070,21 +2007,25 @@
"name"
],
"httpMethod": "GET",
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/exclusions/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\"."
- }
- },
"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": "^organizations/[^/]+/exclusions/[^/]+$"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.organizations.exclusions.get",
+ "description": "Gets the description of an exclusion."
},
"patch": {
"response": {
@@ -2094,31 +2035,86 @@
"name"
],
"httpMethod": "PATCH",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/exclusions/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\"."
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.organizations.exclusions.patch",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "description": "Changes one or more properties of an existing exclusion."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\"."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/exclusions",
+ "id": "logging.organizations.exclusions.create",
+ "path": "v2/{+parent}/exclusions",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource."
+ },
+ "delete": {
+ "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.organizations.exclusions.delete",
+ "description": "Deletes an exclusion.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
],
"parameters": {
"name": {
+ "required": true,
+ "type": "string",
"pattern": "^organizations/[^/]+/exclusions/[^/]+$",
"location": "path",
- "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string"
- },
- "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"
+ "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\"."
}
- },
- "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"
}
}
}
@@ -2128,32 +2124,32 @@
"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"
},
- "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"
],
+ "parameters": {},
"flatPath": "v2/entries:list",
"path": "v2/entries:list",
"id": "logging.entries.list"
},
"write": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "WriteLogEntriesResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -2161,8 +2157,8 @@
"https://www.googleapis.com/auth/logging.write"
],
"flatPath": "v2/entries:write",
- "path": "v2/entries:write",
"id": "logging.entries.write",
+ "path": "v2/entries:write",
"request": {
"$ref": "WriteLogEntriesRequest"
},
@@ -2172,7 +2168,47 @@
},
"logs": {
"methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
+ }
+ },
+ "flatPath": "v2/{v2Id}/{v2Id1}/logs",
+ "path": "v2/{+parent}/logs",
+ "id": "logging.logs.list",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
+ },
"delete": {
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
"response": {
"$ref": "Empty"
},
@@ -2180,69 +2216,28 @@
"logName"
],
"httpMethod": "DELETE",
+ "parameters": {
+ "logName": {
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+/[^/]+/logs/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry."
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
],
- "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",
- "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": {
- "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": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "pattern": "^[^/]+/[^/]+$",
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string"
- }
- },
- "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"
+ "id": "logging.logs.delete"
}
}
},
"sinks": {
"methods": {
"list": {
- "description": "Lists sinks.",
"response": {
"$ref": "ListSinksResponse"
},
@@ -2250,52 +2245,24 @@
"parent"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
"parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource whose 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": "^[^/]+/[^/]+$"
+ },
"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": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
"type": "integer",
- "location": "query"
- },
- "parent": {
- "pattern": "^[^/]+/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2/{v2Id}/{v2Id1}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.sinks.list"
- },
- "get": {
- "description": "Gets a sink.",
- "httpMethod": "GET",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "sinkName": {
- "required": true,
- "type": "string",
- "pattern": "^[^/]+/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32"
}
},
"scopes": [
@@ -2304,55 +2271,80 @@
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
],
- "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
- "id": "logging.sinks.get",
- "path": "v2/{+sinkName}"
+ "flatPath": "v2/{v2Id}/{v2Id1}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.sinks.list",
+ "description": "Lists sinks."
},
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "sinkName"
- ],
+ "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": {
- "pattern": "^[^/]+/[^/]+/sinks/[^/]+$",
"location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "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"
- },
- "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"
+ "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"
],
- "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
- "id": "logging.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."
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+/[^/]+/sinks/[^/]+$"
+ },
+ "uniqueWriterIdentity": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false."
+ },
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "format": "google-fieldmask"
+ }
+ }
},
"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"
},
@@ -2362,16 +2354,16 @@
"httpMethod": "POST",
"parameters": {
"parent": {
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"required": true,
"type": "string",
"pattern": "^[^/]+/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\"."
},
"uniqueWriterIdentity": {
+ "type": "boolean",
"location": "query",
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean"
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink."
}
},
"scopes": [
@@ -2380,23 +2372,27 @@
],
"flatPath": "v2/{v2Id}/{v2Id1}/sinks",
"path": "v2/{+parent}/sinks",
- "id": "logging.sinks.create"
+ "id": "logging.sinks.create",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink."
},
"delete": {
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"sinkName"
],
- "httpMethod": "DELETE",
"parameters": {
"sinkName": {
- "pattern": "^[^/]+/[^/]+/sinks/[^/]+$",
"location": "path",
"description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^[^/]+/[^/]+/sinks/[^/]+$"
}
},
"scopes": [
@@ -2404,462 +2400,17 @@
"https://www.googleapis.com/auth/logging.admin"
],
"flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
"id": "logging.sinks.delete",
+ "path": "v2/{+sinkName}",
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
}
}
},
"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",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/projects/{projectsId}/logs",
- "path": "v2/{+parent}/logs",
- "id": "logging.projects.logs.list"
- },
- "delete": {
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "logName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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": "v2/projects/{projectsId}/logs/{logsId}",
- "id": "logging.projects.logs.delete",
- "path": "v2/{+logName}"
- }
- }
- },
- "sinks": {
- "methods": {
- "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",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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"
- ]
- },
- "list": {
- "path": "v2/{+parent}/sinks",
- "id": "logging.projects.sinks.list",
- "description": "Lists sinks.",
- "response": {
- "$ref": "ListSinksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/projects/{projectsId}/sinks"
- },
- "create": {
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "uniqueWriterIdentity": {
- "type": "boolean",
- "location": "query",
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink."
- },
- "parent": {
- "location": "path",
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/projects/{projectsId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.projects.sinks.create",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink."
- },
- "get": {
- "description": "Gets a sink.",
- "httpMethod": "GET",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "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"
- }
- },
- "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}"
- },
- "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": {
- "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"
- }
- },
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.projects.sinks.patch",
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
- "request": {
- "$ref": "LogSink"
- }
- },
- "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": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "updateMask": {
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "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"
- }
- }
- }
- },
- "exclusions": {
- "methods": {
- "list": {
- "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": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/projects/{projectsId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.projects.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": {
- "pattern": "^projects/[^/]+/exclusions/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.projects.exclusions.get"
- },
- "patch": {
- "response": {
- "$ref": "LogExclusion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/exclusions/[^/]+$",
- "location": "path"
- },
- "updateMask": {
- "location": "query",
- "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.projects.exclusions.patch",
- "request": {
- "$ref": "LogExclusion"
- },
- "description": "Changes one or more properties of an existing exclusion."
- },
- "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."
- },
- "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": {
- "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",
- "description": "Deletes an exclusion."
- }
- }
- },
"metrics": {
"methods": {
"delete": {
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2/{+metricName}",
- "id": "logging.projects.metrics.delete",
- "description": "Deletes a logs-based metric.",
"response": {
"$ref": "Empty"
},
@@ -2869,21 +2420,24 @@
"httpMethod": "DELETE",
"parameters": {
"metricName": {
- "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n"
}
},
"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": {
- "description": "Lists logs-based metrics.",
"response": {
"$ref": "ListLogMetricsResponse"
},
@@ -2893,16 +2447,16 @@
"httpMethod": "GET",
"parameters": {
"parent": {
+ "location": "path",
+ "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n"
+ "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"
+ "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",
@@ -2919,9 +2473,14 @@
],
"flatPath": "v2/projects/{projectsId}/metrics",
"path": "v2/{+parent}/metrics",
- "id": "logging.projects.metrics.list"
+ "id": "logging.projects.metrics.list",
+ "description": "Lists logs-based metrics."
},
"get": {
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2/{+metricName}",
+ "id": "logging.projects.metrics.get",
+ "description": "Gets a logs-based metric.",
"response": {
"$ref": "LogMetric"
},
@@ -2929,57 +2488,56 @@
"metricName"
],
"httpMethod": "GET",
- "parameters": {
- "metricName": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path",
- "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
],
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2/{+metricName}",
- "id": "logging.projects.metrics.get",
- "description": "Gets a logs-based metric."
+ "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/[^/]+$"
+ }
+ }
},
"update": {
- "description": "Creates or updates a logs-based metric.",
"request": {
"$ref": "LogMetric"
},
- "response": {
- "$ref": "LogMetric"
- },
+ "description": "Creates or updates a logs-based metric.",
+ "httpMethod": "PUT",
"parameterOrder": [
"metricName"
],
- "httpMethod": "PUT",
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "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"
],
- "parameters": {
- "metricName": {
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path",
- "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2/{+metricName}",
- "id": "logging.projects.metrics.update"
+ "id": "logging.projects.metrics.update",
+ "path": "v2/{+metricName}"
},
"create": {
+ "flatPath": "v2/projects/{projectsId}/metrics",
+ "id": "logging.projects.metrics.create",
+ "path": "v2/{+parent}/metrics",
"request": {
"$ref": "LogMetric"
},
@@ -2993,54 +2551,47 @@
},
"parameters": {
"parent": {
- "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.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.write"
- ],
- "flatPath": "v2/projects/{projectsId}/metrics",
- "id": "logging.projects.metrics.create",
- "path": "v2/{+parent}/metrics"
+ ]
}
}
- }
- }
- },
- "billingAccounts": {
- "resources": {
+ },
"logs": {
"methods": {
"delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "logName"
- ],
"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": "^billingAccounts/[^/]+/logs/[^/]+$",
- "location": "path"
+ "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": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}",
- "id": "logging.billingAccounts.logs.delete",
+ "flatPath": "v2/projects/{projectsId}/logs/{logsId}",
"path": "v2/{+logName}",
+ "id": "logging.projects.logs.delete",
"description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
},
"list": {
@@ -3053,9 +2604,9 @@
"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"
+ "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",
@@ -3064,11 +2615,11 @@
"type": "integer"
},
"parent": {
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
}
},
"scopes": [
@@ -3077,9 +2628,9 @@
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/logs",
+ "flatPath": "v2/projects/{projectsId}/logs",
"path": "v2/{+parent}/logs",
- "id": "logging.billingAccounts.logs.list",
+ "id": "logging.projects.logs.list",
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
}
}
@@ -3087,22 +2638,12 @@
"sinks": {
"methods": {
"get": {
- "description": "Gets a sink.",
- "response": {
- "$ref": "LogSink"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"sinkName"
],
- "httpMethod": "GET",
- "parameters": {
- "sinkName": {
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
+ "response": {
+ "$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -3110,22 +2651,35 @@
"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": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
"parameters": {
"sinkName": {
- "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
"location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "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"
+ "type": "string",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.sinks.get",
+ "path": "v2/{+sinkName}",
+ "description": "Gets a sink."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameters": {
+ "sinkName": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
},
"uniqueWriterIdentity": {
"type": "boolean",
@@ -3133,49 +2687,39 @@
"description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false."
},
"updateMask": {
+ "type": "string",
"location": "query",
"description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "format": "google-fieldmask",
- "type": "string"
+ "format": "google-fieldmask"
}
},
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "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}",
- "id": "logging.billingAccounts.sinks.patch",
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
"request": {
"$ref": "LogSink"
},
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PATCH"
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field."
},
"update": {
- "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"
- },
+ "httpMethod": "PUT",
"parameterOrder": [
"sinkName"
],
- "httpMethod": "PUT",
+ "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"
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
},
"uniqueWriterIdentity": {
"location": "query",
@@ -3183,47 +2727,51 @@
"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",
- "type": "string"
+ "format": "google-fieldmask"
}
},
"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}",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field."
},
"delete": {
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "DELETE",
"parameterOrder": [
"sinkName"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "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"
],
- "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"
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.sinks.delete",
"path": "v2/{+sinkName}",
- "id": "logging.billingAccounts.sinks.delete",
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
},
"list": {
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
- "id": "logging.billingAccounts.sinks.list",
- "path": "v2/{+parent}/sinks",
"description": "Lists sinks.",
"httpMethod": "GET",
"parameterOrder": [
@@ -3232,41 +2780,37 @@
"response": {
"$ref": "ListSinksResponse"
},
- "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": "^billingAccounts/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
- ]
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks",
+ "id": "logging.projects.sinks.list",
+ "path": "v2/{+parent}/sinks"
},
"create": {
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.billingAccounts.sinks.create",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
"response": {
"$ref": "LogSink"
},
@@ -3276,32 +2820,35 @@
"httpMethod": "POST",
"parameters": {
"parent": {
- "pattern": "^billingAccounts/[^/]+$",
"location": "path",
"description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
},
"uniqueWriterIdentity": {
+ "location": "query",
"description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
- ]
+ ],
+ "flatPath": "v2/projects/{projectsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.projects.sinks.create",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink."
}
}
},
"exclusions": {
"methods": {
"list": {
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.billingAccounts.exclusions.list",
- "description": "Lists all the exclusions in a parent resource.",
"response": {
"$ref": "ListExclusionsResponse"
},
@@ -3309,37 +2856,38 @@
"parent"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
"parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
- },
"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",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"type": "integer"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource whose 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",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.projects.exclusions.list",
+ "description": "Lists all the exclusions in a parent resource."
},
"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"
@@ -3356,15 +2904,25 @@
],
"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"
+ "pattern": "^projects/[^/]+/exclusions/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\"."
}
- }
+ },
+ "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.projects.exclusions.get"
},
"patch": {
+ "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.projects.exclusions.patch",
+ "description": "Changes one or more properties of an existing exclusion.",
+ "request": {
+ "$ref": "LogExclusion"
+ },
"response": {
"$ref": "LogExclusion"
},
@@ -3372,41 +2930,34 @@
"name"
],
"httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.billingAccounts.exclusions.patch",
- "request": {
- "$ref": "LogExclusion"
- },
- "description": "Changes one or more properties of an existing exclusion."
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/exclusions/[^/]+$"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ }
},
"create": {
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
+ "flatPath": "v2/projects/{projectsId}/exclusions",
"path": "v2/{+parent}/exclusions",
- "id": "logging.billingAccounts.exclusions.create",
+ "id": "logging.projects.exclusions.create",
+ "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
"request": {
"$ref": "LogExclusion"
},
- "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"
},
@@ -3414,13 +2965,189 @@
"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": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\"."
+ }
+ }
+ },
+ "delete": {
+ "description": "Deletes an exclusion.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/exclusions/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\"."
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.projects.exclusions.delete"
+ }
+ }
+ }
+ }
+ },
+ "billingAccounts": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "delete": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}",
+ "path": "v2/{+logName}",
+ "id": "logging.billingAccounts.logs.delete",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "logName": {
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+/logs/[^/]+$"
+ }
+ }
+ },
+ "list": {
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "parent": {
"required": true,
"type": "string",
"pattern": "^billingAccounts/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
+ },
+ "pageSize": {
+ "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"
+ }
+ },
+ "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.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "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/billingAccounts/{billingAccountsId}/sinks",
+ "id": "logging.billingAccounts.sinks.list",
+ "path": "v2/{+parent}/sinks"
+ },
+ "create": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
+ "id": "logging.billingAccounts.sinks.create",
+ "path": "v2/{+parent}/sinks",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\"."
+ },
+ "uniqueWriterIdentity": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink."
}
},
"scopes": [
@@ -3428,7 +3155,277 @@
"https://www.googleapis.com/auth/logging.admin"
]
},
+ "get": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.billingAccounts.sinks.get",
+ "description": "Gets a sink.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$"
+ }
+ }
+ },
+ "patch": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.billingAccounts.sinks.patch",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^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": {
+ "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"
+ ]
+ },
+ "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"
+ },
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "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": {
+ "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/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "id": "logging.billingAccounts.sinks.update",
+ "path": "v2/{+sinkName}"
+ },
"delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "exclusions": {
+ "methods": {
+ "list": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
+ "id": "logging.billingAccounts.exclusions.list",
+ "path": "v2/{+parent}/exclusions",
+ "description": "Lists all the exclusions in a parent resource.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListExclusionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+$"
+ }
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "name": {
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.billingAccounts.exclusions.get",
+ "description": "Gets the description of an exclusion."
+ },
+ "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": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\"."
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.billingAccounts.exclusions.patch"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+$"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
+ "id": "logging.billingAccounts.exclusions.create",
+ "path": "v2/{+parent}/exclusions",
+ "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
+ "request": {
+ "$ref": "LogExclusion"
+ }
+ },
+ "delete": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
"id": "logging.billingAccounts.exclusions.delete",
"path": "v2/{+name}",
"description": "Deletes an exclusion.",
@@ -3451,8 +3448,7 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}"
+ ]
}
}
}
@@ -3460,26 +3456,16 @@
}
},
"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",
- "location": "query"
+ "type": "string"
},
"pp": {
- "location": "query",
- "description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query",
+ "description": "Pretty-print response."
},
"oauth_token": {
"location": "query",
@@ -3487,30 +3473,30 @@
"type": "string"
},
"bearer_token": {
- "description": "OAuth bearer token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth bearer token."
},
"upload_protocol": {
+ "type": "string",
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "default": "true"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
},
"$.xgafv": {
"location": "query",
@@ -3526,9 +3512,9 @@
]
},
"callback": {
- "description": "JSONP",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "JSONP"
},
"alt": {
"type": "string",
@@ -3545,7 +3531,21 @@
"media",
"proto"
]
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "key": {
+ "type": "string",
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
}
},
- "version": "v2"
+ "version": "v2",
+ "baseUrl": "https://logging.googleapis.com/",
+ "servicePath": "",
+ "description": "Writes log entries and manages your Stackdriver Logging configuration.",
+ "kind": "discovery#restDescription"
}
diff --git a/logging/v2beta1/logging-api.json b/logging/v2beta1/logging-api.json
index 06e8808..1e96791 100644
--- a/logging/v2beta1/logging-api.json
+++ b/logging/v2beta1/logging-api.json
@@ -1,93 +1,35 @@
{
- "fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Logging API",
- "ownerName": "Google",
"resources": {
- "projects": {
+ "organizations": {
"resources": {
- "metrics": {
+ "logs": {
"methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "metricName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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 delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "id": "logging.projects.metrics.delete",
- "path": "v2beta1/{+metricName}",
- "description": "Deletes a logs-based metric."
- },
"list": {
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
"response": {
- "$ref": "ListLogMetricsResponse"
+ "$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": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
"pageSize": {
"location": "query",
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"type": "integer"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/metrics",
- "path": "v2beta1/{+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",
- "parameters": {
- "metricName": {
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path",
- "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ },
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"type": "string"
}
},
@@ -97,98 +39,113 @@
"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"
+ "flatPath": "v2beta1/organizations/{organizationsId}/logs",
+ "path": "v2beta1/{+parent}/logs",
+ "id": "logging.organizations.logs.list"
},
- "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": {
- "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",
- "request": {
- "$ref": "LogMetric"
- },
- "description": "Creates a logs-based metric."
- }
- }
- },
- "logs": {
- "methods": {
"delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "httpMethod": "DELETE",
"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"
+ "type": "string",
+ "pattern": "^organizations/[^/]+/logs/[^/]+$"
}
},
"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",
+ "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."
+ }
+ }
+ }
+ }
+ },
+ "entries": {
+ "methods": {
+ "list": {
+ "request": {
+ "$ref": "ListLogEntriesRequest"
+ },
+ "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
+ "response": {
+ "$ref": "ListLogEntriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/entries:list",
+ "path": "v2beta1/entries:list",
+ "id": "logging.entries.list"
+ },
+ "write": {
+ "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": "v2beta1/entries:write",
+ "path": "v2beta1/entries:write",
+ "id": "logging.entries.write"
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "delete": {
+ "flatPath": "v2beta1/projects/{projectsId}/logs/{logsId}",
+ "path": "v2beta1/{+logName}",
+ "id": "logging.projects.logs.delete",
"description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"logName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "logName": {
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/logs/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
]
},
"list": {
@@ -200,32 +157,32 @@
"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": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
],
+ "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": "^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"
+ }
+ },
"flatPath": "v2beta1/projects/{projectsId}/logs",
"path": "v2beta1/{+parent}/logs",
"id": "logging.projects.logs.list"
@@ -235,6 +192,9 @@
"sinks": {
"methods": {
"delete": {
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2beta1/{+sinkName}",
+ "id": "logging.projects.sinks.delete",
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
"response": {
"$ref": "Empty"
@@ -245,28 +205,31 @@
"httpMethod": "DELETE",
"parameters": {
"sinkName": {
- "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\".",
"required": true,
- "type": "string"
+ "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}",
- "path": "v2beta1/{+sinkName}",
- "id": "logging.projects.sinks.delete"
+ ]
},
"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",
"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",
@@ -274,11 +237,16 @@
"location": "query"
},
"parent": {
- "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",
"required": true,
- "type": "string"
+ "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": [
@@ -286,37 +254,27 @@
"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",
- "id": "logging.projects.sinks.list",
- "path": "v2beta1/{+parent}/sinks",
- "description": "Lists sinks.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListSinksResponse"
- }
+ ]
},
"get": {
- "id": "logging.projects.sinks.get",
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
"path": "v2beta1/{+sinkName}",
+ "id": "logging.projects.sinks.get",
"description": "Gets a sink.",
- "httpMethod": "GET",
"response": {
"$ref": "LogSink"
},
"parameterOrder": [
"sinkName"
],
+ "httpMethod": "GET",
"parameters": {
"sinkName": {
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path",
"description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -324,14 +282,9 @@
"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}"
+ ]
},
"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"
},
@@ -345,11 +298,11 @@
],
"parameters": {
"sinkName": {
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
"location": "path",
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"required": true,
- "type": "string"
+ "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.",
@@ -357,15 +310,19 @@
"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"
+ "type": "string",
+ "location": "query"
}
},
"flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
"path": "v2beta1/{+sinkName}",
- "id": "logging.projects.sinks.update"
+ "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"
+ }
},
"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.",
@@ -392,9 +349,9 @@
"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",
- "location": "query"
+ "type": "boolean"
}
},
"flatPath": "v2beta1/projects/{projectsId}/sinks",
@@ -402,6 +359,164 @@
"id": "logging.projects.sinks.create"
}
}
+ },
+ "metrics": {
+ "methods": {
+ "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": "v2beta1/projects/{projectsId}/metrics",
+ "path": "v2beta1/{+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",
+ "parameters": {
+ "metricName": {
+ "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2beta1/{+metricName}",
+ "id": "logging.projects.metrics.get"
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "metricName"
+ ],
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameters": {
+ "metricName": {
+ "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "id": "logging.projects.metrics.update",
+ "path": "v2beta1/{+metricName}",
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "description": "Creates or updates a logs-based metric."
+ },
+ "create": {
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/metrics",
+ "path": "v2beta1/{+parent}/metrics",
+ "id": "logging.projects.metrics.create",
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "description": "Creates a logs-based metric."
+ },
+ "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": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2beta1/{+metricName}",
+ "id": "logging.projects.metrics.delete",
+ "description": "Deletes a logs-based metric."
+ }
+ }
}
}
},
@@ -410,13 +525,21 @@
"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": {
- "pattern": "^billingAccounts/[^/]+/logs/[^/]+$",
- "location": "path",
"description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+/logs/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -425,17 +548,10 @@
],
"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"
+ "id": "logging.billingAccounts.logs.delete"
},
"list": {
+ "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.",
@@ -447,23 +563,23 @@
"$ref": "ListLogsResponse"
},
"parameters": {
- "parent": {
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
"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": {
+ "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": [
@@ -471,8 +587,7 @@
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs"
+ ]
}
}
}
@@ -481,23 +596,22 @@
"monitoredResourceDescriptors": {
"methods": {
"list": {
- "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging.",
"response": {
"$ref": "ListMonitoredResourceDescriptorsResponse"
},
"parameterOrder": [],
"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"
+ },
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"type": "string",
"location": "query"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
}
},
"scopes": [
@@ -508,134 +622,17 @@
],
"flatPath": "v2beta1/monitoredResourceDescriptors",
"path": "v2beta1/monitoredResourceDescriptors",
- "id": "logging.monitoredResourceDescriptors.list"
- }
- }
- },
- "organizations": {
- "resources": {
- "logs": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "logName": {
- "pattern": "^organizations/[^/]+/logs/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "required": true,
- "type": "string"
- }
- },
- "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": {
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/organizations/{organizationsId}/logs",
- "path": "v2beta1/{+parent}/logs",
- "id": "logging.organizations.logs.list"
- }
- }
- }
- }
- },
- "entries": {
- "methods": {
- "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"
- },
- "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"
- },
- "write": {
- "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.",
- "response": {
- "$ref": "WriteLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
+ "id": "logging.monitoredResourceDescriptors.list",
+ "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging."
}
}
}
},
"parameters": {
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
"description": "Pretty-print response.",
@@ -643,16 +640,16 @@
"default": "true",
"location": "query"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -664,24 +661,17 @@
"type": "boolean",
"default": "true"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "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"
@@ -690,15 +680,16 @@
"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": [
@@ -706,17 +697,23 @@
"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": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"version": "v2beta1",
@@ -725,433 +722,16 @@
"description": "Writes log entries and manages your Stackdriver Logging configuration.",
"servicePath": "",
"basePath": "",
- "id": "logging:v2beta1",
- "documentationLink": "https://cloud.google.com/logging/docs/",
"revision": "20180123",
+ "documentationLink": "https://cloud.google.com/logging/docs/",
+ "id": "logging:v2beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ListLogEntriesRequest": {
- "id": "ListLogEntriesRequest",
- "description": "The parameters to ListLogEntries.",
- "type": "object",
- "properties": {
- "orderBy": {
- "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.",
- "type": "string"
- },
- "resourceNames": {
- "description": "Required. Names of one or more parent resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nProjects listed in the project_ids field are added to this list.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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",
- "items": {
- "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"
- }
- }
- },
- "Explicit": {
- "id": "Explicit",
- "description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
- "type": "object",
- "properties": {
- "bounds": {
- "description": "The values must be monotonically increasing.",
- "type": "array",
- "items": {
- "format": "double",
- "type": "number"
- }
- }
- }
- },
- "SourceReference": {
- "id": "SourceReference",
- "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
- "type": "object",
- "properties": {
- "repository": {
- "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
- "type": "string"
- },
- "revisionId": {
- "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
- "type": "string"
- }
- }
- },
- "WriteLogEntriesResponse": {
- "description": "Result returned from WriteLogEntries. empty",
- "type": "object",
- "properties": {},
- "id": "WriteLogEntriesResponse"
- },
- "Exponential": {
- "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).",
- "type": "object",
- "properties": {
- "numFiniteBuckets": {
- "description": "Must be greater than 0.",
- "format": "int32",
- "type": "integer"
- },
- "growthFactor": {
- "description": "Must be greater than 1.",
- "format": "double",
- "type": "number"
- },
- "scale": {
- "description": "Must be greater than 0.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Exponential"
- },
- "WriteLogEntriesRequest": {
- "description": "The parameters to WriteLogEntries.",
- "type": "object",
- "properties": {
- "logName": {
- "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "type": "string"
- },
- "entries": {
- "description": "Required. The log entries to send to Stackdriver Logging. The order of log entries in this list does not matter. Values supplied in this method's log_name, resource, and labels fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type.If the timestamp or insert_id fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the entries.list method.Log entries with timestamps that are more than the logs retention period in the past or more than 24 hours in the future 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"
- },
- "dryRun": {
- "description": "Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data.",
- "type": "boolean"
- },
- "labels": {
- "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "resource": {
- "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry.",
- "$ref": "MonitoredResource"
- }
- },
- "id": "WriteLogEntriesRequest"
- },
- "LabelDescriptor": {
- "description": "A description of a label.",
- "type": "object",
- "properties": {
- "key": {
- "description": "The label key.",
- "type": "string"
- },
- "description": {
- "description": "A human-readable description for the label.",
- "type": "string"
- },
- "valueType": {
- "enumDescriptions": [
- "A variable-length string. This is the default.",
- "Boolean; true or false.",
- "A 64-bit signed integer."
- ],
- "enum": [
- "STRING",
- "BOOL",
- "INT64"
- ],
- "description": "The type of data that can be assigned to the label.",
- "type": "string"
- }
- },
- "id": "LabelDescriptor"
- },
- "BucketOptions": {
- "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
- "type": "object",
- "properties": {
- "exponentialBuckets": {
- "description": "The exponential buckets.",
- "$ref": "Exponential"
- },
- "linearBuckets": {
- "description": "The linear bucket.",
- "$ref": "Linear"
- },
- "explicitBuckets": {
- "description": "The explicit buckets.",
- "$ref": "Explicit"
- }
- },
- "id": "BucketOptions"
- },
- "ListLogMetricsResponse": {
- "id": "ListLogMetricsResponse",
- "description": "Result returned from ListLogMetrics.",
- "type": "object",
- "properties": {
- "metrics": {
- "description": "A list of logs-based metrics.",
- "type": "array",
- "items": {
- "$ref": "LogMetric"
- }
- },
- "nextPageToken": {
- "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
- }
- }
- },
- "MetricDescriptor": {
- "id": "MetricDescriptor",
- "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
- "type": "object",
- "properties": {
- "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": {
- "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "An instantaneous measurement of a value.",
- "The change in a value during a time interval.",
- "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
- ],
- "enum": [
- "METRIC_KIND_UNSPECIFIED",
- "GAUGE",
- "DELTA",
- "CUMULATIVE"
- ]
- },
- "displayName": {
- "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.",
- "type": "string"
- },
- "description": {
- "description": "A detailed description of the metric, which can be used in documentation.",
- "type": "string"
- },
- "unit": {
- "description": "The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)\nbit bit\nBy byte\ns second\nmin minute\nh hour\nd dayPrefixes (PREFIX)\nk kilo (10**3)\nM mega (10**6)\nG giga (10**9)\nT tera (10**12)\nP peta (10**15)\nE exa (10**18)\nZ zetta (10**21)\nY yotta (10**24)\nm milli (10**-3)\nu micro (10**-6)\nn nano (10**-9)\np pico (10**-12)\nf femto (10**-15)\na atto (10**-18)\nz zepto (10**-21)\ny yocto (10**-24)\nKi kibi (2**10)\nMi mebi (2**20)\nGi gibi (2**30)\nTi tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:\n/ division (as an infix operator, e.g. 1/s).\n. multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:\nExpression = Component { \".\" Component } { \"/\" Component } ;\n\nComponent = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\nAnnotation = \"{\" NAME \"}\" ;\nNotes:\nAnnotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.\nNAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.",
- "type": "string"
- },
- "labels": {
- "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"
- }
- }
- }
- },
- "LogEntry": {
- "description": "An individual entry in a log.",
- "type": "object",
- "properties": {
- "spanId": {
- "description": "Optional. The span ID within the trace associated with the log entry. For Stackdriver Trace spans, this is the same format that the Stackdriver Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as \u003ccode\u003e\"000000000000004a\"\u003c/code\u003e.",
- "type": "string"
- },
- "timestamp": {
- "description": "Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Stackdriver Logging assigns it the current time.Incoming log entries should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. Log entries outside those time boundaries will not be available when calling entries.list, but those log entries can still be exported with LogSinks.",
- "format": "google-datetime",
- "type": "string"
- },
- "receiveTimestamp": {
- "description": "Output only. The time the log entry was received by Stackdriver Logging.",
- "format": "google-datetime",
- "type": "string"
- },
- "logName": {
- "description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\nA project number may optionally be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.",
- "type": "string"
- },
- "resource": {
- "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.",
- "$ref": "MonitoredResource"
- },
- "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"
- }
- },
- "labels": {
- "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "trace": {
- "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824",
- "type": "string"
- },
- "severity": {
- "enumDescriptions": [
- "(0) The log entry has no assigned severity level.",
- "(100) Debug or trace information.",
- "(200) Routine information, such as ongoing status or performance.",
- "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
- "(400) Warning events might cause problems.",
- "(500) Error events are likely to cause problems.",
- "(600) Critical events cause more severe problems or outages.",
- "(700) A person must take an action immediately.",
- "(800) One or more systems are unusable."
- ],
- "enum": [
- "DEFAULT",
- "DEBUG",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
- ],
- "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
- "type": "string"
- },
- "sourceLocation": {
- "$ref": "LogEntrySourceLocation",
- "description": "Optional. Source code location information associated with the log entry, if any."
- }
- },
- "id": "LogEntry"
- },
"RequestLog": {
- "id": "RequestLog",
"description": "Complete log information about a single HTTP request to an App Engine application.",
"type": "object",
"properties": {
- "method": {
- "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
- "type": "string"
- },
- "cost": {
- "description": "An indication of the relative cost of serving this request.",
- "format": "double",
- "type": "number"
- },
- "instanceId": {
- "description": "An identifier for the instance that handled the request.",
- "type": "string"
- },
- "megaCycles": {
- "description": "Number of CPU megacycles used to process request.",
- "format": "int64",
- "type": "string"
- },
- "first": {
- "description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.",
- "type": "boolean"
- },
- "versionId": {
- "description": "Version of the application that handled this request.",
- "type": "string"
- },
- "moduleId": {
- "description": "Module of the application that handled this request.",
- "type": "string"
- },
- "endTime": {
- "description": "Time when the request finished.",
- "format": "google-datetime",
- "type": "string"
- },
- "userAgent": {
- "description": "User agent that made the request.",
- "type": "string"
- },
- "wasLoadingRequest": {
- "description": "Whether this was a loading request for the instance.",
- "type": "boolean"
- },
"sourceReference": {
"description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.",
"type": "array",
@@ -1175,14 +755,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"
@@ -1251,55 +831,87 @@
"appEngineRelease": {
"description": "App Engine release version.",
"type": "string"
+ },
+ "method": {
+ "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
+ "type": "string"
+ },
+ "cost": {
+ "description": "An indication of the relative cost of serving this request.",
+ "format": "double",
+ "type": "number"
+ },
+ "instanceId": {
+ "description": "An identifier for the instance that handled the request.",
+ "type": "string"
+ },
+ "megaCycles": {
+ "description": "Number of CPU megacycles used to process request.",
+ "format": "int64",
+ "type": "string"
+ },
+ "first": {
+ "description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.",
+ "type": "boolean"
+ },
+ "versionId": {
+ "description": "Version of the application that handled this request.",
+ "type": "string"
+ },
+ "moduleId": {
+ "description": "Module of the application that handled this request.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time when the request finished.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "userAgent": {
+ "description": "User agent that made the request.",
+ "type": "string"
+ },
+ "wasLoadingRequest": {
+ "description": "Whether this was a loading request for the instance.",
+ "type": "boolean"
}
- }
+ },
+ "id": "RequestLog"
},
"ListMonitoredResourceDescriptorsResponse": {
- "id": "ListMonitoredResourceDescriptorsResponse",
"description": "Result returned from ListMonitoredResourceDescriptors.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
- },
"resourceDescriptors": {
"description": "A list of resource descriptors.",
"type": "array",
"items": {
"$ref": "MonitoredResourceDescriptor"
}
- }
- }
- },
- "LogEntryOperation": {
- "id": "LogEntryOperation",
- "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
+ },
+ "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"
- },
- "producer": {
- "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".",
- "type": "string"
- },
- "first": {
- "description": "Optional. Set this to True if this is the first log entry in the operation.",
- "type": "boolean"
- },
- "last": {
- "description": "Optional. Set this to True if this is the last log entry in the operation.",
- "type": "boolean"
}
- }
+ },
+ "id": "ListMonitoredResourceDescriptorsResponse"
},
"LogMetric": {
- "id": "LogMetric",
"description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.",
"type": "object",
"properties": {
+ "description": {
+ "description": "Optional. A description of this metric, which is used in documentation.",
+ "type": "string"
+ },
+ "valueExtractor": {
+ "description": "Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument are: 1. field: The name of the log entry field from which the value is to be extracted. 2. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, \".*quantity=(\\d+).*\")",
+ "type": "string"
+ },
+ "bucketOptions": {
+ "$ref": "BucketOptions",
+ "description": "Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values."
+ },
"name": {
"description": "Required. The client-assigned metric identifier. Examples: \"error_count\", \"nginx/requests\".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: \"projects/my-project/metrics/nginx%2Frequests\".",
"type": "string"
@@ -1311,10 +923,6 @@
"type": "string"
}
},
- "metricDescriptor": {
- "description": "Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of \"1\". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.",
- "$ref": "MetricDescriptor"
- },
"version": {
"enumDescriptions": [
"Stackdriver Logging API v2.",
@@ -1327,26 +935,41 @@
"description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.",
"type": "string"
},
+ "metricDescriptor": {
+ "$ref": "MetricDescriptor",
+ "description": "Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of \"1\". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description."
+ },
"filter": {
"description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters.",
"type": "string"
- },
- "description": {
- "description": "Optional. A description of this metric, which is used in documentation.",
- "type": "string"
- },
- "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"
}
- }
+ },
+ "id": "LogMetric"
+ },
+ "LogEntryOperation": {
+ "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
+ "type": "object",
+ "properties": {
+ "last": {
+ "description": "Optional. Set this to True if this is the last log entry in the operation.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
+ "type": "string"
+ },
+ "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"
},
"MonitoredResource": {
- "id": "MonitoredResource",
"description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
"type": "object",
"properties": {
@@ -1355,26 +978,19 @@
"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"
- },
- "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
- "type": "object"
+ }
}
- }
+ },
+ "id": "MonitoredResource"
},
"LogSink": {
"description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.",
"type": "object",
"properties": {
- "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"
- },
- "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"
@@ -1398,8 +1014,6 @@
"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.",
@@ -1409,7 +1023,17 @@
"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"
+ },
+ "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"
}
},
"id": "LogSink"
@@ -1432,41 +1056,54 @@
},
"id": "ListLogsResponse"
},
- "ListSinksResponse": {
- "description": "Result returned from ListSinks.",
- "type": "object",
- "properties": {
- "sinks": {
- "description": "A list of sinks.",
- "type": "array",
- "items": {
- "$ref": "LogSink"
- }
- },
- "nextPageToken": {
- "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.",
- "type": "string"
- }
- },
- "id": "ListSinksResponse"
- },
"HttpRequest": {
- "id": "HttpRequest",
"description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.",
"type": "object",
"properties": {
+ "userAgent": {
+ "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".",
+ "type": "string"
+ },
+ "latency": {
+ "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "cacheFillBytes": {
+ "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
+ "format": "int64",
+ "type": "string"
+ },
+ "requestMethod": {
+ "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
+ "type": "string"
+ },
+ "requestSize": {
+ "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
+ "format": "int64",
+ "type": "string"
+ },
+ "protocol": {
+ "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"",
+ "type": "string"
+ },
+ "responseSize": {
+ "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
+ "format": "int64",
+ "type": "string"
+ },
"requestUrl": {
"description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\".",
"type": "string"
},
- "remoteIp": {
- "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".",
- "type": "string"
- },
"serverIp": {
"description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.",
"type": "string"
},
+ "remoteIp": {
+ "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".",
+ "type": "string"
+ },
"cacheLookup": {
"description": "Whether or not a cache lookup was attempted.",
"type": "boolean"
@@ -1487,45 +1124,39 @@
"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": {
- "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
- "format": "int64",
- "type": "string"
- },
- "protocol": {
- "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"",
- "type": "string"
}
- }
+ },
+ "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": {
"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"
@@ -1541,13 +1172,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"
- }
}
},
"id": "MonitoredResourceDescriptor"
@@ -1576,16 +1200,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"
@@ -1594,9 +1218,12 @@
"description": "Application log line emitted while processing a request.",
"type": "object",
"properties": {
+ "time": {
+ "description": "Approximate time when this log entry was made.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"severity": {
- "description": "Severity of this log entry.",
- "type": "string",
"enumDescriptions": [
"(0) The log entry has no assigned severity level.",
"(100) Debug or trace information.",
@@ -1618,20 +1245,17 @@
"CRITICAL",
"ALERT",
"EMERGENCY"
- ]
+ ],
+ "description": "Severity of this log entry.",
+ "type": "string"
},
"logMessage": {
"description": "App-provided log message.",
"type": "string"
},
"sourceLocation": {
- "$ref": "SourceLocation",
- "description": "Where in the source code this log message was written."
- },
- "time": {
- "description": "Approximate time when this log entry was made.",
- "format": "google-datetime",
- "type": "string"
+ "description": "Where in the source code this log message was written.",
+ "$ref": "SourceLocation"
}
},
"id": "LogLine"
@@ -1659,21 +1283,15 @@
"id": "Linear"
},
"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",
- "properties": {}
+ "properties": {},
+ "id": "Empty"
},
"SourceLocation": {
- "id": "SourceLocation",
"description": "Specifies a location in a source code file.",
"type": "object",
"properties": {
- "line": {
- "description": "Line within the source file.",
- "format": "int64",
- "type": "string"
- },
"file": {
"description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
"type": "string"
@@ -1681,15 +1299,394 @@
"functionName": {
"description": "Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).",
"type": "string"
+ },
+ "line": {
+ "description": "Line within the source file.",
+ "format": "int64",
+ "type": "string"
}
- }
+ },
+ "id": "SourceLocation"
+ },
+ "ListLogEntriesRequest": {
+ "description": "The parameters to ListLogEntries.",
+ "type": "object",
+ "properties": {
+ "resourceNames": {
+ "description": "Required. Names of one or more parent resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nProjects listed in the project_ids field are added to this list.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "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",
+ "items": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "ListLogEntriesRequest"
+ },
+ "Explicit": {
+ "description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
+ "type": "object",
+ "properties": {
+ "bounds": {
+ "description": "The values must be monotonically increasing.",
+ "type": "array",
+ "items": {
+ "format": "double",
+ "type": "number"
+ }
+ }
+ },
+ "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": {
+ "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
+ "type": "string"
+ },
+ "revisionId": {
+ "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
+ "type": "string"
+ }
+ },
+ "id": "SourceReference"
+ },
+ "WriteLogEntriesResponse": {
+ "description": "Result returned from WriteLogEntries. empty",
+ "type": "object",
+ "properties": {},
+ "id": "WriteLogEntriesResponse"
+ },
+ "Exponential": {
+ "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).",
+ "type": "object",
+ "properties": {
+ "growthFactor": {
+ "description": "Must be greater than 1.",
+ "format": "double",
+ "type": "number"
+ },
+ "scale": {
+ "description": "Must be greater than 0.",
+ "format": "double",
+ "type": "number"
+ },
+ "numFiniteBuckets": {
+ "description": "Must be greater than 0.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Exponential"
+ },
+ "WriteLogEntriesRequest": {
+ "description": "The parameters to WriteLogEntries.",
+ "type": "object",
+ "properties": {
+ "logName": {
+ "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "type": "string"
+ },
+ "entries": {
+ "description": "Required. The log entries to send to Stackdriver Logging. The order of log entries in this list does not matter. Values supplied in this method's log_name, resource, and labels fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type.If the timestamp or insert_id fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the entries.list method.Log entries with timestamps that are more than the logs retention period in the past or more than 24 hours in the future 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"
+ },
+ "dryRun": {
+ "description": "Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data.",
+ "type": "boolean"
+ },
+ "labels": {
+ "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "resource": {
+ "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry.",
+ "$ref": "MonitoredResource"
+ }
+ },
+ "id": "WriteLogEntriesRequest"
+ },
+ "LabelDescriptor": {
+ "description": "A description of a label.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "The label key.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A human-readable description for the label.",
+ "type": "string"
+ },
+ "valueType": {
+ "description": "The type of data that can be assigned to the label.",
+ "type": "string",
+ "enumDescriptions": [
+ "A variable-length string. This is the default.",
+ "Boolean; true or false.",
+ "A 64-bit signed integer."
+ ],
+ "enum": [
+ "STRING",
+ "BOOL",
+ "INT64"
+ ]
+ }
+ },
+ "id": "LabelDescriptor"
+ },
+ "BucketOptions": {
+ "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
+ "type": "object",
+ "properties": {
+ "linearBuckets": {
+ "$ref": "Linear",
+ "description": "The linear bucket."
+ },
+ "explicitBuckets": {
+ "$ref": "Explicit",
+ "description": "The explicit buckets."
+ },
+ "exponentialBuckets": {
+ "$ref": "Exponential",
+ "description": "The exponential buckets."
+ }
+ },
+ "id": "BucketOptions"
+ },
+ "ListLogMetricsResponse": {
+ "description": "Result returned from ListLogMetrics.",
+ "type": "object",
+ "properties": {
+ "metrics": {
+ "description": "A list of logs-based metrics.",
+ "type": "array",
+ "items": {
+ "$ref": "LogMetric"
+ }
+ },
+ "nextPageToken": {
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
+ "type": "string"
+ }
+ },
+ "id": "ListLogMetricsResponse"
+ },
+ "MetricDescriptor": {
+ "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
+ "type": "object",
+ "properties": {
+ "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.",
+ "An instantaneous measurement of a value.",
+ "The change in a value during a time interval.",
+ "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
+ ],
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ],
+ "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A detailed description of the metric, which can be used in documentation.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.",
+ "type": "string"
+ },
+ "unit": {
+ "description": "The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)\nbit bit\nBy byte\ns second\nmin minute\nh hour\nd dayPrefixes (PREFIX)\nk kilo (10**3)\nM mega (10**6)\nG giga (10**9)\nT tera (10**12)\nP peta (10**15)\nE exa (10**18)\nZ zetta (10**21)\nY yotta (10**24)\nm milli (10**-3)\nu micro (10**-6)\nn nano (10**-9)\np pico (10**-12)\nf femto (10**-15)\na atto (10**-18)\nz zepto (10**-21)\ny yocto (10**-24)\nKi kibi (2**10)\nMi mebi (2**20)\nGi gibi (2**30)\nTi tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:\n/ division (as an infix operator, e.g. 1/s).\n. multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:\nExpression = Component { \".\" Component } { \"/\" Component } ;\n\nComponent = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\nAnnotation = \"{\" NAME \"}\" ;\nNotes:\nAnnotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.\nNAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.",
+ "type": "string"
+ }
+ },
+ "id": "MetricDescriptor"
+ },
+ "LogEntry": {
+ "description": "An individual entry in a log.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
+ "type": "object"
+ },
+ "severity": {
+ "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
+ "type": "string",
+ "enumDescriptions": [
+ "(0) The log entry has no assigned severity level.",
+ "(100) Debug or trace information.",
+ "(200) Routine information, such as ongoing status or performance.",
+ "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
+ "(400) Warning events might cause problems.",
+ "(500) Error events are likely to cause problems.",
+ "(600) Critical events cause more severe problems or outages.",
+ "(700) A person must take an action immediately.",
+ "(800) One or more systems are unusable."
+ ],
+ "enum": [
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
+ ]
+ },
+ "sourceLocation": {
+ "description": "Optional. Source code location information associated with the log entry, if any.",
+ "$ref": "LogEntrySourceLocation"
+ },
+ "spanId": {
+ "description": "Optional. The span ID within the trace associated with the log entry. For Stackdriver Trace spans, this is the same format that the Stackdriver Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as \u003ccode\u003e\"000000000000004a\"\u003c/code\u003e.",
+ "type": "string"
+ },
+ "receiveTimestamp": {
+ "description": "Output only. The time the log entry was received by Stackdriver Logging.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Stackdriver Logging assigns it the current time.Incoming log entries should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. Log entries outside those time boundaries will not be available when calling entries.list, but those log entries can still be exported with LogSinks.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "logName": {
+ "description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\nA project number may optionally be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.",
+ "type": "string"
+ },
+ "httpRequest": {
+ "description": "Optional. Information about the HTTP request associated with this log entry, if applicable.",
+ "$ref": "HttpRequest"
+ },
+ "resource": {
+ "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.",
+ "$ref": "MonitoredResource"
+ },
+ "jsonPayload": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
+ "type": "object"
+ },
+ "operation": {
+ "description": "Optional. Information about an operation associated with the log entry, if applicable.",
+ "$ref": "LogEntryOperation"
+ },
+ "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"
+ },
+ "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"
}
},
- "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": "Logging",
"auth": {
"oauth2": {
@@ -1715,5 +1712,8 @@
"rootUrl": "https://logging.googleapis.com/",
"ownerDomain": "google.com",
"name": "logging",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Stackdriver Logging API",
+ "ownerName": "Google"
}
diff --git a/manufacturers/v1/manufacturers-api.json b/manufacturers/v1/manufacturers-api.json
index 5ec97a0..067b9c6 100644
--- a/manufacturers/v1/manufacturers-api.json
+++ b/manufacturers/v1/manufacturers-api.json
@@ -1,4 +1,5 @@
{
+ "title": "Manufacturer Center API",
"ownerName": "Google",
"resources": {
"accounts": {
@@ -6,6 +7,7 @@
"products": {
"methods": {
"list": {
+ "description": "Lists all the products in a Manufacturer Center account.",
"response": {
"$ref": "ListProductsResponse"
},
@@ -13,17 +15,20 @@
"parent"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
"parameters": {
"pageToken": {
- "location": "query",
"description": "The token returned by the previous request.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
- "location": "query",
"description": "Maximum number of product statuses to return in the response, used for\npaging.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"parent": {
"location": "path",
@@ -33,18 +38,11 @@
"pattern": "^accounts/[^/]+$"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
"flatPath": "v1/accounts/{accountsId}/products",
"path": "v1/{+parent}/products",
- "id": "manufacturers.accounts.products.list",
- "description": "Lists all the products in a Manufacturer Center account."
+ "id": "manufacturers.accounts.products.list"
},
"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"
@@ -54,9 +52,42 @@
"name"
],
"httpMethod": "GET",
+ "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": "^[^/]+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/manufacturercenter"
],
+ "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
+ "path": "v1/{+parent}/products/{+name}",
+ "id": "manufacturers.accounts.products.get"
+ },
+ "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.",
+ "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.",
@@ -66,36 +97,6 @@
"location": "path"
},
"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/[^/]+$"
- }
- }
- },
- "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.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "parent",
- "name"
- ],
- "response": {
- "$ref": "Product"
- },
- "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",
@@ -107,11 +108,10 @@
"https://www.googleapis.com/auth/manufacturercenter"
],
"flatPath": "v1/accounts/{accountsId}/products/{productsId}",
- "id": "manufacturers.accounts.products.update",
- "path": "v1/{+parent}/products/{+name}"
+ "path": "v1/{+parent}/products/{+name}",
+ "id": "manufacturers.accounts.products.update"
},
"delete": {
- "description": "Deletes the product from a Manufacturer Center account.",
"response": {
"$ref": "Empty"
},
@@ -124,24 +124,25 @@
"https://www.googleapis.com/auth/manufacturercenter"
],
"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"
+ },
+ "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"
+ "id": "manufacturers.accounts.products.delete",
+ "description": "Deletes the product from a Manufacturer Center account."
}
}
}
@@ -149,11 +150,66 @@
}
},
"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.",
+ "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": {
"description": "OAuth access token.",
"type": "string",
@@ -170,84 +226,199 @@
"default": "true",
"location": "query"
},
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
}
},
"version": "v1",
"baseUrl": "https://manufacturers.googleapis.com/",
+ "servicePath": "",
"description": "Public API for managing Manufacturer Center related data.",
"kind": "discovery#restDescription",
- "servicePath": "",
"basePath": "",
- "revision": "20180111",
"documentationLink": "https://developers.google.com/manufacturers/",
+ "revision": "20180111",
"id": "manufacturers:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "Product": {
+ "description": "Product data.",
+ "type": "object",
+ "properties": {
+ "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",
+ "items": {
+ "$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": {
+ "description": "Attributes of the product uploaded via the Manufacturer Center API or via\nfeeds.",
+ "$ref": "Attributes"
+ },
+ "parent": {
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.\n@OutputOnly",
+ "type": "string"
+ },
+ "manuallyProvidedAttributes": {
+ "$ref": "Attributes",
+ "description": "Attributes of the product provided manually via the Manufacturer Center UI.\n@OutputOnly"
+ },
+ "targetCountry": {
+ "description": "The target country of the product as a CLDR territory code (for example,\nUS).\n@OutputOnly",
+ "type": "string"
+ },
+ "contentLanguage": {
+ "description": "The content language of the product as a two-letter ISO 639-1 language code\n(for example, en).\n@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Product"
+ },
+ "Capacity": {
+ "description": "The capacity of a product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The numeric value of the capacity.",
+ "format": "int64",
+ "type": "string"
+ },
+ "unit": {
+ "description": "The unit of the capacity, i.e., MB, GB, or TB.",
+ "type": "string"
+ }
+ },
+ "id": "Capacity"
+ },
+ "ListProductsResponse": {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "ProductDetail": {
+ "description": "A product detail of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
+ "type": "object",
+ "properties": {
+ "sectionName": {
+ "description": "A short section name that can be reused between multiple product details.",
+ "type": "string"
+ },
+ "attributeName": {
+ "description": "The name of the attribute.",
+ "type": "string"
+ },
+ "attributeValue": {
+ "description": "The value of the attribute.",
+ "type": "string"
+ }
+ },
+ "id": "ProductDetail"
+ },
+ "Issue": {
+ "description": "Product issue.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Description of the issue.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The server-generated type of the issue, for example,\n“INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.",
+ "type": "string"
+ },
+ "attribute": {
+ "description": "If present, the attribute that triggered the issue. For more information\nabout attributes, see\nhttps://support.google.com/manufacturers/answer/6124116.",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "The timestamp when this issue appeared.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "severity": {
+ "description": "The severity of the issue.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified severity, never used.",
+ "Error severity. The issue prevents the usage of the whole item.",
+ "Warning severity. The issue is either one that prevents the usage of the\nattribute that triggered it or one that will soon prevent the usage of\nthe whole item.",
+ "Info severity. The issue is one that doesn't require immediate attention.\nIt is, for example, used to communicate which attributes are still\npending review."
+ ],
+ "enum": [
+ "SEVERITY_UNSPECIFIED",
+ "ERROR",
+ "WARNING",
+ "INFO"
+ ]
+ }
+ },
+ "id": "Issue"
+ },
+ "FeatureDescription": {
+ "description": "A feature description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.",
+ "type": "object",
+ "properties": {
+ "image": {
+ "$ref": "Image",
+ "description": "An optional image describing the feature."
+ },
+ "headline": {
+ "description": "A short description of the feature.",
+ "type": "string"
+ },
+ "text": {
+ "description": "A detailed description of the feature.",
+ "type": "string"
+ }
+ },
+ "id": "FeatureDescription"
+ },
+ "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"
+ },
"Price": {
"description": "A price.",
"type": "object",
@@ -263,19 +434,11 @@
},
"id": "Price"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
"Image": {
"description": "An image.",
"type": "object",
"properties": {
"status": {
- "description": "The status of the image.\n@OutputOnly",
- "type": "string",
"enumDescriptions": [
"The image status is unspecified. Should not be used.",
"The image was uploaded and is being processed.",
@@ -305,7 +468,9 @@
"CRAWL_SKIPPED",
"HOSTLOADED",
"HTTP_404"
- ]
+ ],
+ "description": "The status of the image.\n@OutputOnly",
+ "type": "string"
},
"type": {
"enumDescriptions": [
@@ -332,6 +497,18 @@
"description": "Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.",
"type": "object",
"properties": {
+ "description": {
+ "description": "The description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#description.",
+ "type": "string"
+ },
+ "gender": {
+ "description": "The target gender of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#gender.",
+ "type": "string"
+ },
+ "sizeSystem": {
+ "description": "The size system of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizesystem.",
+ "type": "string"
+ },
"theme": {
"description": "The theme of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#theme.",
"type": "string"
@@ -345,8 +522,8 @@
"type": "string"
},
"imageLink": {
- "description": "The image of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#image.",
- "$ref": "Image"
+ "$ref": "Image",
+ "description": "The image of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#image."
},
"productType": {
"description": "The type or category of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#producttype.",
@@ -386,8 +563,8 @@
"type": "string"
},
"suggestedRetailPrice": {
- "$ref": "Price",
- "description": "The suggested retail price (MSRP) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#price."
+ "description": "The suggested retail price (MSRP) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#price.",
+ "$ref": "Price"
},
"featureDescription": {
"description": "The rich format description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.",
@@ -451,10 +628,6 @@
"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",
@@ -462,25 +635,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": {
- "$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.",
- "type": "string"
- },
- "gender": {
- "description": "The target gender of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#gender.",
- "type": "string"
- },
- "sizeSystem": {
- "description": "The size system of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizesystem.",
- "type": "string"
+ "description": "The capacity of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.",
+ "$ref": "Capacity"
}
},
"id": "Attributes"
@@ -500,170 +665,6 @@
}
},
"id": "Count"
- },
- "Product": {
- "description": "Product data.",
- "type": "object",
- "properties": {
- "finalAttributes": {
- "description": "Final attributes of the product. The final attributes are obtained by\noverriding the uploaded attributes with the manually provided and deleted\nattributes. Google systems only process, evaluate, review, and/or use final\nattributes.\n@OutputOnly",
- "$ref": "Attributes"
- },
- "productId": {
- "description": "The ID of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
- "type": "string"
- },
- "uploadedAttributes": {
- "description": "Attributes of the product uploaded via the Manufacturer Center API or via\nfeeds.",
- "$ref": "Attributes"
- },
- "parent": {
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.\n@OutputOnly",
- "type": "string"
- },
- "manuallyProvidedAttributes": {
- "$ref": "Attributes",
- "description": "Attributes of the product provided manually via the Manufacturer Center UI.\n@OutputOnly"
- },
- "targetCountry": {
- "description": "The target country of the product as a CLDR territory code (for example,\nUS).\n@OutputOnly",
- "type": "string"
- },
- "contentLanguage": {
- "description": "The content language of the product as a two-letter ISO 639-1 language code\n(for example, en).\n@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
- "type": "string"
- },
- "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",
- "items": {
- "$ref": "Issue"
- }
- }
- },
- "id": "Product"
- },
- "Capacity": {
- "description": "The capacity of a product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The numeric value of the capacity.",
- "format": "int64",
- "type": "string"
- },
- "unit": {
- "description": "The unit of the capacity, i.e., MB, GB, or TB.",
- "type": "string"
- }
- },
- "id": "Capacity"
- },
- "ListProductsResponse": {
- "type": "object",
- "properties": {
- "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"
- },
- "ProductDetail": {
- "description": "A product detail of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
- "type": "object",
- "properties": {
- "sectionName": {
- "description": "A short section name that can be reused between multiple product details.",
- "type": "string"
- },
- "attributeName": {
- "description": "The name of the attribute.",
- "type": "string"
- },
- "attributeValue": {
- "description": "The value of the attribute.",
- "type": "string"
- }
- },
- "id": "ProductDetail"
- },
- "FeatureDescription": {
- "description": "A feature description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.",
- "type": "object",
- "properties": {
- "image": {
- "$ref": "Image",
- "description": "An optional image describing the feature."
- },
- "headline": {
- "description": "A short description of the feature.",
- "type": "string"
- },
- "text": {
- "description": "A detailed description of the feature.",
- "type": "string"
- }
- },
- "id": "FeatureDescription"
- },
- "Issue": {
- "description": "Product issue.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Description of the issue.",
- "type": "string"
- },
- "type": {
- "description": "The server-generated type of the issue, for example,\n“INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.",
- "type": "string"
- },
- "attribute": {
- "description": "If present, the attribute that triggered the issue. For more information\nabout attributes, see\nhttps://support.google.com/manufacturers/answer/6124116.",
- "type": "string"
- },
- "timestamp": {
- "description": "The timestamp when this issue appeared.",
- "format": "google-datetime",
- "type": "string"
- },
- "severity": {
- "description": "The severity of the issue.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified severity, never used.",
- "Error severity. The issue prevents the usage of the whole item.",
- "Warning severity. The issue is either one that prevents the usage of the\nattribute that triggered it or one that will soon prevent the usage of\nthe whole item.",
- "Info severity. The issue is one that doesn't require immediate attention.\nIt is, for example, used to communicate which attributes are still\npending review."
- ],
- "enum": [
- "SEVERITY_UNSPECIFIED",
- "ERROR",
- "WARNING",
- "INFO"
- ]
- }
- },
- "id": "Issue"
}
},
"icons": {
@@ -684,6 +685,5 @@
"rootUrl": "https://manufacturers.googleapis.com/",
"ownerDomain": "google.com",
"name": "manufacturers",
- "batchPath": "batch",
- "title": "Manufacturer Center API"
+ "batchPath": "batch"
}
diff --git a/ml/v1/ml-api.json b/ml/v1/ml-api.json
index c4dbe25..4d82f68 100644
--- a/ml/v1/ml-api.json
+++ b/ml/v1/ml-api.json
@@ -1,17 +1,32 @@
{
- "kind": "discovery#restDescription",
- "description": "An API to enable creating and using machine learning models.",
- "servicePath": "",
- "basePath": "",
- "id": "ml:v1",
- "documentationLink": "https://cloud.google.com/ml/",
- "revision": "20180122",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "GoogleIamV1__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": "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": "GoogleIamV1__Binding"
+ }
+ }
+ },
+ "id": "GoogleIamV1__Policy",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "type": "object"
+ },
"GoogleLongrunning__ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -25,9 +40,13 @@
}
}
},
- "id": "GoogleLongrunning__ListOperationsResponse"
+ "id": "GoogleLongrunning__ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
},
"GoogleCloudMlV1__ManualScaling": {
+ "description": "Options for manually scaling a model.",
+ "type": "object",
"properties": {
"nodes": {
"description": "The number of nodes to allocate for this model. These nodes are always up,\nstarting from the time the model is deployed, so the cost of operating\nthis model will be proportional to `nodes` * number of hours since\nlast billing cycle plus the cost for each prediction performed.",
@@ -35,36 +54,15 @@
"type": "integer"
}
},
- "id": "GoogleCloudMlV1__ManualScaling",
- "description": "Options for manually scaling a model.",
- "type": "object"
- },
- "GoogleIamV1__Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "condition": {
- "$ref": "GoogleType__Expr",
- "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is only visible as GOOGLE_INTERNAL or CONDITION_TRUSTED_TESTER."
- },
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "GoogleIamV1__Binding"
+ "id": "GoogleCloudMlV1__ManualScaling"
},
"GoogleCloudMlV1__TrainingOutput": {
- "description": "Represents results of a training job. Output only.",
- "type": "object",
"properties": {
+ "consumedMLUnits": {
+ "description": "The amount of ML units consumed by the job.",
+ "format": "double",
+ "type": "number"
+ },
"trials": {
"description": "Results for individual Hyperparameter trials.\nOnly set for hyperparameter tuning jobs.",
"type": "array",
@@ -80,14 +78,33 @@
"isHyperparameterTuningJob": {
"description": "Whether this job is a hyperparameter tuning job.",
"type": "boolean"
- },
- "consumedMLUnits": {
- "description": "The amount of ML units consumed by the job.",
- "format": "double",
- "type": "number"
}
},
- "id": "GoogleCloudMlV1__TrainingOutput"
+ "id": "GoogleCloudMlV1__TrainingOutput",
+ "description": "Represents results of a training job. Output only.",
+ "type": "object"
+ },
+ "GoogleIamV1__Binding": {
+ "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 only visible as GOOGLE_INTERNAL or CONDITION_TRUSTED_TESTER.",
+ "$ref": "GoogleType__Expr"
+ },
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "GoogleIamV1__Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object"
},
"GoogleCloudMlV1__PredictRequest": {
"properties": {
@@ -101,8 +118,6 @@
"type": "object"
},
"GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric": {
- "description": "An observed value of a metric.",
- "type": "object",
"properties": {
"objectiveValue": {
"description": "The objective value at this training step.",
@@ -115,61 +130,14 @@
"type": "string"
}
},
- "id": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
+ "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": {
- "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"
- },
- "description": {
- "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.",
- "format": "byte",
- "type": "string"
- },
- "isDefault": {
- "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).",
- "type": "boolean"
- },
- "state": {
- "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 being created. New UpdateVersion and DeleteVersion\nrequests will fail if a version is in the CREATING state.",
- "The version failed to be created, possibly cancelled.\n`error_message` should contain the details of the failure.",
- "The version is being deleted. New UpdateVersion and DeleteVersion\nrequests will fail if a version is in the DELETING state.",
- "The version is being updated. New UpdateVersion and DeleteVersion\nrequests will fail if a version is in the UPDATING state."
- ],
- "enum": [
- "UNKNOWN",
- "READY",
- "CREATING",
- "FAILED",
- "DELETING",
- "UPDATING"
- ]
- },
- "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"
- },
- "name": {
- "description": "Required.The name specified for the version when it was created.\n\nThe version name must be unique within the model it is created in.",
- "type": "string"
- },
"lastUseTime": {
"description": "Output only. The time the version was last used for prediction.",
"format": "google-datetime",
@@ -194,17 +162,63 @@
"description": "Output only. The time the version was created.",
"format": "google-datetime",
"type": "string"
+ },
+ "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"
+ },
+ "description": {
+ "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.",
+ "format": "byte",
+ "type": "string"
+ },
+ "isDefault": {
+ "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).",
+ "type": "boolean"
+ },
+ "state": {
+ "enumDescriptions": [
+ "The version state is unspecified.",
+ "The version is ready for prediction.",
+ "The version is being created. New UpdateVersion and DeleteVersion\nrequests will fail if a version is in the CREATING state.",
+ "The version failed to be created, possibly cancelled.\n`error_message` should contain the details of the failure.",
+ "The version is being deleted. New UpdateVersion and DeleteVersion\nrequests will fail if a version is in the DELETING state.",
+ "The version is being updated. New UpdateVersion and DeleteVersion\nrequests will fail if a version is in the UPDATING state."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "READY",
+ "CREATING",
+ "FAILED",
+ "DELETING",
+ "UPDATING"
+ ],
+ "description": "Output only. The state of a version.",
+ "type": "string"
+ },
+ "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"
+ },
+ "name": {
+ "description": "Required.The name specified for the version when it was created.\n\nThe version name must be unique within the model it is created in.",
+ "type": "string"
}
},
"id": "GoogleCloudMlV1__Version"
},
"GoogleCloudMlV1__ParameterSpec": {
+ "description": "Represents a single hyperparameter to optimize.",
+ "type": "object",
"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",
@@ -214,8 +228,6 @@
}
},
"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.",
@@ -227,7 +239,9 @@
"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": {
"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`.",
@@ -262,34 +276,19 @@
"parameterName": {
"description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\".",
"type": "string"
- }
- },
- "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"
- }
+ "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__Location"
+ "id": "GoogleCloudMlV1__ParameterSpec"
},
"GoogleCloudMlV1__PredictionInput": {
+ "description": "Represents input parameters for a prediction job.",
+ "type": "object",
"properties": {
- "region": {
- "description": "Required. The Google Compute Engine region to run the prediction job in.\nSee the \u003ca href=\"/ml-engine/docs/regions\"\u003eavailable regions\u003c/a\u003e for\nML Engine services.",
- "type": "string"
- },
"versionName": {
"description": "Use this field if you want to specify a version of the model to use. The\nstring is formatted the same way as `model_version`, with the addition\nof the version information:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003eYOUR_MODEL/versions/\u003cvar\u003e[YOUR_VERSION]\u003c/var\u003e\"`",
"type": "string"
@@ -302,27 +301,20 @@
"description": "Required. The output Google Cloud Storage location.",
"type": "string"
},
- "uri": {
- "description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.",
- "type": "string"
- },
"maxWorkerCount": {
"description": "Optional. The maximum number of workers to be used for parallel processing.\nDefaults to 10 if not specified.",
"format": "int64",
"type": "string"
},
+ "uri": {
+ "description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.",
+ "type": "string"
+ },
"signatureName": {
"description": "Optional. The name of the signature defined in the SavedModel to use for\nthis job. Please refer to\n[SavedModel](https://tensorflow.github.io/serving/serving_basic.html)\nfor information about how to use signatures.\n\nDefaults to\n[DEFAULT_SERVING_SIGNATURE_DEF_KEY](https://www.tensorflow.org/api_docs/python/tf/saved_model/signature_constants)\n, which is \"serving_default\".",
"type": "string"
},
"dataFormat": {
- "enumDescriptions": [
- "Unspecified format.",
- "Each line of the file is a JSON dictionary representing one record.",
- "Deprecated. Use JSON instead.",
- "INPUT ONLY. The source file is a TFRecord file.",
- "INPUT ONLY. The source file is a GZIP-compressed TFRecord file."
- ],
"enum": [
"DATA_FORMAT_UNSPECIFIED",
"JSON",
@@ -331,7 +323,14 @@
"TF_RECORD_GZIP"
],
"description": "Required. The format of the input data files.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified format.",
+ "Each line of the file is a JSON dictionary representing one record.",
+ "Deprecated. Use JSON instead.",
+ "INPUT ONLY. The source file is a TFRecord file.",
+ "INPUT ONLY. The source file is a GZIP-compressed TFRecord file."
+ ]
},
"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.",
@@ -348,37 +347,45 @@
"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",
- "description": "Represents input parameters for a prediction job.",
- "type": "object"
+ "id": "GoogleCloudMlV1__PredictionInput"
},
- "GoogleType__Expr": {
+ "GoogleCloudMlV1__Location": {
"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.",
+ "name": {
"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"
+ "capabilities": {
+ "description": "Capabilities available in the location.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1__Capability"
+ }
}
},
- "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\"",
+ "id": "GoogleCloudMlV1__Location",
"type": "object"
},
"GoogleCloudMlV1__OperationMetadata": {
"properties": {
+ "modelName": {
+ "description": "Contains the name of the model associated with the operation.",
+ "type": "string"
+ },
+ "version": {
+ "description": "Contains the version associated with the operation.",
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "endTime": {
+ "description": "The time operation processing completed.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"operationType": {
"enumDescriptions": [
"Unspecified operation type.",
@@ -426,28 +433,37 @@
},
"description": "The user labels, inherited from the model or the model version being\noperated on.",
"type": "object"
- },
- "modelName": {
- "description": "Contains the name of the model associated with the operation.",
- "type": "string"
- },
- "version": {
- "description": "Contains the version associated with the operation.",
- "$ref": "GoogleCloudMlV1__Version"
- },
- "endTime": {
- "description": "The time operation processing completed.",
- "format": "google-datetime",
- "type": "string"
}
},
"id": "GoogleCloudMlV1__OperationMetadata",
"description": "Represents the metadata of the long-running operation.",
"type": "object"
},
- "GoogleCloudMlV1__ListLocationsResponse": {
+ "GoogleType__Expr": {
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
"type": "object",
"properties": {
+ "description": {
+ "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
+ "type": "string"
+ },
+ "expression": {
+ "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
+ "type": "string"
+ },
+ "title": {
+ "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
+ "type": "string"
+ },
+ "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"
+ },
+ "GoogleCloudMlV1__ListLocationsResponse": {
+ "properties": {
"locations": {
"description": "Locations where at least one type of CMLE capability is available.",
"type": "array",
@@ -460,9 +476,12 @@
"type": "string"
}
},
- "id": "GoogleCloudMlV1__ListLocationsResponse"
+ "id": "GoogleCloudMlV1__ListLocationsResponse",
+ "type": "object"
},
"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.",
@@ -470,17 +489,17 @@
"type": "integer"
},
"goal": {
+ "enum": [
+ "GOAL_TYPE_UNSPECIFIED",
+ "MAXIMIZE",
+ "MINIMIZE"
+ ],
"description": "Required. The type of goal to use for tuning. Available types are\n`MAXIMIZE` and `MINIMIZE`.\n\nDefaults to `MAXIMIZE`.",
"type": "string",
"enumDescriptions": [
"Goal Type will default to maximize.",
"Maximize the goal metric.",
"Minimize the goal metric."
- ],
- "enum": [
- "GOAL_TYPE_UNSPECIFIED",
- "MAXIMIZE",
- "MINIMIZE"
]
},
"hyperparameterMetricTag": {
@@ -500,72 +519,68 @@
"type": "integer"
}
},
- "id": "GoogleCloudMlV1__HyperparameterSpec",
- "description": "Represents a set of hyperparameters to optimize.",
- "type": "object"
+ "id": "GoogleCloudMlV1__HyperparameterSpec"
},
"GoogleCloudMlV1__ListJobsResponse": {
- "description": "Response message for the ListJobs method.",
- "type": "object",
"properties": {
- "nextPageToken": {
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
- "type": "string"
- },
"jobs": {
"description": "The list of jobs.",
"type": "array",
"items": {
"$ref": "GoogleCloudMlV1__Job"
}
+ },
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
}
},
- "id": "GoogleCloudMlV1__ListJobsResponse"
- },
- "GoogleCloudMlV1__SetDefaultVersionRequest": {
- "properties": {},
- "id": "GoogleCloudMlV1__SetDefaultVersionRequest",
- "description": "Request message for the SetDefaultVersion request.",
+ "id": "GoogleCloudMlV1__ListJobsResponse",
+ "description": "Response message for the ListJobs method.",
"type": "object"
},
- "GoogleLongrunning__Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "GoogleCloudMlV1__SetDefaultVersionRequest": {
+ "description": "Request message for the SetDefaultVersion request.",
"type": "object",
+ "properties": {},
+ "id": "GoogleCloudMlV1__SetDefaultVersionRequest"
+ },
+ "GoogleLongrunning__Operation": {
"properties": {
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
"error": {
"$ref": "GoogleRpc__Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
- "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"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
}
},
- "id": "GoogleLongrunning__Operation"
+ "id": "GoogleLongrunning__Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
},
"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": {
"defaultVersion": {
"$ref": "GoogleCloudMlV1__Version",
@@ -603,17 +618,17 @@
"type": "string"
}
},
- "id": "GoogleCloudMlV1__Model"
+ "id": "GoogleCloudMlV1__Model",
+ "description": "Represents a machine learning solution.\n\nA model can have multiple versions, each of which is a deployed, trained\nmodel ready to receive prediction requests. The model itself is just a\ncontainer.",
+ "type": "object"
},
"GoogleProtobuf__Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
"properties": {},
- "id": "GoogleProtobuf__Empty"
+ "id": "GoogleProtobuf__Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
},
"GoogleIamV1__TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
"properties": {
"permissions": {
"description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
@@ -623,7 +638,9 @@
}
}
},
- "id": "GoogleIamV1__TestIamPermissionsRequest"
+ "id": "GoogleIamV1__TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object"
},
"GoogleCloudMlV1__ListVersionsResponse": {
"properties": {
@@ -649,21 +666,7 @@
"properties": {},
"id": "GoogleCloudMlV1__CancelJobRequest"
},
- "GoogleCloudMlV1__AutoScaling": {
- "description": "Options for automatically scaling a model.",
- "type": "object",
- "properties": {
- "minNodes": {
- "description": "Optional. The minimum number of nodes to allocate for this model. These\nnodes are always up, starting from the time the model is deployed, so the\ncost of operating this model will be at least\n`rate` * `min_nodes` * number of hours since last billing cycle,\nwhere `rate` is the cost per node-hour as documented in\n[pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing),\neven if no predictions are performed. There is additional cost for each\nprediction performed.\n\nUnlike manual scaling, if the load gets too heavy for the nodes\nthat are up, the service will automatically add nodes to handle the\nincreased load as well as scale back as traffic drops, always maintaining\nat least `min_nodes`. You will be charged for the time in which additional\nnodes are used.\n\nIf not specified, `min_nodes` defaults to 0, in which case, when traffic\nto a model stops (and after a cool-down period), nodes will be shut down\nand no charges will be incurred until traffic to the model resumes.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GoogleCloudMlV1__AutoScaling"
- },
"GoogleRpc__Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
"properties": {
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
@@ -686,47 +689,24 @@
"type": "integer"
}
},
- "id": "GoogleRpc__Status"
+ "id": "GoogleRpc__Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
},
- "GoogleCloudMlV1__ListModelsResponse": {
- "description": "Response message for the ListModels method.",
+ "GoogleCloudMlV1__AutoScaling": {
+ "description": "Options for automatically scaling a model.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
- "type": "string"
- },
- "models": {
- "description": "The list of models.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudMlV1__Model"
- }
+ "minNodes": {
+ "description": "Optional. The minimum number of nodes to allocate for this model. These\nnodes are always up, starting from the time the model is deployed, so the\ncost of operating this model will be at least\n`rate` * `min_nodes` * number of hours since last billing cycle,\nwhere `rate` is the cost per node-hour as documented in\n[pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing),\neven if no predictions are performed. There is additional cost for each\nprediction performed.\n\nUnlike manual scaling, if the load gets too heavy for the nodes\nthat are up, the service will automatically add nodes to handle the\nincreased load as well as scale back as traffic drops, always maintaining\nat least `min_nodes`. You will be charged for the time in which additional\nnodes are used.\n\nIf not specified, `min_nodes` defaults to 0, in which case, when traffic\nto a model stops (and after a cool-down period), nodes will be shut down\nand no charges will be incurred until traffic to the model resumes.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "GoogleCloudMlV1__ListModelsResponse"
+ "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"
- },
"args": {
"description": "Optional. Command line arguments to pass to the program.",
"type": "array",
@@ -789,24 +769,61 @@
"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"
+ "id": "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"
+ },
+ "GoogleCloudMlV1__ListModelsResponse": {
+ "description": "Response message for the ListModels method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
+ },
+ "models": {
+ "description": "The list of models.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1__Model"
+ }
+ }
+ },
+ "id": "GoogleCloudMlV1__ListModelsResponse"
},
"GoogleCloudMlV1__Job": {
"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."
- },
- "createTime": {
- "description": "Output only. When the job was created.",
- "format": "google-datetime",
- "type": "string"
+ "description": "The current training job result.",
+ "$ref": "GoogleCloudMlV1__TrainingOutput"
},
"labels": {
"additionalProperties": {
@@ -815,9 +832,14 @@
"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"
},
+ "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"
+ "$ref": "GoogleCloudMlV1__PredictionInput",
+ "description": "Input parameters to create a prediction job."
},
"errorMessage": {
"description": "Output only. The details of a failure or a cancellation.",
@@ -864,11 +886,6 @@
"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"
}
},
"id": "GoogleCloudMlV1__Job",
@@ -879,15 +896,6 @@
"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",
@@ -898,12 +906,20 @@
},
"type": "object"
}
+ },
+ "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": {
"type": {
"enumDescriptions": [
@@ -921,24 +937,25 @@
"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": {
- "type": "string",
"enum": [
"ACCELERATOR_TYPE_UNSPECIFIED",
"NVIDIA_TESLA_K80",
"NVIDIA_TESLA_P100"
- ]
- }
+ ],
+ "type": "string"
+ },
+ "enumDescriptions": [
+ "Unspecified accelerator type. Default to no GPU.",
+ "Nvidia tesla k80 GPU.",
+ "Nvidia tesla P100 GPU."
+ ]
}
},
- "id": "GoogleCloudMlV1__Capability"
+ "id": "GoogleCloudMlV1__Capability",
+ "type": "object"
},
"GoogleCloudMlV1__GetConfigResponse": {
"description": "Returns service account information associated with a project.",
@@ -957,6 +974,8 @@
"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.",
@@ -966,30 +985,16 @@
}
}
},
- "id": "GoogleIamV1__TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
- },
- "GoogleIamV1__SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "updateMask": {
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "policy": {
- "$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"
+ "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": {
+ "isTrialStoppedEarly": {
+ "description": "True if the trial is stopped early.",
+ "type": "boolean"
+ },
"allMetrics": {
"description": "All recorded object metrics for this trial. This field is not currently\npopulated.",
"type": "array",
@@ -998,8 +1003,8 @@
}
},
"finalMetric": {
- "description": "The final objective metric seen for this trial.",
- "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
+ "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric",
+ "description": "The final objective metric seen for this trial."
},
"hyperparameters": {
"additionalProperties": {
@@ -1011,18 +1016,28 @@
"trialId": {
"description": "The trial id for these results.",
"type": "string"
- },
- "isTrialStoppedEarly": {
- "description": "True if the trial is stopped early.",
- "type": "boolean"
}
},
"id": "GoogleCloudMlV1__HyperparameterOutput"
},
- "GoogleCloudMlV1__PredictionOutput": {
- "description": "Represents results of a prediction job.",
+ "GoogleIamV1__SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "policy": {
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "GoogleIamV1__Policy"
+ }
+ },
+ "id": "GoogleIamV1__SetIamPolicyRequest"
+ },
+ "GoogleCloudMlV1__PredictionOutput": {
+ "properties": {
"errorCount": {
"description": "The number of data instances which resulted in errors.",
"format": "int64",
@@ -1043,38 +1058,16 @@
"type": "string"
}
},
- "id": "GoogleCloudMlV1__PredictionOutput"
- },
- "GoogleIamV1__Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
- "type": "object",
- "properties": {
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "GoogleIamV1__Binding"
- }
- },
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Deprecated.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GoogleIamV1__Policy"
+ "id": "GoogleCloudMlV1__PredictionOutput",
+ "description": "Represents results of a prediction job.",
+ "type": "object"
}
},
- "protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"canonicalName": "Cloud Machine Learning Engine",
"auth": {
"oauth2": {
@@ -1098,8 +1091,6 @@
"operations": {
"methods": {
"cancel": {
- "path": "v1/{+name}:cancel",
- "id": "ml.projects.operations.cancel",
"description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
"response": {
"$ref": "GoogleProtobuf__Empty"
@@ -1108,6 +1099,9 @@
"name"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/operations/[^/]+$",
@@ -1117,10 +1111,9 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel"
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "ml.projects.operations.cancel"
},
"delete": {
"response": {
@@ -1148,7 +1141,6 @@
"description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
},
"list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"response": {
"$ref": "GoogleLongrunning__ListOperationsResponse"
},
@@ -1156,6 +1148,9 @@
"name"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
"description": "The name of the operation's parent resource.",
@@ -1165,15 +1160,15 @@
"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"
+ "type": "integer",
+ "location": "query"
},
"filter": {
"description": "The standard list filter.",
@@ -1181,21 +1176,19 @@
"location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/projects/{projectsId}/operations",
"path": "v1/{+name}/operations",
- "id": "ml.projects.operations.list"
+ "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": {
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
"parameters": {
"name": {
"pattern": "^projects/[^/]+/operations/[^/]+$",
@@ -1209,409 +1202,48 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
- "path": "v1/{+name}",
"id": "ml.projects.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."
}
}
},
"models": {
- "methods": {
- "setIamPolicy": {
- "id": "ml.projects.models.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "request": {
- "$ref": "GoogleIamV1__SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "GoogleIamV1__Policy"
- },
- "parameters": {
- "resource": {
- "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"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}:setIamPolicy"
- },
- "create": {
- "response": {
- "$ref": "GoogleCloudMlV1__Model"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The project name.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models",
- "path": "v1/{+parent}/models",
- "id": "ml.projects.models.create",
- "description": "Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create).",
- "request": {
- "$ref": "GoogleCloudMlV1__Model"
- }
- },
- "getIamPolicy": {
- "response": {
- "$ref": "GoogleIamV1__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/[^/]+/models/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "ml.projects.models.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "patch": {
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Required. Specifies the path, relative to `Model`, of the field to update.\n\nFor example, to change the description of a model to \"foo\" and set its\ndefault version to \"version_1\", the `update_mask` parameter would be\nspecified as `description`, `default_version.name`, and the `PATCH`\nrequest body would specify the new value, as follows:\n {\n \"description\": \"foo\",\n \"defaultVersion\": {\n \"name\":\"version_1\"\n }\n }\nIn this example, the model is blindly overwritten since no etag is given.\n\nTo adopt etag mechanism, include `etag` field in the mask, and include the\n`etag` value in your model resource.\n\nCurrently the supported update masks are `description`,\n`default_version.name`, `labels`, and `etag`.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "description": "Required. The project name.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.models.patch",
- "request": {
- "$ref": "GoogleCloudMlV1__Model"
- },
- "description": "Updates a specific model resource.\n\nCurrently the only supported fields to update are `description` and\n`default_version.name`."
- },
- "get": {
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.models.get",
- "description": "Gets information about a model, including its name, the description (if\nset), and the default version (if at least one version of the model has\nbeen deployed).",
- "response": {
- "$ref": "GoogleCloudMlV1__Model"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path",
- "description": "Required. The name of the model.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "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/[^/]+/models/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "ml.projects.models.testIamPermissions"
- },
- "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": {
- "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}",
- "path": "v1/{+name}",
- "id": "ml.projects.models.delete"
- },
- "list": {
- "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: {}.",
- "response": {
- "$ref": "GoogleCloudMlV1__ListModelsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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"
- },
- "parent": {
- "description": "Required. The name of the project whose models are to be listed.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "filter": {
- "description": "Optional. Specifies the subset of models to retrieve.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "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"
- }
- }
- }
- },
"resources": {
"versions": {
"methods": {
- "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: {}.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1__ListVersionsResponse"
- },
- "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 versions to retrieve per \"page\" of results. If\nthere are more remaining results than this number, the response message\nwill contain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "Required. The name of the model for which to list the version.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
- },
- "filter": {
- "description": "Optional. Specifies the subset of versions to retrieve.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
- "id": "ml.projects.models.versions.list",
- "path": "v1/{+parent}/versions"
- },
- "create": {
- "path": "v1/{+parent}/versions",
- "id": "ml.projects.models.versions.create",
- "description": "Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).",
- "request": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The name of the model.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions"
- },
- "patch": {
- "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": {
- "location": "path",
- "description": "Required. The name of the model.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.models.versions.patch",
- "description": "Updates the specified Version resource.\n\nCurrently the only supported field to update is `description`.",
- "request": {
- "$ref": "GoogleCloudMlV1__Version"
- }
- },
- "get": {
- "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model.",
- "response": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "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"
- },
"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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "GoogleCloudMlV1__Version"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
- "location": "path",
"description": "Required. The name of the version to make the default for the model. You\ncan get the names of all the versions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
- "id": "ml.projects.models.versions.setDefault",
- "path": "v1/{+name}:setDefault"
+ "path": "v1/{+name}:setDefault",
+ "id": "ml.projects.models.versions.setDefault"
},
"delete": {
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.versions.delete",
+ "description": "Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version.",
"response": {
"$ref": "GoogleLongrunning__Operation"
},
@@ -1631,28 +1263,386 @@
"location": "path"
}
},
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}"
+ },
+ "list": {
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the model for which to list the version.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
+ "path": "v1/{+parent}/versions",
+ "id": "ml.projects.models.versions.list",
+ "description": "Gets basic information about all the versions of a model.\n\nIf you expect that a model has many versions, or if you need to handle\nonly a limited number of results at a time, you can request that the list\nbe retrieved in batches (called pages).\n\nIf there are no versions that match the request parameters, the list\nrequest returns an empty response body: {}."
+ },
+ "create": {
+ "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).",
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the model.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
+ "path": "v1/{+parent}/versions",
+ "id": "ml.projects.models.versions.create"
+ },
+ "patch": {
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the model.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path"
+ },
+ "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"
+ }
+ },
"flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
"path": "v1/{+name}",
- "id": "ml.projects.models.versions.delete",
- "description": "Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version."
+ "id": "ml.projects.models.versions.patch",
+ "description": "Updates the specified Version resource.\n\nCurrently the only supported field to update is `description`.",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Version"
+ }
+ },
+ "get": {
+ "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model.",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the version.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.versions.get"
}
}
}
+ },
+ "methods": {
+ "testIamPermissions": {
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "ml.projects.models.testIamPermissions",
+ "request": {
+ "$ref": "GoogleIamV1__TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "response": {
+ "$ref": "GoogleIamV1__TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}:testIamPermissions"
+ },
+ "delete": {
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the model.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.delete",
+ "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)."
+ },
+ "list": {
+ "description": "Lists the models in a project.\n\nEach project can contain multiple models, and each model can have multiple\nversions.\n\nIf there are no models that match the request parameters, the list request\nreturns an empty response body: {}.",
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListModelsResponse"
+ },
+ "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": {
+ "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": {
+ "description": "Required. The name of the project whose models are to be listed.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "filter": {
+ "location": "query",
+ "description": "Optional. Specifies the subset of models to retrieve.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models",
+ "path": "v1/{+parent}/models",
+ "id": "ml.projects.models.list"
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "GoogleIamV1__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/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}:setIamPolicy",
+ "id": "ml.projects.models.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "GoogleIamV1__SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "create": {
+ "response": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The project name.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models",
+ "path": "v1/{+parent}/models",
+ "id": "ml.projects.models.create",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "description": "Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create)."
+ },
+ "getIamPolicy": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleIamV1__Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "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}/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."
+ },
+ "patch": {
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "Required. The project name.",
+ "required": true,
+ "type": "string"
+ },
+ "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": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.patch",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "description": "Updates a specific model resource.\n\nCurrently the only supported fields to update are `description` and\n`default_version.name`."
+ },
+ "get": {
+ "response": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the model.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.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)."
+ }
}
},
"locations": {
"methods": {
"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": "GoogleCloudMlV1__Location"
+ },
"parameters": {
"name": {
"description": "Required. The name of the location.",
@@ -1665,10 +1655,12 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}"
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
+ "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."
},
"list": {
- "flatPath": "v1/projects/{projectsId}/locations",
"path": "v1/{+parent}/locations",
"id": "ml.projects.locations.list",
"description": "List all locations that provides at least one type of CMLE capability.",
@@ -1679,35 +1671,42 @@
"parent"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "parent": {
- "description": "Required. The name of the project for which available locations are to be\nlisted (since some locations might be whitelisted for specific projects).",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
"pageToken": {
"description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
"type": "string",
"location": "query"
},
"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"
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "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"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations"
}
}
},
"jobs": {
"methods": {
"cancel": {
+ "id": "ml.projects.jobs.cancel",
+ "path": "v1/{+name}:cancel",
+ "request": {
+ "$ref": "GoogleCloudMlV1__CancelJobRequest"
+ },
+ "description": "Cancels a running job.",
"httpMethod": "POST",
"parameterOrder": [
"name"
@@ -1727,69 +1726,34 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:cancel",
- "id": "ml.projects.jobs.cancel",
- "path": "v1/{+name}:cancel",
- "request": {
- "$ref": "GoogleCloudMlV1__CancelJobRequest"
- },
- "description": "Cancels a running job."
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:cancel"
},
"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": {
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/jobs/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "ml.projects.jobs.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "get": {
- "response": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Required. The name of the job to get the description of.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.jobs.get",
- "description": "Describes a job."
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy",
+ "id": "ml.projects.jobs.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy"
},
"patch": {
- "request": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "description": "Updates a specific job resource.\n\nCurrently the only supported fields to update are `labels`.",
"httpMethod": "PATCH",
"parameterOrder": [
"name"
@@ -1799,10 +1763,10 @@
},
"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"
+ "type": "string",
+ "location": "query"
},
"name": {
"pattern": "^projects/[^/]+/jobs/[^/]+$",
@@ -1817,22 +1781,45 @@
],
"flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
"id": "ml.projects.jobs.patch",
- "path": "v1/{+name}"
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "description": "Updates a specific job resource.\n\nCurrently the only supported fields to update are `labels`."
+ },
+ "get": {
+ "response": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the job to get the description of.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.jobs.get",
+ "description": "Describes a job."
},
"testIamPermissions": {
- "id": "ml.projects.jobs.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "GoogleIamV1__TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "GoogleIamV1__TestIamPermissionsResponse"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/jobs/[^/]+$",
@@ -1845,10 +1832,15 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions"
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "ml.projects.jobs.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."
},
"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"
},
@@ -1869,16 +1861,16 @@
"location": "query"
},
"parent": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
"description": "Required. The name of the project for which to list jobs.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
+ "type": "string"
},
"filter": {
+ "location": "query",
"description": "Optional. Specifies the subset of jobs to retrieve.\nYou can filter on the value of one or more attributes of the job object.\nFor example, retrieve jobs with a job identifier that starts with 'census':\n\u003cp\u003e\u003ccode\u003egcloud ml-engine jobs list --filter='jobId:census*'\u003c/code\u003e\n\u003cp\u003eList all failed jobs with names that start with 'rnn':\n\u003cp\u003e\u003ccode\u003egcloud ml-engine jobs list --filter='jobId:rnn*\nAND state:FAILED'\u003c/code\u003e\n\u003cp\u003eFor more examples, see the guide to\n\u003ca href=\"/ml-engine/docs/monitor-training\"\u003emonitoring jobs\u003c/a\u003e.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
},
"scopes": [
@@ -1886,44 +1878,20 @@
],
"flatPath": "v1/projects/{projectsId}/jobs",
"path": "v1/{+parent}/jobs",
- "id": "ml.projects.jobs.list"
- },
- "create": {
- "flatPath": "v1/projects/{projectsId}/jobs",
- "path": "v1/{+parent}/jobs",
- "id": "ml.projects.jobs.create",
- "description": "Creates a training or a batch prediction job.",
- "request": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "response": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The project name.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- }
+ "id": "ml.projects.jobs.list",
+ "description": "Lists the jobs in the project.\n\nIf there are no jobs that match the request parameters, the list\nrequest returns an empty response body: {}."
},
"setIamPolicy": {
- "response": {
- "$ref": "GoogleIamV1__Policy"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "GoogleIamV1__Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
@@ -1933,23 +1901,47 @@
"location": "path"
}
},
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy",
+ "id": "ml.projects.jobs.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "GoogleIamV1__SetIamPolicyRequest"
+ }
+ },
+ "create": {
+ "request": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "description": "Creates a training or a batch prediction job.",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The project name.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "ml.projects.jobs.setIamPolicy",
- "request": {
- "$ref": "GoogleIamV1__SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ "flatPath": "v1/projects/{projectsId}/jobs",
+ "path": "v1/{+parent}/jobs",
+ "id": "ml.projects.jobs.create"
}
}
}
},
"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"
},
@@ -1971,35 +1963,36 @@
},
"flatPath": "v1/projects/{projectsId}:getConfig",
"path": "v1/{+name}:getConfig",
- "id": "ml.projects.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."
},
"predict": {
- "flatPath": "v1/projects/{projectsId}:predict",
- "path": "v1/{+name}:predict",
- "id": "ml.projects.predict",
- "description": "Performs prediction on the data in the request.\nCloud ML Engine implements a custom `predict` verb on top of an HTTP POST\nmethod. \u003cp\u003eFor details of the request and response format, see the **guide\nto the [predict request format](/ml-engine/docs/v1/predict-request)**.",
"request": {
"$ref": "GoogleCloudMlV1__PredictRequest"
},
- "response": {
- "$ref": "GoogleApi__HttpBody"
- },
+ "description": "Performs prediction on the data in the request.\nCloud ML Engine implements a custom `predict` verb on top of an HTTP POST\nmethod. \u003cp\u003eFor details of the request and response format, see the **guide\nto the [predict request format](/ml-engine/docs/v1/predict-request)**.",
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "GoogleApi__HttpBody"
+ },
"parameters": {
"name": {
+ "pattern": "^projects/.+$",
"location": "path",
"description": "Required. The resource name of a model or a version.\n\nAuthorization: requires the `predict` permission on the specified resource.",
"required": true,
- "type": "string",
- "pattern": "^projects/.+$"
+ "type": "string"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}:predict",
+ "id": "ml.projects.predict",
+ "path": "v1/{+name}:predict"
}
}
}
@@ -2021,30 +2014,25 @@
"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": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
+ "default": "true",
"location": "query"
},
"bearer_token": {
@@ -2052,46 +2040,58 @@
"description": "OAuth bearer token.",
"type": "string"
},
- "upload_protocol": {
+ "oauth_token": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "description": "OAuth 2.0 token for the current user.",
"type": "string"
},
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "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",
+ "location": "query"
+ },
"$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
+ "location": "query"
}
},
"version": "v1",
- "baseUrl": "https://ml.googleapis.com/"
+ "baseUrl": "https://ml.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "An API to enable creating and using machine learning models.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "ml:v1",
+ "documentationLink": "https://cloud.google.com/ml/",
+ "revision": "20180122"
}
diff --git a/monitoring/v3/monitoring-api.json b/monitoring/v3/monitoring-api.json
index d65e0d2..56d9c02 100644
--- a/monitoring/v3/monitoring-api.json
+++ b/monitoring/v3/monitoring-api.json
@@ -1,959 +1,4 @@
{
- "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": {
- "list": {
- "response": {
- "$ref": "ListTimeSeriesResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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"
- },
- "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_COUNT_FALSE",
- "ALIGN_FRACTION_TRUE",
- "ALIGN_PERCENTILE_99",
- "ALIGN_PERCENTILE_95",
- "ALIGN_PERCENTILE_50",
- "ALIGN_PERCENTILE_05",
- "ALIGN_PERCENT_CHANGE"
- ],
- "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": {
- "location": "query",
- "enum": [
- "FULL",
- "HEADERS"
- ],
- "description": "Specifies which information is returned about the time series.",
- "type": "string"
- },
- "aggregation.groupByFields": {
- "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "name": {
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "interval.endTime": {
- "location": "query",
- "description": "Required. The end of the time interval.",
- "format": "google-datetime",
- "type": "string"
- },
- "aggregation.alignmentPeriod": {
- "description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.",
- "format": "google-duration",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "orderBy": {
- "location": "query",
- "description": "Unsupported: must be left blank. The points in each time series are returned in reverse time order.",
- "type": "string"
- },
- "aggregation.crossSeriesReducer": {
- "enum": [
- "REDUCE_NONE",
- "REDUCE_MEAN",
- "REDUCE_MIN",
- "REDUCE_MAX",
- "REDUCE_SUM",
- "REDUCE_STDDEV",
- "REDUCE_COUNT",
- "REDUCE_COUNT_TRUE",
- "REDUCE_COUNT_FALSE",
- "REDUCE_FRACTION_TRUE",
- "REDUCE_PERCENTILE_99",
- "REDUCE_PERCENTILE_95",
- "REDUCE_PERCENTILE_50",
- "REDUCE_PERCENTILE_05"
- ],
- "description": "The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.",
- "type": "string",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:\nmetric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND\n metric.label.instance_name = \"my-instance-name\"\n",
- "type": "string"
- }
- },
- "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",
- "description": "Lists time series that match a filter. This method does not require a Stackdriver account."
- },
- "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."
- }
- }
- },
- "uptimeCheckConfigs": {
- "methods": {
- "list": {
- "description": "Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListUptimeCheckConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "parent": {
- "description": "The project whose uptime check configurations are listed. The formatis projects/[PROJECT_ID].",
- "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 more results from the previous method call.",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is \u003c=0, the server will decide the number of results to be returned.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs",
- "id": "monitoring.projects.uptimeCheckConfigs.list",
- "path": "v3/{+parent}/uptimeCheckConfigs"
- },
- "get": {
- "description": "Gets a single uptime check configuration.",
- "response": {
- "$ref": "UptimeCheckConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
- "location": "path",
- "description": "The uptime check configuration to retrieve. The formatis projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
- "required": true,
- "type": "string"
- }
- },
- "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.",
- "response": {
- "$ref": "UptimeCheckConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "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",
- "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$"
- },
- "updateMask": {
- "description": "Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.uptimeCheckConfigs.patch"
- },
- "create": {
- "response": {
- "$ref": "UptimeCheckConfig"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The project in which to create the uptime check. The formatis projects/[PROJECT_ID].",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs",
- "path": "v3/{+parent}/uptimeCheckConfigs",
- "id": "monitoring.projects.uptimeCheckConfigs.create",
- "description": "Creates a new uptime check configuration.",
- "request": {
- "$ref": "UptimeCheckConfig"
- }
- },
- "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": {
- "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
- "location": "path",
- "description": "The uptime check configuration to delete. The formatis projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.uptimeCheckConfigs.delete"
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListMonitoredResourceDescriptorsResponse"
- },
- "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"
- },
- "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"
- },
- "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"
- }
- },
- "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": {
- "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": {
- "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}"
- }
- }
- },
- "groups": {
- "methods": {
- "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}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.groups.delete"
- },
- "list": {
- "response": {
- "$ref": "ListGroupsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "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 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"
- },
- "ancestorsOfGroup": {
- "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The project whose groups are to be listed. The format is \"projects/{project_id_or_number}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "childrenOfGroup": {
- "location": "query",
- "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.",
- "type": "string"
- },
- "descendantsOfGroup": {
- "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "flatPath": "v3/projects/{projectsId}/groups",
- "path": "v3/{+name}/groups",
- "id": "monitoring.projects.groups.list",
- "description": "Lists the existing groups."
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Group"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The group to retrieve. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path"
- }
- },
- "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."
- },
- "update": {
- "description": "Updates an existing group. You can change any group attributes except name.",
- "request": {
- "$ref": "Group"
- },
- "response": {
- "$ref": "Group"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/groups/[^/]+$"
- },
- "validateOnly": {
- "location": "query",
- "description": "If true, validate this request but do not update the existing group.",
- "type": "boolean"
- }
- },
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.groups.update"
- },
- "create": {
- "request": {
- "$ref": "Group"
- },
- "description": "Creates a new group.",
- "response": {
- "$ref": "Group"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The project in which to create the group. The format is \"projects/{project_id_or_number}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "validateOnly": {
- "description": "If true, validate this request but do not create the group.",
- "type": "boolean",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "flatPath": "v3/projects/{projectsId}/groups",
- "path": "v3/{+name}/groups",
- "id": "monitoring.projects.groups.create"
- }
- },
- "resources": {
- "members": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListGroupMembersResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "parameters": {
- "interval.endTime": {
- "location": "query",
- "description": "Required. The end of the time interval.",
- "format": "google-datetime",
- "type": "string"
- },
- "filter": {
- "description": "An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:\nresource.type = \"gce_instance\"\n",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer"
- },
- "interval.startTime": {
- "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": {
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path",
- "description": "The group whose members are listed. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
- "required": true,
- "type": "string"
- }
- },
- "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."
- }
- }
- }
- }
- },
- "collectdTimeSeries": {
- "methods": {
- "create": {
- "flatPath": "v3/projects/{projectsId}/collectdTimeSeries",
- "path": "v3/{+name}/collectdTimeSeries",
- "id": "monitoring.projects.collectdTimeSeries.create",
- "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",
- "request": {
- "$ref": "CreateCollectdTimeSeriesRequest"
- },
- "response": {
- "$ref": "CreateCollectdTimeSeriesResponse"
- },
- "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 in which to create the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- }
- }
- }
- },
- "metricDescriptors": {
- "methods": {
- "delete": {
- "description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/metricDescriptors/.+$",
- "location": "path",
- "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.com/my_test_metric\".",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}",
- "id": "monitoring.projects.metricDescriptors.delete",
- "path": "v3/{+name}"
- },
- "list": {
- "description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account.",
- "response": {
- "$ref": "ListMetricDescriptorsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "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": {
- "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"
- },
- "pageSize": {
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "flatPath": "v3/projects/{projectsId}/metricDescriptors",
- "path": "v3/{+name}/metricDescriptors",
- "id": "monitoring.projects.metricDescriptors.list"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "MetricDescriptor"
- },
- "parameters": {
- "name": {
- "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example value of {metric_id} is \"compute.googleapis.com/instance/disk/read_bytes_count\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metricDescriptors/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}",
- "id": "monitoring.projects.metricDescriptors.get",
- "path": "v3/{+name}",
- "description": "Gets a single metric descriptor. This method does not require a Stackdriver account."
- },
- "create": {
- "request": {
- "$ref": "MetricDescriptor"
- },
- "description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics.",
- "response": {
- "$ref": "MetricDescriptor"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "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/[^/]+$"
- }
- },
- "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",
- "path": "v3/{+name}/metricDescriptors",
- "id": "monitoring.projects.metricDescriptors.create"
- }
- }
- }
- }
- },
- "uptimeCheckIps": {
- "methods": {
- "list": {
- "description": "Returns the list of IPs that checkers run from",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListUptimeCheckIpsResponse"
- },
- "parameters": {
- "pageToken": {
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. NOTE: this field is not yet implemented",
- "type": "string",
- "location": "query"
- },
- "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": {
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "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": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- }
- },
"version": "v3",
"baseUrl": "https://monitoring.googleapis.com/",
"kind": "discovery#restDescription",
@@ -966,6 +11,825 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "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"
+ },
+ "CollectdValue": {
+ "properties": {
+ "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"
+ },
+ "dataSourceType": {
+ "description": "The type of measurement.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified data source type. This corresponds to google.api.MetricDescriptor.MetricKind.METRIC_KIND_UNSPECIFIED.",
+ "An instantaneous measurement of a varying quantity. This corresponds to google.api.MetricDescriptor.MetricKind.GAUGE.",
+ "A cumulative value over time. This corresponds to google.api.MetricDescriptor.MetricKind.CUMULATIVE.",
+ "A rate of change of the measurement.",
+ "An amount of change since the last measurement interval. This corresponds to google.api.MetricDescriptor.MetricKind.DELTA."
+ ],
+ "enum": [
+ "UNSPECIFIED_DATA_SOURCE_TYPE",
+ "GAUGE",
+ "COUNTER",
+ "DERIVE",
+ "ABSOLUTE"
+ ]
+ }
+ },
+ "id": "CollectdValue",
+ "description": "A single data point from a collectd-based plugin.",
+ "type": "object"
+ },
+ "MetricDescriptor": {
+ "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
+ "type": "object",
+ "properties": {
+ "metricKind": {
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ],
+ "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "An instantaneous measurement of a value.",
+ "The change in a value during a time interval.",
+ "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
+ ]
+ },
+ "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": "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": {
+ "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"
+ ]
+ }
+ },
+ "id": "MetricDescriptor"
+ },
+ "SourceContext": {
+ "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.",
+ "type": "object",
+ "properties": {
+ "fileName": {
+ "description": "The path-qualified name of the .proto file that contained the associated protobuf element. For example: \"google/protobuf/source_context.proto\".",
+ "type": "string"
+ }
+ },
+ "id": "SourceContext"
+ },
+ "Range": {
+ "description": "The range of the population values.",
+ "type": "object",
+ "properties": {
+ "min": {
+ "description": "The minimum of the population values.",
+ "format": "double",
+ "type": "number"
+ },
+ "max": {
+ "description": "The maximum of the population values.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "Range"
+ },
+ "ListGroupsResponse": {
+ "description": "The ListGroups response.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
+ "type": "string"
+ },
+ "group": {
+ "description": "The groups that match the specified filters.",
+ "type": "array",
+ "items": {
+ "$ref": "Group"
+ }
+ }
+ },
+ "id": "ListGroupsResponse"
+ },
+ "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",
+ "type": "string"
+ },
+ "period": {
+ "description": "How often the uptime check is performed. Currently, only 1, 5, 10, and 15 minutes are supported. Required.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "httpCheck": {
+ "description": "Contains information needed to make an HTTP or HTTPS check.",
+ "$ref": "HttpCheck"
+ },
+ "name": {
+ "description": "A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response.",
+ "type": "string"
+ },
+ "resourceGroup": {
+ "$ref": "ResourceGroup",
+ "description": "The group resource associated with the configuration."
+ },
+ "tcpCheck": {
+ "description": "Contains information needed to make a TCP check.",
+ "$ref": "TcpCheck"
+ },
+ "isInternal": {
+ "description": "Denotes whether this is a check that egresses from InternalCheckers.",
+ "type": "boolean"
+ },
+ "internalCheckers": {
+ "description": "The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all InternalCheckers configured for the project that owns this CheckConfig.",
+ "type": "array",
+ "items": {
+ "$ref": "InternalChecker"
+ }
+ },
+ "selectedRegions": {
+ "description": "The list of regions from which the check will be run. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "REGION_UNSPECIFIED",
+ "USA",
+ "EUROPE",
+ "SOUTH_AMERICA",
+ "ASIA_PACIFIC"
+ ],
+ "type": "string"
+ },
+ "enumDescriptions": [
+ "Default value if no region is specified. Will result in uptime checks running from all regions.",
+ "Allows checks to run from locations within the United States of America.",
+ "Allows checks to run from locations within the continent of Europe.",
+ "Allows checks to run from locations within the continent of South America.",
+ "Allows checks to run from locations within the Asia Pacific area (ex: Singapore)."
+ ]
+ },
+ "displayName": {
+ "description": "A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Account in order to make it easier to identify; however, uniqueness is not enforced. Required.",
+ "type": "string"
+ },
+ "monitoredResource": {
+ "description": "The monitored resource associated with the configuration.",
+ "$ref": "MonitoredResource"
+ }
+ },
+ "id": "UptimeCheckConfig",
+ "description": "This message configures which resources and services to monitor for availability.",
+ "type": "object"
+ },
+ "CreateCollectdTimeSeriesRequest": {
+ "properties": {
+ "collectdVersion": {
+ "description": "The version of collectd that collected the data. Example: \"5.3.0-192.el6\".",
+ "type": "string"
+ },
+ "resource": {
+ "$ref": "MonitoredResource",
+ "description": "The monitored resource associated with the time series."
+ },
+ "collectdPayloads": {
+ "description": "The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.",
+ "type": "array",
+ "items": {
+ "$ref": "CollectdPayload"
+ }
+ }
+ },
+ "id": "CreateCollectdTimeSeriesRequest",
+ "description": "The CreateCollectdTimeSeries request.",
+ "type": "object"
+ },
+ "ListGroupMembersResponse": {
+ "properties": {
+ "members": {
+ "description": "A set of monitored resources in the group.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoredResource"
+ }
+ },
+ "nextPageToken": {
+ "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
+ "type": "string"
+ },
+ "totalSize": {
+ "description": "The total number of elements matching this request.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "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": {
+ "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": "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"
+ },
+ "metricKind": {
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "An instantaneous measurement of a value.",
+ "The change in a value during a time interval.",
+ "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
+ ],
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ],
+ "description": "The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.",
+ "type": "string"
+ },
+ "points": {
+ "description": "The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.",
+ "type": "array",
+ "items": {
+ "$ref": "Point"
+ }
+ },
+ "metric": {
+ "description": "The associated metric. A fully-specified metric used to identify the time series.",
+ "$ref": "Metric"
+ },
+ "resource": {
+ "$ref": "MonitoredResource",
+ "description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data."
+ },
+ "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"
+ }
+ },
+ "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": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
+ "type": "object"
+ },
+ "type": {
+ "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.",
+ "type": "string"
+ }
+ },
+ "id": "MonitoredResource",
+ "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
+ "type": "object"
+ },
+ "ListMetricDescriptorsResponse": {
+ "description": "The ListMetricDescriptors response.",
+ "type": "object",
+ "properties": {
+ "metricDescriptors": {
+ "description": "The metric descriptors that are available to the project and that match the value of filter, if present.",
+ "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": {
+ "properties": {
+ "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"
+ }
+ },
+ "index": {
+ "description": "The zero-based index in CreateCollectdTimeSeriesRequest.collectd_payloads.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "CollectdPayloadError",
+ "description": "Describes the error status for payloads that were not written.",
+ "type": "object"
+ },
+ "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"
+ },
+ "ResourceGroup": {
+ "description": "The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.",
+ "type": "object",
+ "properties": {
+ "groupId": {
+ "description": "The group of resources being monitored. Should be only the group_id, not projects/\u003cproject_id\u003e/groups/\u003cgroup_id\u003e.",
+ "type": "string"
+ },
+ "resourceType": {
+ "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."
+ ]
+ }
+ },
+ "id": "ResourceGroup"
+ },
+ "TypedValue": {
+ "description": "A single strongly-typed value.",
+ "type": "object",
+ "properties": {
+ "int64Value": {
+ "description": "A 64-bit integer. Its range is approximately ±9.2x10\u003csup\u003e18\u003c/sup\u003e.",
+ "format": "int64",
+ "type": "string"
+ },
+ "distributionValue": {
+ "description": "A distribution value.",
+ "$ref": "Distribution"
+ },
+ "boolValue": {
+ "description": "A Boolean value: true or false.",
+ "type": "boolean"
+ },
+ "stringValue": {
+ "description": "A variable-length string value.",
+ "type": "string"
+ },
+ "doubleValue": {
+ "description": "A 64-bit double-precision floating-point number. Its magnitude is approximately ±10\u003csup\u003e±300\u003c/sup\u003e and it has 16 significant digits of precision.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "TypedValue"
+ },
+ "UptimeCheckIp": {
+ "description": "Contains the region, location, and list of IP addresses where checkers in the location run from.",
+ "type": "object",
+ "properties": {
+ "ipAddress": {
+ "description": "The IP address from which the uptime check originates. This is a full IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely and should support interpreting this field in either IPv4 or IPv6 format.",
+ "type": "string"
+ },
+ "region": {
+ "enumDescriptions": [
+ "Default value if no region is specified. Will result in uptime checks running from all regions.",
+ "Allows checks to run from locations within the United States of America.",
+ "Allows checks to run from locations within the continent of Europe.",
+ "Allows checks to run from locations within the continent of South America.",
+ "Allows checks to run from locations within the Asia Pacific area (ex: Singapore)."
+ ],
+ "enum": [
+ "REGION_UNSPECIFIED",
+ "USA",
+ "EUROPE",
+ "SOUTH_AMERICA",
+ "ASIA_PACIFIC"
+ ],
+ "description": "A broad region category in which the IP address is located.",
+ "type": "string"
+ },
+ "location": {
+ "description": "A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.",
+ "type": "string"
+ }
+ },
+ "id": "UptimeCheckIp"
+ },
+ "CollectdValueError": {
+ "description": "Describes the error status for values that were not written.",
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "Records the error status for the value."
+ }
+ },
+ "id": "CollectdValueError"
+ },
+ "CollectdPayload": {
+ "description": "A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "CollectdPayload"
+ },
+ "CreateCollectdTimeSeriesResponse": {
+ "description": "The CreateCollectdTimeSeries response.",
+ "type": "object",
+ "properties": {
+ "payloadErrors": {
+ "description": "Records the error status for points that were not written due to an error.Failed requests for which nothing is written will return an error response instead.",
+ "type": "array",
+ "items": {
+ "$ref": "CollectdPayloadError"
+ }
+ }
+ },
+ "id": "CreateCollectdTimeSeriesResponse"
+ },
+ "Linear": {
+ "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).",
+ "type": "object",
+ "properties": {
+ "numFiniteBuckets": {
+ "description": "Must be greater than 0.",
+ "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"
+ }
+ },
+ "id": "Linear"
+ },
+ "Option": {
+ "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, \"map_entry\". For custom options, it should be the fully-qualified name. For example, \"google.api.http\".",
+ "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, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.",
+ "type": "object"
+ }
+ },
+ "id": "Option"
+ },
+ "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"
+ },
+ "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"
+ },
+ "InternalChecker": {
+ "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"
+ },
+ "displayName": {
+ "description": "The checker's human-readable name.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The GCP project ID. Not necessarily the same as the project_id for the config.",
+ "type": "string"
+ },
+ "checkerId": {
+ "description": "The checker ID.",
+ "type": "string"
+ }
+ },
+ "id": "InternalChecker",
+ "description": "Nimbus InternalCheckers.",
+ "type": "object"
+ },
+ "TcpCheck": {
+ "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.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TcpCheck",
+ "description": "Information required for a TCP uptime check request.",
+ "type": "object"
+ },
+ "Explicit": {
+ "description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
+ "type": "object",
+ "properties": {
+ "bounds": {
+ "description": "The values must be monotonically increasing.",
+ "type": "array",
+ "items": {
+ "format": "double",
+ "type": "number"
+ }
+ }
+ },
+ "id": "Explicit"
+ },
+ "TimeInterval": {
+ "description": "A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "description": "Required. The end of the time interval.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "TimeInterval"
+ },
"ListUptimeCheckIpsResponse": {
"description": "The protocol for the ListUptimeCheckIps response.",
"type": "object",
@@ -1010,13 +874,13 @@
"description": "A single data point in a time series.",
"type": "object",
"properties": {
+ "value": {
+ "$ref": "TypedValue",
+ "description": "The value of the data point."
+ },
"interval": {
"$ref": "TimeInterval",
"description": "The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
- },
- "value": {
- "description": "The value of the data point.",
- "$ref": "TypedValue"
}
},
"id": "Point"
@@ -1025,16 +889,16 @@
"description": "A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.",
"type": "object",
"properties": {
+ "type": {
+ "description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.",
+ "type": "string"
+ },
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.",
"type": "object"
- },
- "type": {
- "description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.",
- "type": "string"
}
},
"id": "Metric"
@@ -1058,9 +922,11 @@
"id": "ListUptimeCheckConfigsResponse"
},
"Field": {
- "description": "A single field of a message type.",
- "type": "object",
"properties": {
+ "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"
@@ -1155,17 +1021,13 @@
"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"
+ "id": "Field",
+ "description": "A single field of a message type.",
+ "type": "object"
},
"LabelDescriptor": {
- "description": "A description of a label.",
- "type": "object",
"properties": {
"key": {
"description": "The label key.",
@@ -1190,9 +1052,13 @@
]
}
},
- "id": "LabelDescriptor"
+ "id": "LabelDescriptor",
+ "description": "A description of a label.",
+ "type": "object"
},
"ListTimeSeriesResponse": {
+ "description": "The ListTimeSeries response.",
+ "type": "object",
"properties": {
"timeSeries": {
"description": "One or more time series that match the filter included in the request.",
@@ -1206,57 +1072,7 @@
"type": "string"
}
},
- "id": "ListTimeSeriesResponse",
- "description": "The ListTimeSeries response.",
- "type": "object"
- },
- "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"
- }
- },
- "syntax": {
- "enumDescriptions": [
- "Syntax proto2.",
- "Syntax proto3."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string"
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- }
- },
- "id": "Type"
+ "id": "ListTimeSeriesResponse"
},
"Group": {
"description": "The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: \"environment\" and \"role\". A parent group has a filter, environment=\"production\". A child of that parent group has a filter, role=\"transcoder\". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.",
@@ -1285,9 +1101,55 @@
},
"id": "Group"
},
+ "Type": {
+ "properties": {
+ "options": {
+ "description": "The protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ },
+ "fields": {
+ "description": "The list of fields.",
+ "type": "array",
+ "items": {
+ "$ref": "Field"
+ }
+ },
+ "name": {
+ "description": "The fully qualified message name.",
+ "type": "string"
+ },
+ "oneofs": {
+ "description": "The list of types appearing in oneof definitions in this type.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "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",
+ "description": "A protocol buffer message type.",
+ "type": "object"
+ },
"BasicAuthentication": {
- "description": "A type of authentication to perform against the specified resource or URL that uses username and password. Currently, only Basic authentication is supported in Uptime Monitoring.",
- "type": "object",
"properties": {
"password": {
"description": "The password to authenticate.",
@@ -1298,19 +1160,12 @@
"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": {
- "description": "Output only. A map of user-defined metadata labels.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
"systemLabels": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -1318,25 +1173,34 @@
},
"description": "Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google Stackdriver. Stackdriver determines what system labels are useful and how to obtain their values. Some examples: \"machine_image\", \"vpc\", \"subnet_id\", \"security_group\", \"name\", etc. System label values can be only strings, Boolean values, or a list of strings. For example:\n{ \"name\": \"my-test-instance\",\n \"security_group\": [\"a\", \"b\", \"c\"],\n \"spot_instance\": false }\n",
"type": "object"
+ },
+ "userLabels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Output only. A map of user-defined metadata labels.",
+ "type": "object"
}
},
- "id": "MonitoredResourceMetadata"
+ "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"
},
"BucketOptions": {
"description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
"type": "object",
"properties": {
"exponentialBuckets": {
- "description": "The exponential buckets.",
- "$ref": "Exponential"
+ "$ref": "Exponential",
+ "description": "The exponential buckets."
},
"linearBuckets": {
"description": "The linear bucket.",
"$ref": "Linear"
},
"explicitBuckets": {
- "$ref": "Explicit",
- "description": "The explicit buckets."
+ "description": "The explicit buckets.",
+ "$ref": "Explicit"
}
},
"id": "BucketOptions"
@@ -1345,18 +1209,6 @@
"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": {
- "description": "The authentication information. Optional when creating an HTTP check; defaults to empty.",
- "$ref": "BasicAuthentication"
- },
"headers": {
"description": "The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second.",
"type": "object",
@@ -1372,833 +1224,981 @@
"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"
- },
- "CollectdValue": {
- "properties": {
- "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"
- },
- "dataSourceType": {
- "enumDescriptions": [
- "An unspecified data source type. This corresponds to google.api.MetricDescriptor.MetricKind.METRIC_KIND_UNSPECIFIED.",
- "An instantaneous measurement of a varying quantity. This corresponds to google.api.MetricDescriptor.MetricKind.GAUGE.",
- "A cumulative value over time. This corresponds to google.api.MetricDescriptor.MetricKind.CUMULATIVE.",
- "A rate of change of the measurement.",
- "An amount of change since the last measurement interval. This corresponds to google.api.MetricDescriptor.MetricKind.DELTA."
- ],
- "enum": [
- "UNSPECIFIED_DATA_SOURCE_TYPE",
- "GAUGE",
- "COUNTER",
- "DERIVE",
- "ABSOLUTE"
- ],
- "description": "The type of measurement.",
- "type": "string"
- }
- },
- "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",
- "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"
- },
- "SourceContext": {
- "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.",
- "type": "object",
- "properties": {
- "fileName": {
- "description": "The path-qualified name of the .proto file that contained the associated protobuf element. For example: \"google/protobuf/source_context.proto\".",
- "type": "string"
- }
- },
- "id": "SourceContext"
- },
- "MetricDescriptor": {
- "properties": {
- "name": {
- "description": "The resource name of the metric descriptor.",
- "type": "string"
- },
- "type": {
- "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n",
- "type": "string"
- },
- "valueType": {
- "enumDescriptions": [
- "Do not use this default value.",
- "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
- "The value is a Distribution.",
- "The value is money."
- ],
- "enum": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "MONEY"
- ],
- "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.",
- "type": "string"
- },
- "metricKind": {
- "enumDescriptions": [
- "Do not use this default value.",
- "An instantaneous measurement of a value.",
- "The change in a value during a time interval.",
- "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
- ],
- "enum": [
- "METRIC_KIND_UNSPECIFIED",
- "GAUGE",
- "DELTA",
- "CUMULATIVE"
- ],
- "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.",
- "type": "string"
- },
- "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": "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"
- }
- }
- },
- "id": "MetricDescriptor",
- "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
- "type": "object"
- },
- "Range": {
- "description": "The range of the population values.",
- "type": "object",
- "properties": {
- "min": {
- "description": "The minimum of the population values.",
- "format": "double",
- "type": "number"
- },
- "max": {
- "description": "The maximum of the population values.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Range"
- },
- "ListGroupsResponse": {
- "description": "The ListGroups response.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
- "type": "string"
- },
- "group": {
- "description": "The groups that match the specified filters.",
- "type": "array",
- "items": {
- "$ref": "Group"
- }
- }
- },
- "id": "ListGroupsResponse"
- },
- "UptimeCheckConfig": {
- "description": "This message configures which resources and services to monitor for availability.",
- "type": "object",
- "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",
- "type": "string"
- },
- "period": {
- "description": "How often the uptime check is performed. Currently, only 1, 5, 10, and 15 minutes are supported. Required.",
- "format": "google-duration",
- "type": "string"
- },
- "name": {
- "description": "A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response.",
- "type": "string"
- },
- "httpCheck": {
- "$ref": "HttpCheck",
- "description": "Contains information needed to make an HTTP or HTTPS check."
- },
- "resourceGroup": {
- "$ref": "ResourceGroup",
- "description": "The group resource associated with the configuration."
- },
- "tcpCheck": {
- "$ref": "TcpCheck",
- "description": "Contains information needed to make a TCP check."
- },
- "internalCheckers": {
- "description": "The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all InternalCheckers configured for the project that owns this CheckConfig.",
- "type": "array",
- "items": {
- "$ref": "InternalChecker"
- }
- },
- "isInternal": {
- "description": "Denotes whether this is a check that egresses from InternalCheckers.",
- "type": "boolean"
- },
- "selectedRegions": {
- "description": "The list of regions from which the check will be run. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.",
- "type": "array",
- "items": {
- "enum": [
- "REGION_UNSPECIFIED",
- "USA",
- "EUROPE",
- "SOUTH_AMERICA",
- "ASIA_PACIFIC"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "Default value if no region is specified. Will result in uptime checks running from all regions.",
- "Allows checks to run from locations within the United States of America.",
- "Allows checks to run from locations within the continent of Europe.",
- "Allows checks to run from locations within the continent of South America.",
- "Allows checks to run from locations within the Asia Pacific area (ex: Singapore)."
- ]
- },
- "displayName": {
- "description": "A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Account in order to make it easier to identify; however, uniqueness is not enforced. Required.",
- "type": "string"
- },
- "monitoredResource": {
- "$ref": "MonitoredResource",
- "description": "The monitored resource associated with the configuration."
- }
- },
- "id": "UptimeCheckConfig"
- },
- "ListGroupMembersResponse": {
- "properties": {
- "members": {
- "description": "A set of monitored resources in the group.",
- "type": "array",
- "items": {
- "$ref": "MonitoredResource"
- }
- },
- "nextPageToken": {
- "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
- "type": "string"
- },
- "totalSize": {
- "description": "The total number of elements matching this request.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListGroupMembersResponse",
- "description": "The ListGroupMembers response.",
- "type": "object"
- },
- "CreateCollectdTimeSeriesRequest": {
- "description": "The CreateCollectdTimeSeries request.",
- "type": "object",
- "properties": {
- "resource": {
- "$ref": "MonitoredResource",
- "description": "The monitored resource associated with the time series."
- },
- "collectdPayloads": {
- "description": "The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.",
- "type": "array",
- "items": {
- "$ref": "CollectdPayload"
- }
- },
- "collectdVersion": {
- "description": "The version of collectd that collected the data. Example: \"5.3.0-192.el6\".",
- "type": "string"
- }
- },
- "id": "CreateCollectdTimeSeriesRequest"
- },
- "ListMonitoredResourceDescriptorsResponse": {
- "description": "The ListMonitoredResourceDescriptors response.",
- "type": "object",
- "properties": {
- "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": {
- "metricKind": {
- "enumDescriptions": [
- "Do not use this default value.",
- "An instantaneous measurement of a value.",
- "The change in a value during a time interval.",
- "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
- ],
- "enum": [
- "METRIC_KIND_UNSPECIFIED",
- "GAUGE",
- "DELTA",
- "CUMULATIVE"
- ],
- "description": "The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.",
- "type": "string"
- },
- "points": {
- "description": "The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.",
- "type": "array",
- "items": {
- "$ref": "Point"
- }
- },
- "metric": {
- "$ref": "Metric",
- "description": "The associated metric. A fully-specified metric used to identify the time series."
- },
- "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": {
- "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."
- ]
- }
- },
- "id": "TimeSeries"
- },
- "CreateTimeSeriesRequest": {
- "description": "The CreateTimeSeries request.",
- "type": "object",
- "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"
- },
- "Distribution": {
- "properties": {
- "sumOfSquaredDeviation": {
- "description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is:\nSum[i=1..n]((x_i - mean)^2)\nKnuth, \"The Art of Computer Programming\", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.",
- "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"
- }
- },
- "bucketOptions": {
- "$ref": "BucketOptions",
- "description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries."
- }
- },
- "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": {
- "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"
- }
- },
- "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": {
- "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": {
- "properties": {
- "doubleValue": {
- "description": "A 64-bit double-precision floating-point number. Its magnitude is approximately ±10\u003csup\u003e±300\u003c/sup\u003e and it has 16 significant digits of precision.",
- "format": "double",
- "type": "number"
- },
- "int64Value": {
- "description": "A 64-bit integer. Its range is approximately ±9.2x10\u003csup\u003e18\u003c/sup\u003e.",
- "format": "int64",
- "type": "string"
- },
- "distributionValue": {
- "$ref": "Distribution",
- "description": "A distribution value."
- },
- "boolValue": {
- "description": "A Boolean value: true or false.",
- "type": "boolean"
- },
- "stringValue": {
- "description": "A variable-length string value.",
- "type": "string"
- }
- },
- "id": "TypedValue",
- "description": "A single strongly-typed value.",
- "type": "object"
- },
- "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": {
- "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",
- "description": "Contains the region, location, and list of IP addresses where checkers in the location run from.",
- "type": "object"
- },
- "CollectdPayload": {
- "description": "A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.",
- "type": "object",
- "properties": {
- "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"
- },
- "values": {
- "description": "The measured values during this time interval. Each value must have a different dataSourceName.",
- "type": "array",
- "items": {
- "$ref": "CollectdValue"
- }
- }
- },
- "id": "CollectdPayload"
- },
- "CreateCollectdTimeSeriesResponse": {
- "properties": {
- "payloadErrors": {
- "description": "Records the error status for points that were not written due to an error.Failed requests for which nothing is written will return an error response instead.",
- "type": "array",
- "items": {
- "$ref": "CollectdPayloadError"
- }
- }
- },
- "id": "CreateCollectdTimeSeriesResponse",
- "description": "The CreateCollectdTimeSeries response.",
- "type": "object"
- },
- "Linear": {
- "properties": {
- "offset": {
- "description": "Lower bound of the first bucket.",
- "format": "double",
- "type": "number"
- },
- "numFiniteBuckets": {
- "description": "Must be greater than 0.",
- "format": "int32",
- "type": "integer"
- },
- "width": {
- "description": "Must be greater than 0.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Linear",
- "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).",
- "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"
- },
- "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"
- },
- "Option": {
- "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, \"map_entry\". For custom options, it should be the fully-qualified name. For example, \"google.api.http\".",
- "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, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.",
- "type": "object"
- }
- },
- "id": "Option"
- },
- "InternalChecker": {
- "description": "Nimbus InternalCheckers.",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "The checker's human-readable name.",
- "type": "string"
- },
- "projectId": {
- "description": "The GCP project ID. Not necessarily the same as the project_id for the config.",
- "type": "string"
- },
- "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"
- },
- "network": {
- "description": "The internal network to perform this uptime check on.",
- "type": "string"
- }
- },
- "id": "InternalChecker"
- },
- "TcpCheck": {
- "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.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TcpCheck",
- "description": "Information required for a TCP uptime check request.",
- "type": "object"
- },
- "TimeInterval": {
- "description": "A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.",
- "type": "object",
- "properties": {
- "endTime": {
- "description": "Required. The end of the time interval.",
- "format": "google-datetime",
- "type": "string"
- },
- "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"
- }
- },
- "id": "TimeInterval"
- },
- "Explicit": {
- "description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
- "type": "object",
- "properties": {
- "bounds": {
- "description": "The values must be monotonically increasing.",
- "type": "array",
- "items": {
- "format": "double",
- "type": "number"
- }
- }
- },
- "id": "Explicit"
}
},
"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": "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": {
+ "timeSeries": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListTimeSeriesResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "orderBy": {
+ "description": "Unsupported: must be left blank. The points in each time series are returned in reverse time order.",
+ "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_COUNT_FALSE",
+ "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": {
+ "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",
+ "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_COUNT_FALSE",
+ "ALIGN_FRACTION_TRUE",
+ "ALIGN_PERCENTILE_99",
+ "ALIGN_PERCENTILE_95",
+ "ALIGN_PERCENTILE_50",
+ "ALIGN_PERCENTILE_05",
+ "ALIGN_PERCENT_CHANGE"
+ ]
+ },
+ "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"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "FULL",
+ "HEADERS"
+ ],
+ "description": "Specifies which information is returned about the time series.",
+ "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"
+ },
+ "aggregation.groupByFields": {
+ "repeated": true,
+ "location": "query",
+ "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.",
+ "type": "string"
+ },
+ "interval.endTime": {
+ "location": "query",
+ "description": "Required. The end of the time interval.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "aggregation.alignmentPeriod": {
+ "description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.",
+ "format": "google-duration",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "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",
+ "description": "Lists time series that match a filter. This method does not require a Stackdriver account."
+ },
+ "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": {
+ "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": {
+ "location": "path",
+ "description": "The uptime check configuration to delete. The formatis projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.uptimeCheckConfigs.delete"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListUptimeCheckConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is \u003c=0, the server will decide the number of results to be returned.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "The project whose uptime check configurations are listed. The formatis 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",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs",
+ "id": "monitoring.projects.uptimeCheckConfigs.list",
+ "path": "v3/{+parent}/uptimeCheckConfigs",
+ "description": "Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations."
+ },
+ "get": {
+ "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.uptimeCheckConfigs.get",
+ "description": "Gets a single uptime check configuration.",
+ "response": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
+ "location": "path",
+ "description": "The uptime check configuration to retrieve. The formatis projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_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"
+ ]
+ },
+ "patch": {
+ "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.uptimeCheckConfigs.patch",
+ "request": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "description": "Updates an uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via \"updateMask\". Returns the updated configuration.",
+ "response": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "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": {
+ "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",
+ "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ]
+ },
+ "create": {
+ "response": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "The project in which to create the uptime check. The formatis 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": {
+ "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors",
+ "path": "v3/{+name}/monitoredResourceDescriptors",
+ "id": "monitoring.projects.monitoredResourceDescriptors.list",
+ "description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.",
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "parameters": {
+ "name": {
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "description": "Lists the existing groups.",
+ "response": {
+ "$ref": "ListGroupsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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"
+ },
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "ancestorsOfGroup": {
+ "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "location": "path",
+ "description": "The project whose groups are to be listed. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups",
+ "path": "v3/{+name}/groups",
+ "id": "monitoring.projects.groups.list"
+ },
+ "get": {
+ "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."
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Group"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/groups/[^/]+$"
+ },
+ "validateOnly": {
+ "location": "query",
+ "description": "If true, validate this request but do not update the existing group.",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
+ "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": {
+ "flatPath": "v3/projects/{projectsId}/groups",
+ "id": "monitoring.projects.groups.create",
+ "path": "v3/{+name}/groups",
+ "request": {
+ "$ref": "Group"
+ },
+ "description": "Creates a new group.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Group"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The project in which to create the group. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ },
+ "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"
+ ]
+ }
+ },
+ "resources": {
+ "members": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListGroupMembersResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "parameters": {
+ "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": {
+ "location": "query",
+ "description": "Required. The end of the time interval.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:\nresource.type = \"gce_instance\"\n",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "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."
+ }
+ }
+ }
+ }
+ },
+ "collectdTimeSeries": {
+ "methods": {
+ "create": {
+ "path": "v3/{+name}/collectdTimeSeries",
+ "id": "monitoring.projects.collectdTimeSeries.create",
+ "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",
+ "request": {
+ "$ref": "CreateCollectdTimeSeriesRequest"
+ },
+ "response": {
+ "$ref": "CreateCollectdTimeSeriesResponse"
+ },
+ "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 in which to create the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/collectdTimeSeries"
+ }
+ }
+ },
+ "metricDescriptors": {
+ "methods": {
+ "create": {
+ "request": {
+ "$ref": "MetricDescriptor"
+ },
+ "description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics.",
+ "response": {
+ "$ref": "MetricDescriptor"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "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",
+ "path": "v3/{+name}/metricDescriptors",
+ "id": "monitoring.projects.metricDescriptors.create"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.com/my_test_metric\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metricDescriptors/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.metricDescriptors.delete",
+ "description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted."
+ },
+ "list": {
+ "id": "monitoring.projects.metricDescriptors.list",
+ "path": "v3/{+name}/metricDescriptors",
+ "description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListMetricDescriptorsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "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": {
+ "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"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors"
+ },
+ "get": {
+ "response": {
+ "$ref": "MetricDescriptor"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example value of {metric_id} is \"compute.googleapis.com/instance/disk/read_bytes_count\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metricDescriptors/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.metricDescriptors.get",
+ "description": "Gets a single metric descriptor. This method does not require a Stackdriver account."
+ }
+ }
+ }
+ }
+ },
+ "uptimeCheckIps": {
+ "methods": {
+ "list": {
+ "id": "monitoring.uptimeCheckIps.list",
+ "path": "v3/uptimeCheckIps",
+ "description": "Returns the list of IPs that checkers run from",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListUptimeCheckIpsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. NOTE: this field is not yet implemented",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is \u003c=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented",
+ "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"
+ ],
+ "flatPath": "v3/uptimeCheckIps"
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
}
}
diff --git a/oslogin/v1/oslogin-api.json b/oslogin/v1/oslogin-api.json
index e19d0d2..e83e07d 100644
--- a/oslogin/v1/oslogin-api.json
+++ b/oslogin/v1/oslogin-api.json
@@ -1,327 +1,70 @@
{
- "canonicalName": "Cloud OS Login",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/compute": {
- "description": "View and manage your Google Compute Engine resources"
- }
- }
- }
- },
- "rootUrl": "https://oslogin.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "oslogin",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud OS Login API",
- "ownerName": "Google",
- "resources": {
- "users": {
- "methods": {
- "importSshPublicKey": {
- "response": {
- "$ref": "ImportSshPublicKeyResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "The project ID of the Google Cloud Platform project.",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "description": "The unique ID for the user in format `users/{user}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "v1/users/{usersId}:importSshPublicKey",
- "path": "v1/{+parent}:importSshPublicKey",
- "id": "oslogin.users.importSshPublicKey",
- "request": {
- "$ref": "SshPublicKey"
- },
- "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile."
- },
- "getLoginProfile": {
- "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"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The unique ID for the user in format `users/{user}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "v1/users/{usersId}/loginProfile"
- }
- },
- "resources": {
- "sshPublicKeys": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path",
- "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "id": "oslogin.users.sshPublicKeys.delete",
- "path": "v1/{+name}",
- "description": "Deletes an SSH public key."
- },
- "get": {
- "path": "v1/{+name}",
- "id": "oslogin.users.sshPublicKeys.get",
- "description": "Retrieves an SSH public key.",
- "response": {
- "$ref": "SshPublicKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "name": {
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path",
- "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}"
- },
- "patch": {
- "path": "v1/{+name}",
- "id": "oslogin.users.sshPublicKeys.patch",
- "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.",
- "request": {
- "$ref": "SshPublicKey"
- },
- "response": {
- "$ref": "SshPublicKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "updateMask": {
- "description": "Mask to control which fields get updated. Updates all if not present.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}"
- }
- }
- },
- "projects": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "name": {
- "pattern": "^users/[^/]+/projects/[^/]+$",
- "location": "path",
- "description": "A reference to the POSIX account to update. POSIX accounts are identified\nby the project ID they are associated with. A reference to the POSIX\naccount is in format `users/{user}/projects/{project}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/users/{usersId}/projects/{projectsId}",
- "path": "v1/{+name}",
- "id": "oslogin.users.projects.delete",
- "description": "Deletes a POSIX account."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "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": {
- "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"
- }
- },
- "version": "v1",
- "baseUrl": "https://oslogin.googleapis.com/",
- "servicePath": "",
- "description": "Manages OS login configuration for Google account users.",
- "kind": "discovery#restDescription",
- "basePath": "",
- "id": "oslogin:v1",
- "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
- "revision": "20180119",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ImportSshPublicKeyResponse": {
- "description": "A response message for importing an SSH public key.",
+ "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.",
+ "type": "string"
+ },
+ "posixAccounts": {
+ "description": "The list of POSIX accounts associated with the user.",
+ "type": "array",
+ "items": {
+ "$ref": "PosixAccount"
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "properties": {
"loginProfile": {
"$ref": "LoginProfile",
"description": "The login profile information for the user."
}
},
- "id": "ImportSshPublicKeyResponse"
+ "id": "ImportSshPublicKeyResponse",
+ "description": "A response message for importing an SSH public key.",
+ "type": "object"
},
"PosixAccount": {
- "description": "The POSIX account information associated with a Google account.",
- "type": "object",
"properties": {
"primary": {
"description": "Only one POSIX account can be marked as primary.",
@@ -362,57 +105,8 @@
"type": "string"
}
},
- "id": "PosixAccount"
- },
- "LoginProfile": {
- "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.",
- "type": "object",
- "properties": {
- "name": {
- "description": "A unique user ID.",
- "type": "string"
- },
- "posixAccounts": {
- "description": "The list of POSIX accounts associated with the user.",
- "type": "array",
- "items": {
- "$ref": "PosixAccount"
- }
- },
- "sshPublicKeys": {
- "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": {
- "key": {
- "description": "Public key text in SSH format, defined by\n\u003ca href=\"https://www.ietf.org/rfc/rfc4253.txt\" target=\"_blank\"\u003eRFC4253\u003c/a\u003e\nsection 6.6.",
- "type": "string"
- },
- "expirationTimeUsec": {
- "description": "An expiration time in microseconds since epoch.",
- "format": "int64",
- "type": "string"
- },
- "fingerprint": {
- "description": "Output only. The SHA-256 fingerprint of the SSH public key.",
- "type": "string"
- }
- },
- "id": "SshPublicKey",
- "description": "The SSH public key information associated with a Google account.",
+ "id": "PosixAccount",
+ "description": "The POSIX account information associated with a Google account.",
"type": "object"
}
},
@@ -420,5 +114,311 @@
"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": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/compute": {
+ "description": "View and manage your Google Compute Engine resources"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://oslogin.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "oslogin",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud OS Login API",
+ "ownerName": "Google",
+ "resources": {
+ "users": {
+ "methods": {
+ "importSshPublicKey": {
+ "request": {
+ "$ref": "SshPublicKey"
+ },
+ "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile.",
+ "response": {
+ "$ref": "ImportSshPublicKeyResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The project ID of the Google Cloud Platform project.",
+ "type": "string"
+ },
+ "parent": {
+ "pattern": "^users/[^/]+$",
+ "location": "path",
+ "description": "The unique ID for the user in format `users/{user}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1/users/{usersId}:importSshPublicKey",
+ "path": "v1/{+parent}:importSshPublicKey",
+ "id": "oslogin.users.importSshPublicKey"
+ },
+ "getLoginProfile": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "LoginProfile"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^users/[^/]+$",
+ "location": "path",
+ "description": "The unique ID for the user in format `users/{user}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1/users/{usersId}/loginProfile",
+ "id": "oslogin.users.getLoginProfile",
+ "path": "v1/{+name}/loginProfile",
+ "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine."
+ }
+ },
+ "resources": {
+ "sshPublicKeys": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "path": "v1/{+name}",
+ "id": "oslogin.users.sshPublicKeys.delete",
+ "description": "Deletes an SSH public key."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "SshPublicKey"
+ },
+ "parameters": {
+ "name": {
+ "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "id": "oslogin.users.sshPublicKeys.get",
+ "path": "v1/{+name}",
+ "description": "Retrieves an SSH public key."
+ },
+ "patch": {
+ "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.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "SshPublicKey"
+ },
+ "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": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}"
+ }
+ }
+ },
+ "projects": {
+ "methods": {
+ "delete": {
+ "id": "oslogin.users.projects.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a POSIX account.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^users/[^/]+/projects/[^/]+$",
+ "location": "path",
+ "description": "A reference to the POSIX account to update. POSIX accounts are identified\nby the project ID they are associated with. A reference to the POSIX\naccount is in format `users/{user}/projects/{project}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1/users/{usersId}/projects/{projectsId}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "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"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://oslogin.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Manages OS login configuration for Google account users.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "oslogin:v1",
+ "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
+ "revision": "20180119"
}
diff --git a/oslogin/v1alpha/oslogin-api.json b/oslogin/v1alpha/oslogin-api.json
index 73cad62..67602ab 100644
--- a/oslogin/v1alpha/oslogin-api.json
+++ b/oslogin/v1alpha/oslogin-api.json
@@ -1,20 +1,17 @@
{
- "id": "oslogin:v1alpha",
- "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
- "revision": "20180119",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"ImportSshPublicKeyResponse": {
- "description": "A response message for importing an SSH public key.",
- "type": "object",
"properties": {
"loginProfile": {
- "description": "The login profile information for the user.",
- "$ref": "LoginProfile"
+ "$ref": "LoginProfile",
+ "description": "The login profile information for the user."
}
},
- "id": "ImportSshPublicKeyResponse"
+ "id": "ImportSshPublicKeyResponse",
+ "description": "A response message for importing an SSH public key.",
+ "type": "object"
},
"PosixAccount": {
"description": "The POSIX account information associated with a Google account.",
@@ -50,20 +47,18 @@
"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"
+ },
+ "gecos": {
+ "description": "The GECOS (user information) entry for this 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": {
"sshPublicKeys": {
"additionalProperties": {
@@ -84,7 +79,9 @@
}
}
},
- "id": "LoginProfile"
+ "id": "LoginProfile",
+ "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.",
+ "type": "object"
},
"Empty": {
"properties": {},
@@ -122,6 +119,9 @@
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
"https://www.googleapis.com/auth/compute.readonly": {
"description": "View your Google Compute Engine resources"
},
@@ -130,9 +130,6 @@
},
"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"
}
}
}
@@ -150,6 +147,8 @@
"sshPublicKeys": {
"methods": {
"delete": {
+ "path": "v1alpha/{+name}",
+ "id": "oslogin.users.sshPublicKeys.delete",
"description": "Deletes an SSH public key.",
"response": {
"$ref": "Empty"
@@ -158,10 +157,6 @@
"name"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
"parameters": {
"name": {
"pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
@@ -171,14 +166,13 @@
"type": "string"
}
},
- "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "path": "v1alpha/{+name}",
- "id": "oslogin.users.sshPublicKeys.delete"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}"
},
"get": {
- "path": "v1alpha/{+name}",
- "id": "oslogin.users.sshPublicKeys.get",
- "description": "Retrieves an SSH public key.",
"response": {
"$ref": "SshPublicKey"
},
@@ -192,22 +186,19 @@
],
"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"
+ "type": "string",
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}"
+ "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "path": "v1alpha/{+name}",
+ "id": "oslogin.users.sshPublicKeys.get",
+ "description": "Retrieves an SSH public key."
},
"patch": {
- "path": "v1alpha/{+name}",
- "id": "oslogin.users.sshPublicKeys.patch",
- "request": {
- "$ref": "SshPublicKey"
- },
- "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.",
"response": {
"$ref": "SshPublicKey"
},
@@ -216,17 +207,17 @@
],
"httpMethod": "PATCH",
"parameters": {
- "name": {
- "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path"
- },
"updateMask": {
- "location": "query",
"description": "Mask to control which fields get updated. Updates all if not present.",
"format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
+ "location": "path",
+ "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
+ "required": true,
"type": "string"
}
},
@@ -234,15 +225,19 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
],
- "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}"
+ "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "path": "v1alpha/{+name}",
+ "id": "oslogin.users.sshPublicKeys.patch",
+ "request": {
+ "$ref": "SshPublicKey"
+ },
+ "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics."
}
}
},
"projects": {
"methods": {
"delete": {
- "path": "v1alpha/{+name}",
- "id": "oslogin.users.projects.delete",
"description": "Deletes a POSIX account.",
"response": {
"$ref": "Empty"
@@ -251,20 +246,22 @@
"name"
],
"httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "A reference to the POSIX account to update. POSIX accounts are identified\nby the project ID they are associated with. A reference to the POSIX\naccount is in format `users/{user}/projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+/projects/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
],
- "flatPath": "v1alpha/users/{usersId}/projects/{projectsId}"
+ "parameters": {
+ "name": {
+ "pattern": "^users/[^/]+/projects/[^/]+$",
+ "location": "path",
+ "description": "A reference to the POSIX account to update. POSIX accounts are identified\nby the project ID they are associated with. A reference to the POSIX\naccount is in format `users/{user}/projects/{project}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1alpha/users/{usersId}/projects/{projectsId}",
+ "path": "v1alpha/{+name}",
+ "id": "oslogin.users.projects.delete"
}
}
}
@@ -289,11 +286,11 @@
"type": "string"
},
"parent": {
+ "pattern": "^users/[^/]+$",
+ "location": "path",
"description": "The unique ID for the user in format `users/{user}`.",
"required": true,
- "type": "string",
- "pattern": "^users/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"flatPath": "v1alpha/users/{usersId}:importSshPublicKey",
@@ -336,75 +333,10 @@
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "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": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
"location": "query",
@@ -412,21 +344,89 @@
"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",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
- "bearer_token": {
+ "prettyPrint": {
"location": "query",
- "description": "OAuth bearer token.",
+ "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": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string"
+ },
+ "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": "v1alpha",
"baseUrl": "https://oslogin.googleapis.com/",
"servicePath": "",
- "kind": "discovery#restDescription",
"description": "Manages OS login configuration for Google account users.",
- "basePath": ""
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "oslogin:v1alpha",
+ "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
+ "revision": "20180119"
}
diff --git a/oslogin/v1beta/oslogin-api.json b/oslogin/v1beta/oslogin-api.json
index 8dff1f9..3196a0c 100644
--- a/oslogin/v1beta/oslogin-api.json
+++ b/oslogin/v1beta/oslogin-api.json
@@ -1,49 +1,308 @@
{
- "id": "oslogin:v1beta",
- "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud OS Login API",
+ "ownerName": "Google",
+ "resources": {
+ "users": {
+ "methods": {
+ "importSshPublicKey": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ImportSshPublicKeyResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The project ID of the Google Cloud Platform project.",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The unique ID for the user in format `users/{user}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1beta/users/{usersId}:importSshPublicKey",
+ "id": "oslogin.users.importSshPublicKey",
+ "path": "v1beta/{+parent}:importSshPublicKey",
+ "request": {
+ "$ref": "SshPublicKey"
+ },
+ "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile."
+ },
+ "getLoginProfile": {
+ "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "LoginProfile"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The unique ID for the user in format `users/{user}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "v1beta/users/{usersId}/loginProfile",
+ "id": "oslogin.users.getLoginProfile",
+ "path": "v1beta/{+name}/loginProfile"
+ }
+ },
+ "resources": {
+ "sshPublicKeys": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an SSH public key.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "path": "v1beta/{+name}",
+ "id": "oslogin.users.sshPublicKeys.delete"
+ },
+ "get": {
+ "response": {
+ "$ref": "SshPublicKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "path": "v1beta/{+name}",
+ "id": "oslogin.users.sshPublicKeys.get",
+ "description": "Retrieves an SSH public key."
+ },
+ "patch": {
+ "request": {
+ "$ref": "SshPublicKey"
+ },
+ "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "SshPublicKey"
+ },
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Mask to control which fields get updated. Updates all if not present.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "name": {
+ "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "id": "oslogin.users.sshPublicKeys.patch",
+ "path": "v1beta/{+name}"
+ }
+ }
+ },
+ "projects": {
+ "methods": {
+ "delete": {
+ "flatPath": "v1beta/users/{usersId}/projects/{projectsId}",
+ "path": "v1beta/{+name}",
+ "id": "oslogin.users.projects.delete",
+ "description": "Deletes a POSIX account.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "A reference to the POSIX account to update. POSIX accounts are identified\nby the project ID they are associated with. A reference to the POSIX\naccount is in format `users/{user}/projects/{project}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+/projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "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": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ }
+ },
+ "version": "v1beta",
+ "baseUrl": "https://oslogin.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Manages OS login configuration for Google account users.",
+ "servicePath": "",
+ "basePath": "",
"revision": "20180119",
+ "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
+ "id": "oslogin:v1beta",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "LoginProfile": {
- "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.",
- "type": "object",
- "properties": {
- "sshPublicKeys": {
- "additionalProperties": {
- "$ref": "SshPublicKey"
- },
- "description": "A map from SSH public key fingerprint to the associated key object.",
- "type": "object"
- },
- "name": {
- "description": "A unique user ID.",
- "type": "string"
- },
- "posixAccounts": {
- "description": "The list of POSIX accounts associated with the user.",
- "type": "array",
- "items": {
- "$ref": "PosixAccount"
- }
- }
- },
- "id": "LoginProfile"
- },
"Empty": {
- "properties": {},
- "id": "Empty",
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
},
"SshPublicKey": {
"description": "The SSH public key information associated with a Google account.",
"type": "object",
"properties": {
- "key": {
- "description": "Public key text in SSH format, defined by\n\u003ca href=\"https://www.ietf.org/rfc/rfc4253.txt\" target=\"_blank\"\u003eRFC4253\u003c/a\u003e\nsection 6.6.",
- "type": "string"
- },
"expirationTimeUsec": {
"description": "An expiration time in microseconds since epoch.",
"format": "int64",
@@ -52,6 +311,10 @@
"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"
@@ -61,14 +324,32 @@
"type": "object",
"properties": {
"loginProfile": {
- "description": "The login profile information for the user.",
- "$ref": "LoginProfile"
+ "$ref": "LoginProfile",
+ "description": "The login profile information for the user."
}
},
"id": "ImportSshPublicKeyResponse"
},
"PosixAccount": {
+ "description": "The POSIX account information associated with a Google account.",
+ "type": "object",
"properties": {
+ "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"
@@ -90,34 +371,41 @@
"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"
- },
- "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",
- "description": "The POSIX account information associated with a Google account.",
- "type": "object"
+ "id": "PosixAccount"
+ },
+ "LoginProfile": {
+ "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A unique user ID.",
+ "type": "string"
+ },
+ "posixAccounts": {
+ "description": "The list of POSIX accounts associated with the user.",
+ "type": "array",
+ "items": {
+ "$ref": "PosixAccount"
+ }
+ },
+ "sshPublicKeys": {
+ "additionalProperties": {
+ "$ref": "SshPublicKey"
+ },
+ "description": "A map from SSH public key fingerprint to the associated key object.",
+ "type": "object"
+ }
+ },
+ "id": "LoginProfile"
}
},
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
"canonicalName": "Cloud OS Login",
"auth": {
"oauth2": {
@@ -140,293 +428,5 @@
"rootUrl": "https://oslogin.googleapis.com/",
"ownerDomain": "google.com",
"name": "oslogin",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud OS Login API",
- "ownerName": "Google",
- "resources": {
- "users": {
- "resources": {
- "sshPublicKeys": {
- "methods": {
- "delete": {
- "description": "Deletes an SSH public key.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "name": {
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path",
- "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "path": "v1beta/{+name}",
- "id": "oslogin.users.sshPublicKeys.delete"
- },
- "get": {
- "response": {
- "$ref": "SshPublicKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "name": {
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path",
- "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "path": "v1beta/{+name}",
- "id": "oslogin.users.sshPublicKeys.get",
- "description": "Retrieves an SSH public key."
- },
- "patch": {
- "path": "v1beta/{+name}",
- "id": "oslogin.users.sshPublicKeys.patch",
- "request": {
- "$ref": "SshPublicKey"
- },
- "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.",
- "response": {
- "$ref": "SshPublicKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path"
- },
- "updateMask": {
- "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": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}"
- }
- }
- },
- "projects": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "name": {
- "description": "A reference to the POSIX account to update. POSIX accounts are identified\nby the project ID they are associated with. A reference to the POSIX\naccount is in format `users/{user}/projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+/projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta/users/{usersId}/projects/{projectsId}",
- "path": "v1beta/{+name}",
- "id": "oslogin.users.projects.delete",
- "description": "Deletes a POSIX account."
- }
- }
- }
- },
- "methods": {
- "importSshPublicKey": {
- "path": "v1beta/{+parent}:importSshPublicKey",
- "id": "oslogin.users.importSshPublicKey",
- "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile.",
- "request": {
- "$ref": "SshPublicKey"
- },
- "response": {
- "$ref": "ImportSshPublicKeyResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "The project ID of the Google Cloud Platform project.",
- "type": "string"
- },
- "parent": {
- "description": "The unique ID for the user in format `users/{user}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta/users/{usersId}:importSshPublicKey"
- },
- "getLoginProfile": {
- "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.",
- "httpMethod": "GET",
- "response": {
- "$ref": "LoginProfile"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The unique ID for the user in format `users/{user}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "v1beta/users/{usersId}/loginProfile",
- "id": "oslogin.users.getLoginProfile",
- "path": "v1beta/{+name}/loginProfile"
- }
- }
- }
- },
- "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": {
- "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": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- }
- },
- "version": "v1beta",
- "baseUrl": "https://oslogin.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Manages OS login configuration for Google account users.",
- "basePath": ""
+ "batchPath": "batch"
}
diff --git a/partners/v2/partners-api.json b/partners/v2/partners-api.json
index f4ec868..55070d2 100644
--- a/partners/v2/partners-api.json
+++ b/partners/v2/partners-api.json
@@ -1,35 +1,42 @@
{
- "discoveryVersion": "v1",
+ "version": "v2",
+ "baseUrl": "https://partners.googleapis.com/",
+ "canonicalName": "Partners",
+ "kind": "discovery#restDescription",
+ "description": "Searches certified companies and creates contact leads with them, and also audits the usage of clients.",
+ "servicePath": "",
+ "rootUrl": "https://partners.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "partners",
+ "batchPath": "batch",
+ "revision": "20180122",
+ "documentationLink": "https://developers.google.com/partners/",
+ "id": "partners:v2",
+ "title": "Google Partners API",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": true,
"resources": {
"offers": {
"methods": {
"list": {
+ "path": "v2/offers",
+ "id": "partners.offers.list",
+ "description": "Lists the Offers available for the current user",
"response": {
"$ref": "ListOffersResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "requestMetadata.experimentIds": {
- "repeated": true,
+ "requestMetadata.userOverrides.userId": {
"location": "query",
- "description": "Experiment IDs the current request belongs to.",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"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"
},
@@ -39,27 +46,34 @@
"type": "string"
},
"requestMetadata.locale": {
+ "location": "query",
"description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"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"
+ },
+ "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/offers",
- "path": "v2/offers",
- "id": "partners.offers.list",
- "description": "Lists the Offers available for the current user"
+ "flatPath": "v2/offers"
}
},
"resources": {
"history": {
"methods": {
"list": {
- "description": "Lists the Historical Offers for the current user (or user's entire company)",
"response": {
"$ref": "ListOffersHistoryResponse"
},
@@ -72,9 +86,9 @@
"type": "string"
},
"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"
},
"entireCompany": {
"location": "query",
@@ -82,10 +96,10 @@
"type": "boolean"
},
"requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
"description": "Experiment IDs the current request belongs to.",
- "type": "string"
+ "type": "string",
+ "repeated": true,
+ "location": "query"
},
"orderBy": {
"location": "query",
@@ -98,14 +112,14 @@
"type": "string"
},
"requestMetadata.partnersSessionId": {
+ "location": "query",
"description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.userOverrides.userId": {
+ "location": "query",
"description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageToken": {
"description": "Token to retrieve a specific page.",
@@ -126,7 +140,8 @@
},
"flatPath": "v2/offers/history",
"path": "v2/offers/history",
- "id": "partners.offers.history.list"
+ "id": "partners.offers.history.list",
+ "description": "Lists the Historical Offers for the current user (or user's entire company)"
}
}
}
@@ -150,9 +165,9 @@
"type": "string"
},
"requestMetadata.partnersSessionId": {
- "location": "query",
"description": "Google Partners session ID.",
- "type": "string"
+ "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.",
@@ -160,9 +175,9 @@
"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.",
@@ -170,10 +185,10 @@
"location": "query"
},
"requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
"description": "Experiment IDs the current request belongs to.",
- "type": "string"
+ "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.",
@@ -188,48 +203,13 @@
"analytics": {
"methods": {
"list": {
+ "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
"response": {
"$ref": "ListAnalyticsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "requestMetadata.userOverrides.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"
- },
- "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": {
- "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": {
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "requestMetadata.locale": {
- "location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
- },
"requestMetadata.experimentIds": {
"description": "Experiment IDs the current request belongs to.",
"type": "string",
@@ -240,82 +220,53 @@
"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": {
+ "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": {
+ "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": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
}
},
"flatPath": "v2/analytics",
"path": "v2/analytics",
- "id": "partners.analytics.list",
- "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user."
+ "id": "partners.analytics.list"
}
}
},
"v2": {
"methods": {
- "updateLeads": {
- "path": "v2/leads",
- "id": "partners.updateLeads",
- "description": "Updates the specified lead.",
- "request": {
- "$ref": "Lead"
- },
- "response": {
- "$ref": "Lead"
- },
- "parameterOrder": [],
- "httpMethod": "PATCH",
- "parameters": {
- "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"
- },
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string"
- },
- "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": {
- "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/leads"
- },
"updateCompanies": {
- "path": "v2/companies",
- "id": "partners.updateCompanies",
- "description": "Update company.\nShould only be called within the context of an authorized logged in user.",
- "request": {
- "$ref": "Company"
- },
"response": {
"$ref": "Company"
},
@@ -323,9 +274,9 @@
"httpMethod": "PATCH",
"parameters": {
"requestMetadata.locale": {
+ "location": "query",
"description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.userOverrides.ipAddress": {
"location": "query",
@@ -345,8 +296,13 @@
"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"
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
"type": "string"
},
"requestMetadata.userOverrides.userId": {
@@ -354,21 +310,21 @@
"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"
}
},
- "flatPath": "v2/companies"
+ "flatPath": "v2/companies",
+ "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."
},
"getPartnersstatus": {
- "description": "Gets Partners Status of the logged in user's agency.\nShould only be called if the logged in user is the admin of the agency.",
"response": {
"$ref": "GetPartnersStatusResponse"
},
@@ -386,9 +342,9 @@
"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"
+ "type": "string",
+ "location": "query"
},
"requestMetadata.locale": {
"description": "Locale to use for the current request.",
@@ -414,40 +370,20 @@
},
"flatPath": "v2/partnersstatus",
"path": "v2/partnersstatus",
- "id": "partners.getPartnersstatus"
- }
- }
- },
- "users": {
- "methods": {
- "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"
- },
+ "id": "partners.getPartnersstatus",
+ "description": "Gets Partners Status of the logged in user's agency.\nShould only be called if the logged in user is the admin of the agency."
+ },
+ "updateLeads": {
"response": {
- "$ref": "UserProfile"
+ "$ref": "Lead"
},
"parameterOrder": [],
"httpMethod": "PATCH",
"parameters": {
- "requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
"requestMetadata.userOverrides.userId": {
+ "location": "query",
"description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.partnersSessionId": {
"description": "Google Partners session ID.",
@@ -455,225 +391,63 @@
"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",
- "location": "query"
+ "type": "string"
},
"requestMetadata.locale": {
+ "location": "query",
"description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.userOverrides.ipAddress": {
"description": "IP address to use instead of the user's geo-located IP address.",
"type": "string",
"location": "query"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.experimentIds": {
+ "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/users/profile"
- },
- "createCompanyRelation": {
+ "flatPath": "v2/leads",
+ "path": "v2/leads",
+ "id": "partners.updateLeads",
"request": {
- "$ref": "CompanyRelation"
+ "$ref": "Lead"
},
- "description": "Creates a user's company relation. Affiliates the user to a company.",
- "response": {
- "$ref": "CompanyRelation"
- },
- "parameterOrder": [
- "userId"
- ],
- "httpMethod": "PUT",
- "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"
- },
- "userId": {
- "location": "path",
- "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
- "required": true,
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "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"
- }
- },
- "flatPath": "v2/users/{userId}/companyRelation",
- "path": "v2/users/{userId}/companyRelation",
- "id": "partners.users.createCompanyRelation"
- },
- "deleteCompanyRelation": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "userId"
- ],
- "parameters": {
- "requestMetadata.partnersSessionId": {
- "location": "query",
- "description": "Google Partners session ID.",
- "type": "string"
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.locale": {
- "location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
- },
- "requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
- },
- "userId": {
- "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v2/users/{userId}/companyRelation",
- "id": "partners.users.deleteCompanyRelation",
- "path": "v2/users/{userId}/companyRelation",
- "description": "Deletes a user's company relation. Unaffiliaites the user from a company."
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "User"
- },
- "parameterOrder": [
- "userId"
- ],
- "parameters": {
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
- },
- "userView": {
- "location": "query",
- "enum": [
- "BASIC",
- "PROFILE",
- "PUBLIC_PROFILE"
- ],
- "description": "Specifies what parts of the user information to return.",
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "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"
- },
- "userId": {
- "location": "path",
- "description": "Identifier of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean the currently\nauthenticated user.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2/users/{userId}",
- "id": "partners.users.get",
- "path": "v2/users/{userId}",
- "description": "Gets a user."
+ "description": "Updates the specified lead."
}
}
},
"companies": {
"methods": {
"get": {
- "description": "Gets a company.",
- "httpMethod": "GET",
- "parameterOrder": [
- "companyId"
- ],
"response": {
"$ref": "GetCompanyResponse"
},
+ "parameterOrder": [
+ "companyId"
+ ],
+ "httpMethod": "GET",
"parameters": {
"requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
"description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"requestMetadata.userOverrides.ipAddress": {
"description": "IP address to use instead of the user's geo-located IP address.",
@@ -686,98 +460,146 @@
"required": true,
"type": "string"
},
+ "currencyCode": {
+ "location": "query",
+ "description": "If the company's budget is in a different currency code than this one, then\nthe converted budget is converted to this currency code.",
+ "type": "string"
+ },
"requestMetadata.experimentIds": {
"repeated": true,
"location": "query",
"description": "Experiment IDs the current request belongs to.",
"type": "string"
},
- "currencyCode": {
- "location": "query",
- "description": "If the company's budget is in a different currency code than this one, then\nthe converted budget is converted to this currency code.",
- "type": "string"
- },
"requestMetadata.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": "How to order addresses within the returned company. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
"type": "string"
},
- "requestMetadata.userOverrides.userId": {
+ "requestMetadata.partnersSessionId": {
"location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "description": "Google Partners session ID.",
"type": "string"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"type": "string",
"location": "query"
},
"view": {
+ "location": "query",
"enum": [
"COMPANY_VIEW_UNSPECIFIED",
"CV_GOOGLE_PARTNER_SEARCH"
],
"description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "address": {
+ "description": "The address to use for sorting the company's addresses by proximity.\nIf not given, the geo-located address of the request is used.\nUsed when order_by is set.",
"type": "string",
"location": "query"
- },
+ }
+ },
+ "flatPath": "v2/companies/{companyId}",
+ "path": "v2/companies/{companyId}",
+ "id": "partners.companies.get",
+ "description": "Gets a company."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListCompaniesResponse"
+ },
+ "parameterOrder": [],
+ "parameters": {
"requestMetadata.locale": {
"description": "Locale to use for the current request.",
"type": "string",
"location": "query"
},
"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"
- }
- },
- "flatPath": "v2/companies/{companyId}",
- "id": "partners.companies.get",
- "path": "v2/companies/{companyId}"
- },
- "list": {
- "id": "partners.companies.list",
- "path": "v2/companies",
- "description": "Lists companies.",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListCompaniesResponse"
- },
- "parameters": {
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "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"
},
- "minMonthlyBudget.nanos": {
+ "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"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
+ "services": {
+ "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"
+ ],
+ "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"
+ },
+ "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"
},
- "companyName": {
- "description": "Company name to search for.",
- "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.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "companyName": {
+ "location": "query",
+ "description": "Company name to search for.",
+ "type": "string"
+ },
"pageToken": {
"location": "query",
"description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListCompaniesResponse.next_page_token`\nreturned from the previous call to\nListCompanies.",
"type": "string"
},
"industries": {
+ "repeated": true,
+ "location": "query",
"enum": [
"INDUSTRY_UNSPECIFIED",
"I_AUTOMOTIVE",
@@ -792,9 +614,7 @@
"I_TRAVEL"
],
"description": "List of industries the company can help with.",
- "type": "string",
- "repeated": true,
- "location": "query"
+ "type": "string"
},
"websiteUrl": {
"location": "query",
@@ -814,16 +634,16 @@
"location": "query"
},
"languageCodes": {
- "repeated": true,
- "location": "query",
"description": "List of language codes that company can support. Only primary language\nsubtags are accepted as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
- "type": "string"
+ "type": "string",
+ "repeated": true,
+ "location": "query"
},
"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"
+ "type": "integer",
+ "location": "query"
},
"requestMetadata.userOverrides.ipAddress": {
"description": "IP address to use instead of the user's geo-located IP address.",
@@ -831,17 +651,19 @@
"location": "query"
},
"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",
+ "repeated": true,
"location": "query"
},
+ "orderBy": {
+ "location": "query",
+ "description": "How to order addresses within the returned companies. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
+ "type": "string"
+ },
"specializations": {
+ "repeated": true,
+ "location": "query",
"enum": [
"BADGE_SPECIALIZATION_UNKNOWN",
"BADGE_SPECIALIZATION_ADWORDS_SEARCH",
@@ -851,103 +673,54 @@
"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"
+ "type": "string"
},
"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"
+ "type": "string",
+ "location": "query"
},
"minMonthlyBudget.currencyCode": {
"description": "The 3-letter currency code defined in ISO 4217.",
"type": "string",
"location": "query"
},
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
"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",
- "location": "query"
- },
- "requestMetadata.locale": {
- "location": "query",
- "description": "Locale to use for the current request.",
"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"
- },
- "minMonthlyBudget.units": {
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "format": "int64",
- "type": "string",
- "location": "query"
- },
- "maxMonthlyBudget.nanos": {
- "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "services": {
- "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"
- ],
- "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"
- },
- "maxMonthlyBudget.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"
- },
- "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"
+ "flatPath": "v2/companies",
+ "id": "partners.companies.list",
+ "path": "v2/companies",
+ "description": "Lists companies."
}
},
"resources": {
"leads": {
"methods": {
"create": {
- "id": "partners.companies.leads.create",
- "path": "v2/companies/{companyId}/leads",
+ "description": "Creates an advertiser lead for the given company ID.",
"request": {
"$ref": "CreateLeadRequest"
},
- "description": "Creates an advertiser lead for the given company ID.",
- "httpMethod": "POST",
- "parameterOrder": [
- "companyId"
- ],
"response": {
"$ref": "CreateLeadResponse"
},
+ "parameterOrder": [
+ "companyId"
+ ],
+ "httpMethod": "POST",
"parameters": {
"companyId": {
"description": "The ID of the company to contact.",
@@ -956,98 +729,86 @@
"location": "path"
}
},
- "flatPath": "v2/companies/{companyId}/leads"
+ "flatPath": "v2/companies/{companyId}/leads",
+ "path": "v2/companies/{companyId}/leads",
+ "id": "partners.companies.leads.create"
}
}
}
}
},
- "userEvents": {
+ "users": {
"methods": {
- "log": {
- "id": "partners.userEvents.log",
- "path": "v2/userEvents:log",
- "request": {
- "$ref": "LogUserEventRequest"
- },
- "description": "Logs a user event.",
- "httpMethod": "POST",
+ "updateProfile": {
+ "httpMethod": "PATCH",
"parameterOrder": [],
"response": {
- "$ref": "LogUserEventResponse"
- },
- "parameters": {},
- "flatPath": "v2/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"
- }
- }
- },
- "leads": {
- "methods": {
- "list": {
- "id": "partners.leads.list",
- "path": "v2/leads",
- "description": "Lists advertiser leads for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListLeadsResponse"
+ "$ref": "UserProfile"
},
"parameters": {
- "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"
- },
- "orderBy": {
- "location": "query",
- "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
- "type": "string"
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
},
"requestMetadata.partnersSessionId": {
"location": "query",
"description": "Google Partners session ID.",
"type": "string"
},
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.experimentIds": {
+ "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/users/profile",
+ "id": "partners.users.updateProfile",
+ "path": "v2/users/profile",
+ "request": {
+ "$ref": "UserProfile"
+ },
+ "description": "Updates a user's profile. A user can only update their own profile and\nshould only be called within the context of a logged in user."
+ },
+ "createCompanyRelation": {
+ "response": {
+ "$ref": "CompanyRelation"
+ },
+ "parameterOrder": [
+ "userId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
"requestMetadata.userOverrides.userId": {
- "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 `ListLeadsResponse.next_page_token`\nreturned from the previous call to\nListLeads.",
- "type": "string",
- "location": "query"
- },
- "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"
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
},
"requestMetadata.trafficSource.trafficSourceId": {
"description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
@@ -1063,9 +824,263 @@
"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"
+ },
+ "userId": {
+ "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
}
},
- "flatPath": "v2/leads"
+ "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.",
+ "request": {
+ "$ref": "CompanyRelation"
+ }
+ },
+ "deleteCompanyRelation": {
+ "path": "v2/users/{userId}/companyRelation",
+ "id": "partners.users.deleteCompanyRelation",
+ "description": "Deletes a user's company relation. Unaffiliaites the user from a company.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "userId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
+ "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"
+ },
+ "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"
+ },
+ "userId": {
+ "location": "path",
+ "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
+ "required": true,
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "location": "query",
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/users/{userId}/companyRelation"
+ },
+ "get": {
+ "id": "partners.users.get",
+ "path": "v2/users/{userId}",
+ "description": "Gets a user.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "User"
+ },
+ "parameterOrder": [
+ "userId"
+ ],
+ "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"
+ },
+ "userView": {
+ "enum": [
+ "BASIC",
+ "PROFILE",
+ "PUBLIC_PROFILE"
+ ],
+ "description": "Specifies what parts of the user information to return.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "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": {
+ "location": "path",
+ "description": "Identifier of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean the currently\nauthenticated user.",
+ "required": true,
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/users/{userId}"
+ }
+ }
+ },
+ "userEvents": {
+ "methods": {
+ "log": {
+ "response": {
+ "$ref": "LogUserEventResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v2/userEvents:log",
+ "path": "v2/userEvents:log",
+ "id": "partners.userEvents.log",
+ "description": "Logs a user event.",
+ "request": {
+ "$ref": "LogUserEventRequest"
+ }
+ }
+ }
+ },
+ "clientMessages": {
+ "methods": {
+ "log": {
+ "response": {
+ "$ref": "LogMessageResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v2/clientMessages:log",
+ "path": "v2/clientMessages:log",
+ "id": "partners.clientMessages.log",
+ "request": {
+ "$ref": "LogMessageRequest"
+ },
+ "description": "Logs a generic message from the client, such as\n`Failed to render component`, `Profile page is running slow`,\n`More than 500 users have accessed this result.`, etc."
+ }
+ }
+ },
+ "leads": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLeadsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "pageToken": {
+ "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",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Requested page size. Server may return fewer leads than requested.\nIf unspecified, server picks an appropriate default.",
+ "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/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."
}
}
}
@@ -1082,37 +1097,35 @@
"default": "true",
"location": "query"
},
- "uploadType": {
- "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"
},
- "fields": {
+ "uploadType": {
"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"
+ },
+ "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",
@@ -1124,22 +1137,24 @@
"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": {
- "description": "API key. 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"
},
- "access_token": {
+ "key": {
"location": "query",
- "description": "OAuth access token.",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
"quotaUser": {
- "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",
@@ -1148,9 +1163,9 @@
"default": "true"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"bearer_token": {
"location": "query",
@@ -1159,10 +1174,545 @@
}
},
"schemas": {
- "Certification": {
- "description": "A user's information on a specific certification.",
+ "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"
+ }
+ },
+ "id": "RequestMetadata"
+ },
+ "CreateLeadRequest": {
+ "properties": {
+ "requestMetadata": {
+ "description": "Current request metadata.",
+ "$ref": "RequestMetadata"
+ },
+ "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",
+ "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": {
+ "passed": {
+ "description": "Whether this exam has been passed and not expired.",
+ "type": "boolean"
+ },
+ "taken": {
+ "description": "The date the user last taken this exam.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Whether this exam is in the state of warning.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "description": "Date this exam is due to expire.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "lastPassed": {
+ "description": "The date the user last passed this exam.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "examType": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Adwords Fundamentals exam.",
+ "AdWords advanced search exam.",
+ "AdWords advanced display exam.",
+ "VideoAds exam.",
+ "DoubleClick exam.",
+ "Analytics exam.",
+ "Shopping exam.",
+ "Mobile exam.",
+ "Digital Sales exam.",
+ "Mobile Sites exam."
+ ],
+ "enum": [
+ "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
+ "CET_ADWORDS_FUNDAMENTALS",
+ "CET_ADWORDS_ADVANCED_SEARCH",
+ "CET_ADWORDS_ADVANCED_DISPLAY",
+ "CET_VIDEO_ADS",
+ "CET_DOUBLECLICK",
+ "CET_ANALYTICS",
+ "CET_SHOPPING",
+ "CET_MOBILE",
+ "CET_DIGITAL_SALES",
+ "CET_MOBILE_SITES"
+ ],
+ "description": "The type of the exam.",
+ "type": "string"
+ }
+ },
+ "id": "ExamStatus"
+ },
+ "ListOffersResponse": {
+ "properties": {
+ "availableOffers": {
+ "description": "Available Offers to be distributed.",
+ "type": "array",
+ "items": {
+ "$ref": "AvailableOffer"
+ }
+ },
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ },
+ "noOfferReason": {
+ "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",
+ "enumDescriptions": [
+ "Unset.",
+ "Not an MCC.",
+ "Offer limit has been reached.",
+ "Ineligible for offers."
+ ]
+ }
+ },
+ "id": "ListOffersResponse",
+ "description": "Response for ListOffer.",
+ "type": "object"
+ },
+ "CountryOfferInfo": {
+ "properties": {
+ "offerCountryCode": {
+ "description": "Country code for which offer codes may be requested.",
+ "type": "string"
+ },
+ "spendXAmount": {
+ "description": "(localized) Spend X amount for that country's offer.",
+ "type": "string"
+ },
+ "offerType": {
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ],
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ],
+ "description": "Type of offer country is eligible for.",
+ "type": "string"
+ },
+ "getYAmount": {
+ "description": "(localized) Get Y amount for that country's offer.",
+ "type": "string"
+ }
+ },
+ "id": "CountryOfferInfo",
+ "description": "Offer info by country.",
+ "type": "object"
+ },
+ "ListCompaniesResponse": {
+ "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": {
+ "eligibilityDaysLeft": {
+ "description": "Days the customer is still eligible.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "creationTime": {
+ "description": "Time the customer was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "Country code of the customer.",
+ "type": "string"
+ },
+ "externalCid": {
+ "description": "External CID for the customer.",
+ "format": "int64",
+ "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"
+ },
+ "getYAmount": {
+ "description": "Formatted Get Y amount with currency code.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the customer.",
+ "type": "string"
+ },
+ "spendXAmount": {
+ "description": "Formatted Spend X amount with currency code.",
+ "type": "string"
+ },
+ "adwordsUrl": {
+ "description": "URL to the customer's AdWords page.",
+ "type": "string"
+ }
+ },
+ "id": "OfferCustomer",
+ "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": {
+ "description": "The localized company information.",
+ "type": "object",
+ "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"
+ },
+ "LogUserEventResponse": {
+ "description": "Response message for\nLogUserEvent.",
+ "type": "object",
+ "properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ },
+ "id": "LogUserEventResponse"
+ },
+ "ListOffersHistoryResponse": {
+ "description": "Response for ListOfferHistory.",
+ "type": "object",
+ "properties": {
+ "offers": {
+ "description": "Historical offers meeting request.",
+ "type": "array",
+ "items": {
+ "$ref": "HistoricalOffer"
+ }
+ },
+ "nextPageToken": {
+ "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.",
+ "type": "string"
+ },
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ },
+ "canShowEntireCompany": {
+ "description": "True if the user has the option to show entire company history.",
+ "type": "boolean"
+ },
+ "totalResults": {
+ "description": "Number of results across all pages.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "showingEntireCompany": {
+ "description": "True if this response is showing entire company history.",
+ "type": "boolean"
+ }
+ },
+ "id": "ListOffersHistoryResponse"
+ },
+ "LogMessageResponse": {
+ "properties": {
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ }
+ },
+ "id": "LogMessageResponse",
+ "description": "Response message for\nLogClientMessage.",
+ "type": "object"
+ },
+ "SpecializationStatus": {
+ "description": "Agency specialization status",
+ "type": "object",
+ "properties": {
+ "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"
+ ]
+ },
+ "badgeSpecializationState": {
+ "enumDescriptions": [
+ "Unknown state",
+ "Specialization passed",
+ "Specialization not passed",
+ "Specialization in grace"
+ ],
+ "enum": [
+ "BADGE_SPECIALIZATION_STATE_UNKNOWN",
+ "BADGE_SPECIALIZATION_STATE_PASSED",
+ "BADGE_SPECIALIZATION_STATE_NOT_PASSED",
+ "BADGE_SPECIALIZATION_STATE_IN_GRACE"
+ ],
+ "description": "State of agency specialization.",
+ "type": "string"
+ }
+ },
+ "id": "SpecializationStatus"
+ },
+ "Certification": {
+ "properties": {
"achieved": {
"description": "Whether this certification has been achieved.",
"type": "boolean"
@@ -1177,20 +1727,6 @@
"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",
@@ -1206,7 +1742,21 @@
"CT_MOBILE_SITES"
],
"description": "The type of certification, the area of expertise.",
- "type": "string"
+ "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.",
@@ -1214,18 +1764,12 @@
"type": "string"
}
},
- "id": "Certification"
+ "id": "Certification",
+ "description": "A user's information on a specific certification.",
+ "type": "object"
},
"User": {
"properties": {
- "company": {
- "$ref": "CompanyRelation",
- "description": "The company that the user is associated with.\nIf not present, the user is not associated with any company."
- },
- "profile": {
- "description": "The profile information of a Partners user, contains all the directly\neditable user information.",
- "$ref": "UserProfile"
- },
"lastAccessTime": {
"description": "The most recent time the user interacted with the Partners site.\n@OutputOnly",
"format": "google-datetime",
@@ -1274,6 +1818,14 @@
"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."
}
},
"id": "User",
@@ -1281,16 +1833,7 @@
"type": "object"
},
"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"
@@ -1300,11 +1843,20 @@
"$ref": "ResponseMetadata"
},
"analyticsSummary": {
- "$ref": "AnalyticsSummary",
- "description": "Aggregated information across the response's\nanalytics."
+ "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"
+ "id": "ListAnalyticsResponse",
+ "description": "Response message for\nListAnalytics.",
+ "type": "object"
},
"ListLeadsResponse": {
"description": "Response message for ListLeads.",
@@ -1334,29 +1886,25 @@
"id": "ListLeadsResponse"
},
"Company": {
+ "description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers.",
+ "type": "object",
"properties": {
- "publicProfile": {
- "$ref": "PublicProfile",
- "description": "Basic information from the company's public profile."
+ "certificationStatuses": {
+ "description": "The list of Google Partners certification statuses for the company.",
+ "type": "array",
+ "items": {
+ "$ref": "CertificationStatus"
+ }
},
- "originalMinMonthlyBudget": {
- "$ref": "Money",
- "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness."
+ "id": {
+ "description": "The ID of the company.",
+ "type": "string"
},
"primaryLocation": {
"description": "The primary location of the company.",
"$ref": "Location"
},
"services": {
- "enumDescriptions": [
- "Unchosen.",
- "Help with advanced AdWords support.",
- "Help with advertising on Google.",
- "Help with an enhanced website.",
- "Help with an online marketing plan.",
- "Help with mobile and video ads.",
- "Help with mobile websites."
- ],
"description": "Services the company can help with.",
"type": "array",
"items": {
@@ -1370,7 +1918,24 @@
"S_MOBILE_WEBSITE_SERVICES"
],
"type": "string"
- }
+ },
+ "enumDescriptions": [
+ "Unchosen.",
+ "Help with advanced AdWords support.",
+ "Help with advertising on Google.",
+ "Help with an enhanced website.",
+ "Help with an online marketing plan.",
+ "Help with mobile and video ads.",
+ "Help with mobile websites."
+ ]
+ },
+ "originalMinMonthlyBudget": {
+ "$ref": "Money",
+ "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness."
+ },
+ "publicProfile": {
+ "description": "Basic information from the company's public profile.",
+ "$ref": "PublicProfile"
},
"ranks": {
"description": "Information related to the ranking of the company within the list of\ncompanies.",
@@ -1379,6 +1944,13 @@
"$ref": "Rank"
}
},
+ "specializationStatus": {
+ "description": "The list of Google Partners specialization statuses for the company.",
+ "type": "array",
+ "items": {
+ "$ref": "SpecializationStatus"
+ }
+ },
"badgeTier": {
"enum": [
"BADGE_TIER_NONE",
@@ -1393,27 +1965,7 @@
"Agency has premier badge."
]
},
- "specializationStatus": {
- "description": "The list of Google Partners specialization statuses for the company.",
- "type": "array",
- "items": {
- "$ref": "SpecializationStatus"
- }
- },
"companyTypes": {
- "enumDescriptions": [
- "Unchosen.",
- "Handles all aspects of the advertising process.",
- "Focuses solely on an advertiser's media placement.",
- "Plans/executes advertising campaigns.",
- "Like a\nFULL_SERVICE_AGENCY,\nbut specializing in digital.",
- "Increases visibility in search engine result pages.",
- "Drives promotional efforts for immediate impact.",
- "Focuses on bid management, conversion, reporting.",
- "Establishes favorable relationship with public through low/no-cost\ncommunications.",
- "Does not manage other company's accounts, manages own marketing programs.",
- "Full-service AdWords account management for local businesses."
- ],
"description": "Company type labels listed on the company's profile.",
"type": "array",
"items": {
@@ -1431,7 +1983,20 @@
"RESELLER"
],
"type": "string"
- }
+ },
+ "enumDescriptions": [
+ "Unchosen.",
+ "Handles all aspects of the advertising process.",
+ "Focuses solely on an advertiser's media placement.",
+ "Plans/executes advertising campaigns.",
+ "Like a\nFULL_SERVICE_AGENCY,\nbut specializing in digital.",
+ "Increases visibility in search engine result pages.",
+ "Drives promotional efforts for immediate impact.",
+ "Focuses on bid management, conversion, reporting.",
+ "Establishes favorable relationship with public through low/no-cost\ncommunications.",
+ "Does not manage other company's accounts, manages own marketing programs.",
+ "Full-service AdWords account management for local businesses."
+ ]
},
"autoApprovalEmailDomains": {
"description": "Email domains that allow users with a matching email address to get\nauto-approved for associating with this company.",
@@ -1530,32 +2095,23 @@
"items": {
"$ref": "LocalizedCompanyInfo"
}
- },
- "id": {
- "description": "The ID of the company.",
- "type": "string"
- },
- "certificationStatuses": {
- "description": "The list of Google Partners certification statuses for the company.",
- "type": "array",
- "items": {
- "$ref": "CertificationStatus"
- }
}
},
- "id": "Company",
- "description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers.",
- "type": "object"
+ "id": "Company"
},
"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."
},
"recaptchaStatus": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "No reCaptcha validation needed.",
+ "reCaptcha challenge passed.",
+ "reCaptcha challenge failed."
+ ],
"enum": [
"RECAPTCHA_STATUS_UNSPECIFIED",
"RS_NOT_NEEDED",
@@ -1563,20 +2119,16 @@
"RS_FAILED"
],
"description": "The outcome of \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nvalidation.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "No reCaptcha validation needed.",
- "reCaptcha challenge passed.",
- "reCaptcha challenge failed."
- ]
+ "type": "string"
},
"responseMetadata": {
"description": "Current response metadata.",
"$ref": "ResponseMetadata"
}
},
- "id": "CreateLeadResponse"
+ "id": "CreateLeadResponse",
+ "description": "Response message for CreateLead.",
+ "type": "object"
},
"GetCompanyResponse": {
"description": "Response message for GetCompany.",
@@ -1595,6 +2147,18 @@
},
"Location": {
"properties": {
+ "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": {
+ "$ref": "LatLng",
+ "description": "The latitude and longitude of the location, in degrees."
+ },
"regionCode": {
"description": "CLDR (Common Locale Data Repository) region code .",
"type": "string"
@@ -1625,18 +2189,6 @@
"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": {
- "$ref": "LatLng",
- "description": "The latitude and longitude of the location, in degrees."
}
},
"id": "Location",
@@ -1687,6 +2239,10 @@
},
"OptIns": {
"properties": {
+ "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"
@@ -1702,10 +2258,6 @@
"marketComm": {
"description": "An opt-in about receiving email from Partners marketing teams. Includes\nmember-only events and special promotional offers for Google products.",
"type": "boolean"
- },
- "specialOffers": {
- "description": "An opt-in about receiving email regarding new features and products.",
- "type": "boolean"
}
},
"id": "OptIns",
@@ -1716,35 +2268,64 @@
"description": "Information related to ranking of results.",
"type": "object",
"properties": {
+ "value": {
+ "description": "The numerical value of the rank.",
+ "format": "double",
+ "type": "number"
+ },
"type": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Total final score."
+ ],
"enum": [
"RANK_TYPE_UNSPECIFIED",
"RT_FINAL_SCORE"
],
"description": "The type of rank.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Total final score."
- ]
- },
- "value": {
- "description": "The numerical value of the rank.",
- "format": "double",
- "type": "number"
+ "type": "string"
}
},
"id": "Rank"
},
+ "GetPartnersStatusResponse": {
+ "description": "Response message for\nGetPartnersStatus.",
+ "type": "object",
+ "properties": {
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ }
+ },
+ "id": "GetPartnersStatusResponse"
+ },
"UserProfile": {
"properties": {
+ "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.",
@@ -1753,6 +2334,10 @@
"type": "string"
}
},
+ "emailOptIns": {
+ "description": "The list of opt-ins for the user, related to communication preferences.",
+ "$ref": "OptIns"
+ },
"familyName": {
"description": "The user's family name.",
"type": "string"
@@ -1764,10 +2349,6 @@
"type": "string"
}
},
- "emailOptIns": {
- "$ref": "OptIns",
- "description": "The list of opt-ins for the user, related to communication preferences."
- },
"markets": {
"description": "A list of ids representing which markets the user was interested in.",
"type": "array",
@@ -1795,79 +2376,16 @@
"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"
- }
}
},
"id": "UserProfile",
"description": "The profile information of a Partners user.",
"type": "object"
},
- "GetPartnersStatusResponse": {
- "description": "Response message for\nGetPartnersStatus.",
+ "HistoricalOffer": {
+ "description": "Historical information about a Google Partners Offer.",
"type": "object",
"properties": {
- "responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
- }
- },
- "id": "GetPartnersStatusResponse"
- },
- "HistoricalOffer": {
- "properties": {
- "creationTime": {
- "description": "Time offer was first created.",
- "format": "google-datetime",
- "type": "string"
- },
- "clientEmail": {
- "description": "Email address for client.",
- "type": "string"
- },
- "status": {
- "enum": [
- "OFFER_STATUS_UNSPECIFIED",
- "OFFER_STATUS_DISTRIBUTED",
- "OFFER_STATUS_REDEEMED",
- "OFFER_STATUS_AWARDED",
- "OFFER_STATUS_EXPIRED"
- ],
- "description": "Status of the offer.",
- "type": "string",
- "enumDescriptions": [
- "Unset.",
- "Offer distributed.",
- "Offer redeemed.",
- "Offer awarded.",
- "Offer expired."
- ]
- },
- "clientId": {
- "description": "ID of client.",
- "format": "int64",
- "type": "string"
- },
- "clientName": {
- "description": "Name of the client.",
- "type": "string"
- },
"lastModifiedTime": {
"description": "Time last action was taken.",
"format": "google-datetime",
@@ -1909,11 +2427,45 @@
"offerCode": {
"description": "Offer code.",
"type": "string"
+ },
+ "creationTime": {
+ "description": "Time offer was first created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "clientEmail": {
+ "description": "Email address for client.",
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "OFFER_STATUS_UNSPECIFIED",
+ "OFFER_STATUS_DISTRIBUTED",
+ "OFFER_STATUS_REDEEMED",
+ "OFFER_STATUS_AWARDED",
+ "OFFER_STATUS_EXPIRED"
+ ],
+ "description": "Status of the offer.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unset.",
+ "Offer distributed.",
+ "Offer redeemed.",
+ "Offer awarded.",
+ "Offer expired."
+ ]
+ },
+ "clientId": {
+ "description": "ID of client.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clientName": {
+ "description": "Name of the client.",
+ "type": "string"
}
},
- "id": "HistoricalOffer",
- "description": "Historical information about a Google Partners Offer.",
- "type": "object"
+ "id": "HistoricalOffer"
},
"LogUserEventRequest": {
"description": "Request message for\nLogUserEvent.",
@@ -1964,167 +2516,6 @@
"$ref": "Lead"
},
"eventAction": {
- "enumDescriptions": [
- "Unchosen.",
- "Advertiser clicked `Find a partner` bottom button.",
- "Advertiser clicked `Find a partner` top button.",
- "Agency clicked `Join now` bottom button.",
- "Agency clicked `Join now` top button.",
- "Advertiser canceled partner contact form.",
- "Advertiser started partner contact form.",
- "Advertiser completed partner contact form.",
- "Advertiser entered email in contact form.",
- "Advertiser entered name in contact form.",
- "Advertiser entered phone in contact form.",
- "Advertiser failed \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nin contact form.",
- "Company viewed by advertiser.",
- "Advertiser canceled partner contact form on Google Partner Search.",
- "Advertiser changed a top search parameter.",
- "Advertiser started partner contact form on Google Partner Search.",
- "Advertiser clicked `Show more partners` bottom button.",
- "Advertiser completed partner contact form on Google Partner Search.",
- "Advertiser saw no partners available with search criteria.",
- "Advertiser performed search on Google Partner Search.",
- "Advertiser viewed a partner on Google Partner Search.",
- "Advertiser canceled partner contact form on profile page.",
- "Advertiser started partner contact form on profile page.",
- "Advertiser clicked partner website.",
- "Advertiser completed contact form on profile page.",
- "Advertiser viewed a partner profile.",
- "Agency clicked `accept Terms Of Service` button.",
- "Agency changed Terms Of Service country.",
- "Agency added address in profile portal.",
- "Agency added phone number in profile portal.",
- "Agency changed primary account association.",
- "Agency changed primary country association.",
- "Agency clicked `affiliate` button in profile portal.",
- "Agency clicked `give edit access` in profile portal.",
- "Agency clicked `log out` in profile portal.",
- "Agency clicked profile portal left nav.",
- "Agency clicked `save and continue` at bottom of complete profile.",
- "Agency clicked `unaffiliate` in profile portal.",
- "Agency filled out company affiliation in profile portal.",
- "Agency successfully connected with company in profile portal.",
- "Agency clicked create MCC in profile portal.",
- "Agency did not have an MCC associated on profile portal.",
- "Agency had an MCC associated on profile portal.",
- "Agency added job function in profile portal.",
- "Agency looked at job function drop-down.",
- "Agency selected `account manage` 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 profile portal.",
- "Agency looked at `add channel` drop-down.",
- "Agency selected `cross channel` from add channel drop-down.",
- "Agency selected `display` from add channel drop-down.",
- "Agency selected `mobile` from add channel drop-down.",
- "Agency selected `search` from add channel drop-down.",
- "Agency selected `social` from add channel drop-down.",
- "Agency selected `tools` from add channel drop-down.",
- "Agency selected `YouTube` from add channel drop-down.",
- "Agency added industries in profile portal.",
- "Agency changed `add industries` drop-down.",
- "Agency added markets in profile portal.",
- "Agency changed `add markets` drop-down.",
- "Agency checked `recieve mail promotions` in profile portal.",
- "Agency checked `recieve mail promotions` in sign-up.",
- "Agency selected `opt-in beta tests and market research`.",
- "Agency selected `opt-in beta tests` in profile portal.",
- "Agency selected `opt-in news` in profile portal.",
- "Agency selected `opt-in news invitations and promotions`.",
- "Agency selected `opt-in performance SUG` in profile portal.",
- "Agency selected `opt-in performance suggestions`.",
- "Agency selected `opt-in select all email notifications`.",
- "Agency selected `select all opt-ins` in profile portal.",
- "Agency clicked back button on `connect with company`.",
- "Agency clicked continue to overview on `connect with company`.",
- "Agency clicked `create MCC connect with company not found`.",
- "Agency clicked `give edit access connect with company not found`.",
- "Agency clicked `log out connect with company not found`.",
- "Agency clicked `skip for now on connect with company page`.",
- "Agency closed connection to company.",
- "Agency completed field connect with company.",
- "Agency 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 cliecked `get certified` link in portal notifications.",
- "Agency clicked `get VideoAds 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 in 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 certifications AdWords page.",
- "Agency clicked `see exams` certifications main page.",
- "Agency clicked `take exam` on certifications exam page.",
- "Agency opened `last admin` dialog.",
- "Agency opened dialog with no users.",
- "Agency promoted user to admin.",
- "Agency unaffiliated.",
- "Agency changed roles.",
- "Advertiser clicked `company name` link to profile.",
- "Advertiser viewed AdWords certificate.",
- "Advertiser viewed AdWords Search certificate.",
- "Advertiser viewed AdWords Display certificate.",
- "Advertiser clicked AdWords certificate help icon.",
- "Advertiser viewed Analytics certificate.",
- "Advertiser viewed DoubleClick certificate.",
- "Advertiser viewed Mobile Sites certificate.",
- "Advertiser viewed VideoAds certificate.",
- "Advertiser clicked Shopping certificate help icon.",
- "Advertiser clicked VideoAds certificate help icon.",
- "Advertiser viewed Digital Sales certificate.",
- "Clicked `help` at bottom.",
- "Clicked `help` at top.",
- "Client error occurred.",
- "Agency clicked left nav `stories`.",
- "Click occured.",
- "Advertiser clicked Mobile certificate help icon.",
- "Agency failed the company verification.",
- "User visited the landing portion of Google Partners.",
- "User visited the Google Partner Search portion of Google Partners.",
- "User visited the agency portal portion of Google Partners.",
- "User cancelled signing up.",
- "User cancelled signing up their company.",
- "Agency clicked `Sign in` top button.",
- "Agency clicked `save and continue` at bottom of incomplete profile.",
- "Agency unselected `opt-in news invitations and promotions`.",
- "Agency unselected `opt-in beta tests and market research`.",
- "Agency unselected `opt-in performance suggestions`.",
- "Agency selected `opt-out unselect all email notifications`.",
- "Agency linked their individual MCC.",
- "Agency was suggested to user for affiliation.",
- "Agency ignored suggested agencies and begin searching.",
- "Agency picked a suggested agency.",
- "Agency searched for agencies.",
- "Agency picked a searched agency.",
- "Agency dismissed affiliation widget.",
- "Agency clicked on the download link for downloading content.",
- "Agency user is maklingg progress viewing a content item.",
- "Agency clicked `cancel Terms Of Service` button.",
- "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."
- ],
"enum": [
"EVENT_ACTION_UNSPECIFIED",
"SMB_CLICKED_FIND_A_PARTNER_BUTTON_BOTTOM",
@@ -2287,7 +2678,168 @@
"AGENCY_SELECTED_OPT_OUT_AFA_MIGRATION"
],
"description": "The action that occurred.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Advertiser clicked `Find a partner` bottom button.",
+ "Advertiser clicked `Find a partner` top button.",
+ "Agency clicked `Join now` bottom button.",
+ "Agency clicked `Join now` top button.",
+ "Advertiser canceled partner contact form.",
+ "Advertiser started partner contact form.",
+ "Advertiser completed partner contact form.",
+ "Advertiser entered email in contact form.",
+ "Advertiser entered name in contact form.",
+ "Advertiser entered phone in contact form.",
+ "Advertiser failed \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nin contact form.",
+ "Company viewed by advertiser.",
+ "Advertiser canceled partner contact form on Google Partner Search.",
+ "Advertiser changed a top search parameter.",
+ "Advertiser started partner contact form on Google Partner Search.",
+ "Advertiser clicked `Show more partners` bottom button.",
+ "Advertiser completed partner contact form on Google Partner Search.",
+ "Advertiser saw no partners available with search criteria.",
+ "Advertiser performed search on Google Partner Search.",
+ "Advertiser viewed a partner on Google Partner Search.",
+ "Advertiser canceled partner contact form on profile page.",
+ "Advertiser started partner contact form on profile page.",
+ "Advertiser clicked partner website.",
+ "Advertiser completed contact form on profile page.",
+ "Advertiser viewed a partner profile.",
+ "Agency clicked `accept Terms Of Service` button.",
+ "Agency changed Terms Of Service country.",
+ "Agency added address in profile portal.",
+ "Agency added phone number in profile portal.",
+ "Agency changed primary account association.",
+ "Agency changed primary country association.",
+ "Agency clicked `affiliate` button in profile portal.",
+ "Agency clicked `give edit access` in profile portal.",
+ "Agency clicked `log out` in profile portal.",
+ "Agency clicked profile portal left nav.",
+ "Agency clicked `save and continue` at bottom of complete profile.",
+ "Agency clicked `unaffiliate` in profile portal.",
+ "Agency filled out company affiliation in profile portal.",
+ "Agency successfully connected with company in profile portal.",
+ "Agency clicked create MCC in profile portal.",
+ "Agency did not have an MCC associated on profile portal.",
+ "Agency had an MCC associated on profile portal.",
+ "Agency added job function in profile portal.",
+ "Agency looked at job function drop-down.",
+ "Agency selected `account manage` 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 profile portal.",
+ "Agency looked at `add channel` drop-down.",
+ "Agency selected `cross channel` from add channel drop-down.",
+ "Agency selected `display` from add channel drop-down.",
+ "Agency selected `mobile` from add channel drop-down.",
+ "Agency selected `search` from add channel drop-down.",
+ "Agency selected `social` from add channel drop-down.",
+ "Agency selected `tools` from add channel drop-down.",
+ "Agency selected `YouTube` from add channel drop-down.",
+ "Agency added industries in profile portal.",
+ "Agency changed `add industries` drop-down.",
+ "Agency added markets in profile portal.",
+ "Agency changed `add markets` drop-down.",
+ "Agency checked `recieve mail promotions` in profile portal.",
+ "Agency checked `recieve mail promotions` in sign-up.",
+ "Agency selected `opt-in beta tests and market research`.",
+ "Agency selected `opt-in beta tests` in profile portal.",
+ "Agency selected `opt-in news` in profile portal.",
+ "Agency selected `opt-in news invitations and promotions`.",
+ "Agency selected `opt-in performance SUG` in profile portal.",
+ "Agency selected `opt-in performance suggestions`.",
+ "Agency selected `opt-in select all email notifications`.",
+ "Agency selected `select all opt-ins` in profile portal.",
+ "Agency clicked back button on `connect with company`.",
+ "Agency clicked continue to overview on `connect with company`.",
+ "Agency clicked `create MCC connect with company not found`.",
+ "Agency clicked `give edit access connect with company not found`.",
+ "Agency clicked `log out connect with company not found`.",
+ "Agency clicked `skip for now on connect with company page`.",
+ "Agency closed connection to company.",
+ "Agency completed field connect with company.",
+ "Agency 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 cliecked `get certified` link in portal notifications.",
+ "Agency clicked `get VideoAds 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 in 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 certifications AdWords page.",
+ "Agency clicked `see exams` certifications main page.",
+ "Agency clicked `take exam` on certifications exam page.",
+ "Agency opened `last admin` dialog.",
+ "Agency opened dialog with no users.",
+ "Agency promoted user to admin.",
+ "Agency unaffiliated.",
+ "Agency changed roles.",
+ "Advertiser clicked `company name` link to profile.",
+ "Advertiser viewed AdWords certificate.",
+ "Advertiser viewed AdWords Search certificate.",
+ "Advertiser viewed AdWords Display certificate.",
+ "Advertiser clicked AdWords certificate help icon.",
+ "Advertiser viewed Analytics certificate.",
+ "Advertiser viewed DoubleClick certificate.",
+ "Advertiser viewed Mobile Sites certificate.",
+ "Advertiser viewed VideoAds certificate.",
+ "Advertiser clicked Shopping certificate help icon.",
+ "Advertiser clicked VideoAds certificate help icon.",
+ "Advertiser viewed Digital Sales certificate.",
+ "Clicked `help` at bottom.",
+ "Clicked `help` at top.",
+ "Client error occurred.",
+ "Agency clicked left nav `stories`.",
+ "Click occured.",
+ "Advertiser clicked Mobile certificate help icon.",
+ "Agency failed the company verification.",
+ "User visited the landing portion of Google Partners.",
+ "User visited the Google Partner Search portion of Google Partners.",
+ "User visited the agency portal portion of Google Partners.",
+ "User cancelled signing up.",
+ "User cancelled signing up their company.",
+ "Agency clicked `Sign in` top button.",
+ "Agency clicked `save and continue` at bottom of incomplete profile.",
+ "Agency unselected `opt-in news invitations and promotions`.",
+ "Agency unselected `opt-in beta tests and market research`.",
+ "Agency unselected `opt-in performance suggestions`.",
+ "Agency selected `opt-out unselect all email notifications`.",
+ "Agency linked their individual MCC.",
+ "Agency was suggested to user for affiliation.",
+ "Agency ignored suggested agencies and begin searching.",
+ "Agency picked a suggested agency.",
+ "Agency searched for agencies.",
+ "Agency picked a searched agency.",
+ "Agency dismissed affiliation widget.",
+ "Agency clicked on the download link for downloading content.",
+ "Agency user is maklingg progress viewing a content item.",
+ "Agency clicked `cancel Terms Of Service` button.",
+ "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.",
@@ -2297,13 +2849,14 @@
"description": "Current request metadata.",
"$ref": "RequestMetadata"
},
+ "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",
@@ -2311,27 +2864,26 @@
"PAGE"
],
"description": "The scope of the event.",
- "type": "string"
- },
- "eventDatas": {
- "description": "List of event data for the event.",
- "type": "array",
- "items": {
- "$ref": "EventData"
- }
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Based on visitor.",
+ "Based on session.",
+ "Based on page visit."
+ ]
}
},
"id": "LogUserEventRequest"
},
"UserOverrides": {
"properties": {
- "ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
- },
"userId": {
"description": "Logged-in user ID to impersonate instead of the user's ID.",
"type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
}
},
"id": "UserOverrides",
@@ -2361,13 +2913,9 @@
"description": "Analytics data for a `Company` within a single day.",
"type": "object",
"properties": {
- "contacts": {
- "$ref": "AnalyticsDataPoint",
- "description": "Instances of users contacting the `Company`\non the specified date."
- },
"eventDate": {
- "description": "Date on which these events occurred.",
- "$ref": "Date"
+ "$ref": "Date",
+ "description": "Date on which these events occurred."
},
"profileViews": {
"$ref": "AnalyticsDataPoint",
@@ -2376,25 +2924,29 @@
"searchViews": {
"$ref": "AnalyticsDataPoint",
"description": "Instances of users seeing the `Company` in Google Partners Search results\non the specified date."
+ },
+ "contacts": {
+ "$ref": "AnalyticsDataPoint",
+ "description": "Instances of users contacting the `Company`\non the specified date."
}
},
"id": "Analytics"
},
"AdWordsManagerAccountInfo": {
- "description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186",
- "type": "object",
"properties": {
+ "customerName": {
+ "description": "Name of the customer this account represents.",
+ "type": "string"
+ },
"id": {
"description": "The AdWords Manager Account id.",
"format": "int64",
"type": "string"
- },
- "customerName": {
- "description": "Name of the customer this account represents.",
- "type": "string"
}
},
- "id": "AdWordsManagerAccountInfo"
+ "id": "AdWordsManagerAccountInfo",
+ "description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186",
+ "type": "object"
},
"PublicProfile": {
"properties": {
@@ -2424,33 +2976,67 @@
"type": "object"
},
"ResponseMetadata": {
- "properties": {
- "debugInfo": {
- "description": "Debug information about this request.",
- "$ref": "DebugInfo"
- }
- },
- "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"
- },
+ "debugInfo": {
+ "$ref": "DebugInfo",
+ "description": "Debug information about this request."
+ }
+ },
+ "id": "ResponseMetadata"
+ },
+ "RecaptchaChallenge": {
+ "properties": {
"id": {
"description": "The ID of the reCaptcha challenge.",
"type": "string"
+ },
+ "response": {
+ "description": "The response to the reCaptcha challenge.",
+ "type": "string"
}
},
- "id": "RecaptchaChallenge"
+ "id": "RecaptchaChallenge",
+ "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info.",
+ "type": "object"
},
"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"
@@ -2465,16 +3051,6 @@
"type": "string"
},
"offerLevel": {
- "enumDescriptions": [
- "Unset.",
- "Users/Agencies that have no offers because of a problem.",
- "Users/Agencies that have no offers due to contractural agreements.",
- "Users/Agencies that have a manually-configured limit.",
- "Some Agencies don't get any offers.",
- "Basic level gets 5 per month.",
- "Agencies with adequate AHI and spend get 15/month.",
- "Badged partners (even in grace) get 50 per month."
- ],
"enum": [
"OFFER_LEVEL_UNSPECIFIED",
"OFFER_LEVEL_DENY_PROBLEM",
@@ -2486,7 +3062,17 @@
"OFFER_LEVEL_LIMIT_50"
],
"description": "Level of this offer.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unset.",
+ "Users/Agencies that have no offers because of a problem.",
+ "Users/Agencies that have no offers due to contractural agreements.",
+ "Users/Agencies that have a manually-configured limit.",
+ "Some Agencies don't get any offers.",
+ "Basic level gets 5 per month.",
+ "Agencies with adequate AHI and spend get 15/month.",
+ "Badged partners (even in grace) get 50 per month."
+ ]
},
"name": {
"description": "Name of the offer.",
@@ -2507,68 +3093,31 @@
"items": {
"$ref": "CountryOfferInfo"
}
- },
- "offerType": {
- "enum": [
- "OFFER_TYPE_UNSPECIFIED",
- "OFFER_TYPE_SPEND_X_GET_Y",
- "OFFER_TYPE_VIDEO",
- "OFFER_TYPE_SPEND_MATCH"
- ],
- "description": "Type of offer.",
- "type": "string",
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ]
- },
- "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"
}
},
- "id": "AvailableOffer",
- "description": "Available Offers to be distributed.",
- "type": "object"
+ "id": "AvailableOffer"
},
"LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
- "type": "object",
"properties": {
- "latitude": {
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "format": "double",
- "type": "number"
- },
"longitude": {
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"format": "double",
"type": "number"
+ },
+ "latitude": {
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "format": "double",
+ "type": "number"
}
},
- "id": "LatLng"
+ "id": "LatLng",
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
+ "type": "object"
},
"Money": {
+ "description": "Represents an amount of money with its currency type.",
+ "type": "object",
"properties": {
- "units": {
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "format": "int64",
- "type": "string"
- },
"currencyCode": {
"description": "The 3-letter currency code defined in ISO 4217.",
"type": "string"
@@ -2577,15 +3126,16 @@
"description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
"format": "int32",
"type": "integer"
+ },
+ "units": {
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "format": "int64",
+ "type": "string"
}
},
- "id": "Money",
- "description": "Represents an amount of money with its currency type.",
- "type": "object"
+ "id": "Money"
},
"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.",
@@ -2603,7 +3153,9 @@
"type": "integer"
}
},
- "id": "AnalyticsSummary"
+ "id": "AnalyticsSummary",
+ "description": "Analytics aggregated data for a `Company` for a given date range.",
+ "type": "object"
},
"LogMessageRequest": {
"description": "Request message for\nLogClientMessage.",
@@ -2617,8 +3169,8 @@
"type": "object"
},
"requestMetadata": {
- "description": "Current request metadata.",
- "$ref": "RequestMetadata"
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
},
"level": {
"enum": [
@@ -2646,16 +3198,30 @@
"id": "LogMessageRequest"
},
"Lead": {
- "description": "A lead resource that represents an advertiser contact for a `Company`. These\nare usually generated via Google Partner Search (the advertiser portal).",
- "type": "object",
"properties": {
+ "marketingOptIn": {
+ "description": "Whether or not the lead signed up for marketing emails",
+ "type": "boolean"
+ },
+ "type": {
+ "enum": [
+ "LEAD_TYPE_UNSPECIFIED",
+ "LT_GPS"
+ ],
+ "description": "Type of lead.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Google Partner Search."
+ ]
+ },
"givenName": {
"description": "First name of lead source.",
"type": "string"
},
"minMonthlyBudget": {
- "description": "The minimum monthly budget lead source is willing to spend.",
- "$ref": "Money"
+ "$ref": "Money",
+ "description": "The minimum monthly budget lead source is willing to spend."
},
"websiteUrl": {
"description": "Website URL of lead source.",
@@ -2666,12 +3232,6 @@
"type": "string"
},
"gpsMotivations": {
- "enumDescriptions": [
- "Unchosen.",
- "Advertiser needs help with their advertising.",
- "Advertiser needs help with their website.",
- "Advertiser does not have a website."
- ],
"description": "List of reasons for using Google Partner Search and creating a lead.",
"type": "array",
"items": {
@@ -2682,7 +3242,13 @@
"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": {
"enumDescriptions": [
@@ -2731,27 +3297,15 @@
"description": "Timestamp of when this lead was created.",
"format": "google-datetime",
"type": "string"
- },
- "marketingOptIn": {
- "description": "Whether or not the lead signed up for marketing emails",
- "type": "boolean"
- },
- "type": {
- "enum": [
- "LEAD_TYPE_UNSPECIFIED",
- "LT_GPS"
- ],
- "description": "Type of lead.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Google Partner Search."
- ]
}
},
- "id": "Lead"
+ "id": "Lead",
+ "description": "A lead resource that represents an advertiser contact for a `Company`. These\nare usually generated via Google Partner Search (the advertiser portal).",
+ "type": "object"
},
"DebugInfo": {
+ "description": "Debug information about this request.",
+ "type": "object",
"properties": {
"serverInfo": {
"description": "Info about the server that serviced this request.",
@@ -2766,19 +3320,13 @@
"type": "string"
}
},
- "id": "DebugInfo",
- "description": "Debug information about this request.",
- "type": "object"
+ "id": "DebugInfo"
},
"ListUserStatesResponse": {
"description": "Response message for\nListUserStates.",
"type": "object",
"properties": {
"userStates": {
- "enumDescriptions": [
- "Unchosen.",
- "User must pass \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e to\ncontact a Partner via Google Partner Search."
- ],
"description": "User's states.",
"type": "array",
"items": {
@@ -2787,7 +3335,11 @@
"US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT"
],
"type": "string"
- }
+ },
+ "enumDescriptions": [
+ "Unchosen.",
+ "User must pass \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e to\ncontact a Partner via Google Partner Search."
+ ]
},
"responseMetadata": {
"description": "Current response metadata.",
@@ -2797,23 +3349,25 @@
"id": "ListUserStatesResponse"
},
"CompanyRelation": {
+ "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.",
+ "type": "object",
"properties": {
- "isPending": {
- "description": "The flag that indicates if the company is pending verification.",
- "type": "boolean"
- },
"address": {
"description": "The primary address for this company.",
"type": "string"
},
+ "isPending": {
+ "description": "The flag that indicates if the company is pending verification.",
+ "type": "boolean"
+ },
"creationTime": {
"description": "The timestamp of when affiliation was requested.\n@OutputOnly",
"format": "google-datetime",
"type": "string"
},
"primaryAddress": {
- "$ref": "Location",
- "description": "The primary location of the company."
+ "description": "The primary location of the company.",
+ "$ref": "Location"
},
"state": {
"enum": [
@@ -2831,16 +3385,22 @@
"Approved by company."
]
},
+ "name": {
+ "description": "The name (in the company's primary language) for the company.",
+ "type": "string"
+ },
"managerAccount": {
"description": "The AdWords manager account # associated this company.",
"format": "int64",
"type": "string"
},
- "name": {
- "description": "The name (in the company's primary language) for the company.",
- "type": "string"
- },
"segment": {
+ "enumDescriptions": [
+ "Default segment indicates an unknown.",
+ "Segment representing a selected group of Partners",
+ "Segment representing Premier SMB Partners, an AdWords partnership program.",
+ "A segment of Premier SMB Partners that have relationship with Google."
+ ],
"description": "The segment the company is classified as.",
"type": "array",
"items": {
@@ -2851,13 +3411,7 @@
"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.",
@@ -2918,13 +3472,9 @@
"type": "boolean"
}
},
- "id": "CompanyRelation",
- "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.",
- "type": "object"
+ "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": {
"month": {
"description": "Month of year. Must be from 1 to 12.",
@@ -2942,17 +3492,17 @@
"type": "integer"
}
},
- "id": "Date"
- },
- "Empty": {
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "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"
},
- "TrafficSource": {
- "description": "Source of traffic for the current request.",
+ "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.",
@@ -2963,564 +3513,14 @@
"type": "string"
}
},
- "id": "TrafficSource"
- },
- "RequestMetadata": {
- "properties": {
- "locale": {
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "userOverrides": {
- "description": "Values to use instead of the user's respective defaults for the current\nrequest. These are only honored by whitelisted products.",
- "$ref": "UserOverrides"
- },
- "partnersSessionId": {
- "description": "Google Partners session ID.",
- "type": "string"
- },
- "experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "trafficSource": {
- "description": "Source of traffic for the current request.",
- "$ref": "TrafficSource"
- }
- },
- "id": "RequestMetadata",
- "description": "Common data that is in each API request.",
- "type": "object"
- },
- "CreateLeadRequest": {
- "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": {
- "$ref": "RecaptchaChallenge",
- "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info."
- }
- },
- "id": "CreateLeadRequest",
- "description": "Request message for CreateLead.",
- "type": "object"
- },
- "EventData": {
- "description": "Key value data pair for an event.",
- "type": "object",
- "properties": {
- "key": {
- "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",
- "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\\]."
- ]
- },
- "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": {
- "enumDescriptions": [
- "Unchosen.",
- "Adwords Fundamentals exam.",
- "AdWords advanced search exam.",
- "AdWords advanced display exam.",
- "VideoAds exam.",
- "DoubleClick exam.",
- "Analytics exam.",
- "Shopping exam.",
- "Mobile exam.",
- "Digital Sales exam.",
- "Mobile Sites exam."
- ],
- "enum": [
- "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
- "CET_ADWORDS_FUNDAMENTALS",
- "CET_ADWORDS_ADVANCED_SEARCH",
- "CET_ADWORDS_ADVANCED_DISPLAY",
- "CET_VIDEO_ADS",
- "CET_DOUBLECLICK",
- "CET_ANALYTICS",
- "CET_SHOPPING",
- "CET_MOBILE",
- "CET_DIGITAL_SALES",
- "CET_MOBILE_SITES"
- ],
- "description": "The type of the exam.",
- "type": "string"
- },
- "passed": {
- "description": "Whether this exam has been passed and not expired.",
- "type": "boolean"
- },
- "taken": {
- "description": "The date the user last taken this exam.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "ExamStatus"
- },
- "ListOffersResponse": {
- "description": "Response for ListOffer.",
- "type": "object",
- "properties": {
- "availableOffers": {
- "description": "Available Offers to be distributed.",
- "type": "array",
- "items": {
- "$ref": "AvailableOffer"
- }
- },
- "responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
- },
- "noOfferReason": {
- "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",
- "enumDescriptions": [
- "Unset.",
- "Not an MCC.",
- "Offer limit has been reached.",
- "Ineligible for offers."
- ]
- }
- },
- "id": "ListOffersResponse"
- },
- "CountryOfferInfo": {
- "description": "Offer info by country.",
- "type": "object",
- "properties": {
- "offerCountryCode": {
- "description": "Country code for which offer codes may be requested.",
- "type": "string"
- },
- "spendXAmount": {
- "description": "(localized) Spend X amount for that country's offer.",
- "type": "string"
- },
- "offerType": {
- "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": {
- "description": "Response message for\nListCompanies.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the `ListCompaniesRequest.page_token` field in the\nsubsequent call to\nListCompanies to retrieve the\nnext page of results.",
- "type": "string"
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
- "companies": {
- "description": "The list of companies.",
- "type": "array",
- "items": {
- "$ref": "Company"
- }
- }
- },
- "id": "ListCompaniesResponse"
- },
- "OfferCustomer": {
- "description": "Customers qualified for an offer.",
- "type": "object",
- "properties": {
- "adwordsUrl": {
- "description": "URL to the customer's AdWords page.",
- "type": "string"
- },
- "eligibilityDaysLeft": {
- "description": "Days the customer is still eligible.",
- "format": "int32",
- "type": "integer"
- },
- "offerType": {
- "enum": [
- "OFFER_TYPE_UNSPECIFIED",
- "OFFER_TYPE_SPEND_X_GET_Y",
- "OFFER_TYPE_VIDEO",
- "OFFER_TYPE_SPEND_MATCH"
- ],
- "description": "Type of the offer",
- "type": "string",
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ]
- },
- "externalCid": {
- "description": "External CID for the customer.",
- "format": "int64",
- "type": "string"
- },
- "countryCode": {
- "description": "Country code of the customer.",
- "type": "string"
- },
- "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": {
- "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",
- "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": {
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "id": "LogUserEventResponse",
- "description": "Response message for\nLogUserEvent.",
- "type": "object"
- },
- "ListOffersHistoryResponse": {
- "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",
- "description": "Response for ListOfferHistory.",
- "type": "object"
- },
- "LogMessageResponse": {
- "description": "Response message for\nLogClientMessage.",
- "type": "object",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "id": "LogMessageResponse"
- },
- "SpecializationStatus": {
- "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": {
- "enumDescriptions": [
- "Unknown specialization",
- "AdWords Search specialization",
- "AdWords Display specialization",
- "AdWords Mobile specialization",
- "AdWords Video specialization",
- "AdWords Shopping specialization"
- ],
- "enum": [
- "BADGE_SPECIALIZATION_UNKNOWN",
- "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
- "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
- "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
- "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
- "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
- ],
- "description": "The specialization this status is for.",
- "type": "string"
- }
- },
- "id": "SpecializationStatus",
- "description": "Agency specialization status",
+ "id": "TrafficSource",
+ "description": "Source of traffic for the current request.",
"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"
- },
- "version": "v2",
- "baseUrl": "https://partners.googleapis.com/",
- "canonicalName": "Partners",
- "servicePath": "",
- "description": "Searches certified companies and creates contact leads with them, and also audits the usage of clients.",
- "kind": "discovery#restDescription",
- "rootUrl": "https://partners.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "partners",
- "batchPath": "batch",
- "revision": "20180122",
- "documentationLink": "https://developers.google.com/partners/",
- "id": "partners:v2",
- "title": "Google Partners API"
+ "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/people/v1/people-api.json b/people/v1/people-api.json
index 8918649..9f2485f 100644
--- a/people/v1/people-api.json
+++ b/people/v1/people-api.json
@@ -1,51 +1,93 @@
{
- "canonicalName": "People Service",
- "auth": {
- "oauth2": {
- "scopes": {
- "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/plus.login": {
- "description": "Know the list of people in your circles, your age range, and language"
- },
- "https://www.googleapis.com/auth/userinfo.profile": {
- "description": "View your basic profile info"
- },
- "https://www.googleapis.com/auth/user.emails.read": {
- "description": "View your email addresses"
- },
- "https://www.googleapis.com/auth/contacts": {
- "description": "Manage your contacts"
- },
- "https://www.googleapis.com/auth/user.addresses.read": {
- "description": "View your street addresses"
- },
- "https://www.googleapis.com/auth/user.phonenumbers.read": {
- "description": "View your phone numbers"
- },
- "https://www.googleapis.com/auth/userinfo.email": {
- "description": "View your email address"
- }
- }
- }
- },
- "rootUrl": "https://people.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "people",
- "batchPath": "batch",
"title": "Google People API",
"ownerName": "Google",
"resources": {
"people": {
"methods": {
+ "updateContact": {
+ "description": "Update contact data for an existing contact person. Any non-contact data\nwill not be modified.\n\nThe request throws a 400 error if `updatePersonFields` is not specified.\n\u003cbr\u003e\nThe request throws a 400 error if `person.metadata.sources` is not\nspecified for the contact to be updated.\n\u003cbr\u003e\nThe request throws a 412 error if `person.metadata.sources.etag` is\ndifferent than the contact's etag, which indicates the contact has changed\nsince its data was read. Clients should get the latest person and re-apply\ntheir updates to the latest person.",
+ "request": {
+ "$ref": "Person"
+ },
+ "response": {
+ "$ref": "Person"
+ },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "parameters": {
+ "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": {
+ "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* interests\n* locales\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/people/{peopleId}:updateContact",
+ "path": "v1/{+resourceName}:updateContact",
+ "id": "people.people.updateContact"
+ },
+ "createContact": {
+ "request": {
+ "$ref": "Person"
+ },
+ "description": "Create a new contact and return the person resource for that contact.",
+ "response": {
+ "$ref": "Person"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "location": "query",
+ "description": "The resource name of the owning person resource.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/people:createContact",
+ "path": "v1/people:createContact",
+ "id": "people.people.createContact"
+ },
+ "deleteContact": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "resourceName": {
+ "pattern": "^people/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the contact to delete.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/people/{peopleId}:deleteContact",
+ "path": "v1/{+resourceName}:deleteContact",
+ "id": "people.people.deleteContact",
+ "description": "Delete a contact person. Any non-contact data will not be deleted."
+ },
"getBatchGet": {
- "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"
},
@@ -53,10 +95,10 @@
"httpMethod": "GET",
"parameters": {
"personFields": {
- "location": "query",
"description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
"format": "google-fieldmask",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"requestMask.includeField": {
"location": "query",
@@ -82,9 +124,14 @@
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/userinfo.profile"
],
- "flatPath": "v1/people:batchGet"
+ "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": {
+ "path": "v1/{+resourceName}",
+ "id": "people.people.get",
"description": "Provides information about a person by specifying a resource name. Use\n`people/me` to indicate the authenticated user.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.",
"response": {
"$ref": "Person"
@@ -93,27 +140,6 @@
"resourceName"
],
"httpMethod": "GET",
- "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* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "requestMask.includeField": {
- "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"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly",
@@ -125,135 +151,49 @@
"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"
- },
- "updateContact": {
- "response": {
- "$ref": "Person"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
"parameters": {
"resourceName": {
- "location": "path",
- "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
+ "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/[^/]+$"
+ "pattern": "^people/[^/]+$",
+ "location": "path"
},
- "updatePersonFields": {
+ "personFields": {
"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* interests\n* locales\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls",
+ "description": "**Required.** A field mask to restrict which fields on the person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
"format": "google-fieldmask",
"type": "string"
+ },
+ "requestMask.includeField": {
+ "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
}
},
- "flatPath": "v1/people/{peopleId}:updateContact",
- "path": "v1/{+resourceName}:updateContact",
- "id": "people.people.updateContact",
- "description": "Update contact data for an existing contact person. Any non-contact data\nwill not be modified.\n\nThe request throws a 400 error if `updatePersonFields` is not specified.\n\u003cbr\u003e\nThe request throws a 400 error if `person.metadata.sources` is not\nspecified for the contact to be updated.\n\u003cbr\u003e\nThe request throws a 412 error if `person.metadata.sources.etag` is\ndifferent than the contact's etag, which indicates the contact has changed\nsince its data was read. Clients should get the latest person and re-apply\ntheir updates to the latest person.",
- "request": {
- "$ref": "Person"
- }
- },
- "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": {
- "path": "v1/{+resourceName}:deleteContact",
- "id": "people.people.deleteContact",
- "description": "Delete a contact person. Any non-contact data will not be deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "resourceName": {
- "pattern": "^people/[^/]+$",
- "location": "path",
- "description": "The resource name of the contact to delete.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "flatPath": "v1/people/{peopleId}:deleteContact"
+ "flatPath": "v1/people/{peopleId}"
}
},
"resources": {
"connections": {
"methods": {
"list": {
- "flatPath": "v1/people/{peopleId}/connections",
- "id": "people.people.connections.list",
"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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "resourceName"
- ],
"response": {
"$ref": "ListConnectionsResponse"
},
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "GET",
"parameters": {
- "syncToken": {
- "description": "A sync token returned by a previous call to `people.connections.list`.\nOnly resources changed since the sync token was created will be returned.\nSync requests that specify `sync_token` have an additional rate limit.",
- "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* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "sortOrder": {
- "location": "query",
- "enum": [
- "LAST_MODIFIED_ASCENDING",
- "FIRST_NAME_ASCENDING",
- "LAST_NAME_ASCENDING"
- ],
- "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
- "type": "string"
- },
"requestSyncToken": {
- "location": "query",
"description": "Whether the response should include a sync token, which can be used to get\nall changes since the last request. For subsequent sync requests use the\n`sync_token` param instead. Initial sync requests that specify\n`request_sync_token` have an additional rate limit.",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"pageToken": {
"description": "The token of the page to be returned.",
@@ -274,16 +214,38 @@
"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",
+ "location": "query"
+ },
+ "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.\nSync requests that specify `sync_token` have an additional rate limit.",
+ "type": "string",
+ "location": "query"
+ },
+ "personFields": {
+ "location": "query",
+ "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "sortOrder": {
+ "location": "query",
+ "enum": [
+ "LAST_MODIFIED_ASCENDING",
+ "FIRST_NAME_ASCENDING",
+ "LAST_NAME_ASCENDING"
+ ],
+ "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly"
- ]
+ ],
+ "flatPath": "v1/people/{peopleId}/connections"
}
}
}
@@ -291,8 +253,25 @@
},
"contactGroups": {
"methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ContactGroup"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/contactGroups",
+ "id": "people.contactGroups.create",
+ "path": "v1/contactGroups",
+ "request": {
+ "$ref": "CreateContactGroupRequest"
+ },
+ "description": "Create a new contact group owned by the authenticated user."
+ },
"get": {
- "description": "Get a specific contact group owned by the authenticated user by specifying\na contact group resource name.",
"response": {
"$ref": "ContactGroup"
},
@@ -300,10 +279,6 @@
"resourceName"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
"parameters": {
"maxMembers": {
"description": "Specifies the maximum number of members to return.",
@@ -312,29 +287,34 @@
"location": "query"
},
"resourceName": {
- "location": "path",
"description": "The resource name of the contact group to get.",
"required": true,
"type": "string",
- "pattern": "^contactGroups/[^/]+$"
+ "pattern": "^contactGroups/[^/]+$",
+ "location": "path"
}
},
+ "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"
+ "id": "people.contactGroups.get",
+ "description": "Get a specific contact group owned by the authenticated user by specifying\na contact group resource name."
},
"update": {
"request": {
"$ref": "UpdateContactGroupRequest"
},
"description": "Update the name of an existing contact group owned by the authenticated\nuser.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "resourceName"
- ],
"response": {
"$ref": "ContactGroup"
},
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "PUT",
"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.",
@@ -348,54 +328,53 @@
"https://www.googleapis.com/auth/contacts"
],
"flatPath": "v1/contactGroups/{contactGroupsId}",
- "id": "people.contactGroups.update",
- "path": "v1/{+resourceName}"
+ "path": "v1/{+resourceName}",
+ "id": "people.contactGroups.update"
},
"batchGet": {
- "description": "Get a list of contact groups owned by the authenticated user by specifying\na list of contact group resource names.",
- "httpMethod": "GET",
"response": {
"$ref": "BatchGetContactGroupsResponse"
},
"parameterOrder": [],
- "parameters": {
- "maxMembers": {
- "location": "query",
- "description": "Specifies the maximum number of members to return for each group.",
- "format": "int32",
- "type": "integer"
- },
- "resourceNames": {
- "location": "query",
- "description": "The resource names of the contact groups to get.",
- "type": "string",
- "repeated": true
- }
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly"
],
+ "parameters": {
+ "maxMembers": {
+ "description": "Specifies the maximum number of members to return for each group.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "resourceNames": {
+ "description": "The resource names of the contact groups to get.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ }
+ },
"flatPath": "v1/contactGroups:batchGet",
+ "path": "v1/contactGroups:batchGet",
"id": "people.contactGroups.batchGet",
- "path": "v1/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"
- },
+ "httpMethod": "DELETE",
"parameterOrder": [
"resourceName"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"resourceName": {
+ "pattern": "^contactGroups/[^/]+$",
+ "location": "path",
"description": "The resource name of the contact group to delete.",
"required": true,
- "type": "string",
- "pattern": "^contactGroups/[^/]+$",
- "location": "path"
+ "type": "string"
},
"deleteContacts": {
"location": "query",
@@ -407,16 +386,20 @@
"https://www.googleapis.com/auth/contacts"
],
"flatPath": "v1/contactGroups/{contactGroupsId}",
+ "id": "people.contactGroups.delete",
"path": "v1/{+resourceName}",
- "id": "people.contactGroups.delete"
+ "description": "Delete an existing contact group owned by the authenticated user by\nspecifying a contact group resource name."
},
"list": {
- "description": "List all contact groups owned by the authenticated user. Members of the\ncontact groups are not populated.",
"response": {
"$ref": "ListContactGroupsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
"parameters": {
"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.",
@@ -424,70 +407,49 @@
"location": "query"
},
"pageToken": {
- "location": "query",
"description": "The next_page_token value returned from a previous call to\n[ListContactGroups](/people/api/rest/v1/contactgroups/list).\nRequests the next page of resources.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
- "location": "query",
"description": "The maximum number of resources to return.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
"flatPath": "v1/contactGroups",
"path": "v1/contactGroups",
- "id": "people.contactGroups.list"
- },
- "create": {
- "path": "v1/contactGroups",
- "id": "people.contactGroups.create",
- "description": "Create a new contact group owned by the authenticated user.",
- "request": {
- "$ref": "CreateContactGroupRequest"
- },
- "response": {
- "$ref": "ContactGroup"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "parameters": {},
- "flatPath": "v1/contactGroups"
+ "id": "people.contactGroups.list",
+ "description": "List all contact groups owned by the authenticated user. Members of the\ncontact groups are not populated."
}
},
"resources": {
"members": {
"methods": {
"modify": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resourceName"
- ],
"response": {
"$ref": "ModifyContactGroupMembersResponse"
},
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "POST",
"parameters": {
"resourceName": {
- "location": "path",
"description": "The resource name of the contact group to modify.",
"required": true,
"type": "string",
- "pattern": "^contactGroups/[^/]+$"
+ "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",
+ "id": "people.contactGroups.members.modify",
"request": {
"$ref": "ModifyContactGroupMembersRequest"
},
@@ -499,41 +461,10 @@
}
},
"parameters": {
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "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",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
@@ -542,9 +473,9 @@
"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",
@@ -584,614 +515,62 @@
"location": "query",
"description": "Data format for response.",
"default": "json"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "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://people.googleapis.com/",
- "servicePath": "",
- "description": "Provides access to information about profiles and contacts.",
"kind": "discovery#restDescription",
+ "description": "Provides access to information about profiles and contacts.",
+ "servicePath": "",
"basePath": "",
- "documentationLink": "https://developers.google.com/people/",
- "revision": "20180125",
"id": "people:v1",
+ "revision": "20180125",
+ "documentationLink": "https://developers.google.com/people/",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "EmailAddress": {
- "properties": {
- "formattedType": {
- "description": "The read-only type of the email address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "displayName": {
- "description": "The display name of the email.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the email address.",
- "$ref": "FieldMetadata"
- },
- "type": {
- "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
- "type": "string"
- },
- "value": {
- "description": "The email address.",
- "type": "string"
- }
- },
- "id": "EmailAddress",
- "description": "A person's email address.",
- "type": "object"
- },
- "Nickname": {
- "description": "A person's nickname.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the nickname."
- },
- "type": {
- "enumDescriptions": [
- "Generic nickname.",
- "Maiden name or birth family name. Used when the person's family name has\nchanged as a result of marriage.",
- "Initials.",
- "Google+ profile nickname.",
- "A professional affiliation or other name; for example, `Dr. Smith.`"
- ],
- "enum": [
- "DEFAULT",
- "MAIDEN_NAME",
- "INITIALS",
- "GPLUS",
- "OTHER_NAME"
- ],
- "description": "The type of the nickname.",
- "type": "string"
- },
- "value": {
- "description": "The nickname.",
- "type": "string"
- }
- },
- "id": "Nickname"
- },
- "Skill": {
- "description": "A skill that the person has.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The skill; for example, `underwater basket weaving`.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the skill.",
- "$ref": "FieldMetadata"
- }
- },
- "id": "Skill"
- },
- "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": {
- "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": {
- "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"
- }
- },
- "id": "Date"
- },
- "Tagline": {
- "description": "A read-only brief one-line description of the person.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The tagline.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the tagline.",
- "$ref": "FieldMetadata"
- }
- },
- "id": "Tagline"
- },
- "Name": {
- "description": "A person's name. If the name is a mononym, the family name is empty.",
- "type": "object",
- "properties": {
- "phoneticFullName": {
- "description": "The full name spelled as it sounds.",
- "type": "string"
- },
- "displayNameLastFirst": {
- "description": "The read-only display name with the last name first formatted according to\nthe locale specified by the viewer's account or the\n`Accept-Language` HTTP header.",
- "type": "string"
- },
- "displayName": {
- "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the `Accept-Language` HTTP header.",
- "type": "string"
- },
- "honorificSuffix": {
- "description": "The honorific suffixes, such as `Jr.`",
- "type": "string"
- },
- "honorificPrefix": {
- "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
- "type": "string"
- },
- "phoneticHonorificSuffix": {
- "description": "The honorific suffixes spelled as they sound.",
- "type": "string"
- },
- "givenName": {
- "description": "The given name.",
- "type": "string"
- },
- "middleName": {
- "description": "The middle name(s).",
- "type": "string"
- },
- "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"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the name."
- },
- "phoneticMiddleName": {
- "description": "The middle name(s) spelled as they sound.",
- "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": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the locale."
- }
- },
- "id": "Locale"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "UserDefined": {
- "properties": {
- "key": {
- "description": "The end user specified key of the user defined data.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the user defined data.",
- "$ref": "FieldMetadata"
- },
- "value": {
- "description": "The end user specified value 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"
- },
- "RelationshipInterest": {
- "properties": {
- "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"
- },
- "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"
- }
- },
- "id": "RelationshipInterest",
- "description": "A person's read-only relationship interest .",
- "type": "object"
- },
- "Source": {
- "properties": {
- "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"
- },
- "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",
- "description": "The source of a field.",
- "type": "object"
- },
- "GetPeopleResponse": {
- "type": "object",
- "properties": {
- "responses": {
- "description": "The response for each requested resource name.",
- "type": "array",
- "items": {
- "$ref": "PersonResponse"
- }
- }
- },
- "id": "GetPeopleResponse"
- },
- "Photo": {
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the photo."
- },
- "default": {
- "description": "True if the photo is a default photo;\nfalse if the photo is a user-provided photo.",
- "type": "boolean"
- },
- "url": {
- "description": "The URL of the photo. You can change the desired size by appending a query\nparameter `sz=`\u003cvar\u003esize\u003c/var\u003e at the end of the url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`",
- "type": "string"
- }
- },
- "id": "Photo",
- "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
- "type": "object"
- },
- "PhoneNumber": {
- "description": "A person's phone number.",
- "type": "object",
- "properties": {
- "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"
- },
- "formattedType": {
- "description": "The read-only type of the phone number translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "canonicalForm": {
- "description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.",
- "type": "string"
- }
- },
- "id": "PhoneNumber"
- },
- "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": {
- "properties": {
- "date": {
- "description": "The date of the birthday.",
- "$ref": "Date"
- },
- "metadata": {
- "description": "Metadata about the birthday.",
- "$ref": "FieldMetadata"
- },
- "text": {
- "description": "A free-form string representing the user's birthday.",
- "type": "string"
- }
- },
- "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": {
- "description": "The contact group to create.",
- "$ref": "ContactGroup"
- }
- },
- "id": "CreateContactGroupRequest",
- "description": "A request to create a new contact group.",
- "type": "object"
- },
- "Address": {
- "properties": {
- "streetAddress": {
- "description": "The street address.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the address.",
- "$ref": "FieldMetadata"
- },
- "countryCode": {
- "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
- "type": "string"
- },
- "formattedType": {
- "description": "The read-only type of the address translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "city": {
- "description": "The city of the address.",
- "type": "string"
- },
- "formattedValue": {
- "description": "The unstructured value of the address. If this is not set by the user it\nwill be automatically constructed from structured values.",
- "type": "string"
- },
- "country": {
- "description": "The country of the address.",
- "type": "string"
- },
- "type": {
- "description": "The type of the 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"
- },
- "extendedAddress": {
- "description": "The extended address of the address; for example, the apartment number.",
- "type": "string"
- },
- "poBox": {
- "description": "The P.O. box of the address.",
- "type": "string"
- },
- "postalCode": {
- "description": "The postal code of the address.",
- "type": "string"
- },
- "region": {
- "description": "The region of the address; for example, the state or province.",
- "type": "string"
- }
- },
- "id": "Address",
- "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
- "type": "object"
- },
- "ContactGroupMembership": {
- "description": "A Google contact group membership.",
- "type": "object",
- "properties": {
- "contactGroupId": {
- "description": "The contact group ID for the contact group membership. The contact group\nID can be custom or predefined. Possible values include, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\n* A numerical ID for user-created groups.",
- "type": "string"
- }
- },
- "id": "ContactGroupMembership"
- },
- "Status": {
- "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"
- },
- "PersonMetadata": {
- "description": "The read-only metadata about a person.",
- "type": "object",
- "properties": {
- "objectType": {
- "enum": [
- "OBJECT_TYPE_UNSPECIFIED",
- "PERSON",
- "PAGE"
- ],
- "description": "**DEPRECATED** (Please use\n`person.metadata.sources.profileMetadata.objectType` instead)\n\nThe type of the person object.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Person.",
- "[Google+ Page.](http://www.google.com/+/brands/)"
- ]
- },
- "linkedPeopleResourceNames": {
- "description": "Resource names of people linked to this resource.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "sources": {
- "description": "The sources of data for the person.",
- "type": "array",
- "items": {
- "$ref": "Source"
- }
- },
- "previousResourceNames": {
- "description": "Any former resource names this person has had. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.\n\nThe resource name may change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or\nprofile URL.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "deleted": {
- "description": "True if the person resource has been deleted. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.",
- "type": "boolean"
- }
- },
- "id": "PersonMetadata"
- },
"ModifyContactGroupMembersRequest": {
"properties": {
- "resourceNamesToRemove": {
- "description": "The resource names of the contact people to remove in the form of in the\nform of `people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
+ "resourceNamesToAdd": {
+ "description": "The resource names of the contact people to add in the form of in the form\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
"type": "array",
"items": {
"type": "string"
}
},
- "resourceNamesToAdd": {
- "description": "The resource names of the contact people to add in the form of in the form\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
+ "resourceNamesToRemove": {
+ "description": "The resource names of the contact people to remove in the form of in the\nform of `people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
"type": "array",
"items": {
"type": "string"
@@ -1203,28 +582,34 @@
"type": "object"
},
"ContactGroupResponse": {
+ "description": "The response for a specific contact group.",
+ "type": "object",
"properties": {
"contactGroup": {
"$ref": "ContactGroup",
"description": "The contact group."
},
"status": {
- "description": "The status of the response.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The status of the response."
},
"requestedResourceName": {
"description": "The original requested resource name.",
"type": "string"
}
},
- "id": "ContactGroupResponse",
- "description": "The response for a specific contact group.",
- "type": "object"
+ "id": "ContactGroupResponse"
},
"Url": {
- "description": "A person's associated URLs.",
- "type": "object",
"properties": {
+ "metadata": {
+ "$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`",
+ "type": "string"
+ },
"value": {
"description": "The URL.",
"type": "string"
@@ -1232,22 +617,18 @@
"formattedType": {
"description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
"type": "string"
- },
- "metadata": {
- "description": "Metadata about the URL.",
- "$ref": "FieldMetadata"
- },
- "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`",
- "type": "string"
}
},
- "id": "Url"
+ "id": "Url",
+ "description": "A person's associated URLs.",
+ "type": "object"
},
"ImClient": {
- "description": "A person's instant messaging client.",
- "type": "object",
"properties": {
+ "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"
@@ -1257,8 +638,8 @@
"type": "string"
},
"metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the IM client."
+ "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`",
@@ -1267,24 +648,22 @@
"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"
- },
- "username": {
- "description": "The user name used in the IM client.",
- "type": "string"
}
},
- "id": "ImClient"
+ "id": "ImClient",
+ "description": "A person's instant messaging client.",
+ "type": "object"
},
"DomainMembership": {
- "description": "A Google Apps Domain membership.",
- "type": "object",
"properties": {
"inViewerDomain": {
"description": "True if the person is in the viewer's Google Apps domain.",
"type": "boolean"
}
},
- "id": "DomainMembership"
+ "id": "DomainMembership",
+ "description": "A Google Apps Domain membership.",
+ "type": "object"
},
"Membership": {
"properties": {
@@ -1323,6 +702,10 @@
"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"
@@ -1330,17 +713,11 @@
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the relationship status."
- },
- "value": {
- "description": "The relationship status. The value can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplicated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilUnion`",
- "type": "string"
}
},
"id": "RelationshipStatus"
},
"BraggingRights": {
- "description": "A person's bragging rights.",
- "type": "object",
"properties": {
"metadata": {
"description": "Metadata about the bragging rights.",
@@ -1351,56 +728,14 @@
"type": "string"
}
},
- "id": "BraggingRights"
+ "id": "BraggingRights",
+ "description": "A person's bragging rights.",
+ "type": "object"
},
"Organization": {
"description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
"type": "object",
"properties": {
- "title": {
- "description": "The person's job title at the organization.",
- "type": "string"
- },
- "location": {
- "description": "The location of the organization office the person works at.",
- "type": "string"
- },
- "current": {
- "description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.",
- "type": "boolean"
- },
- "formattedType": {
- "description": "The read-only type of the organization translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "startDate": {
- "$ref": "Date",
- "description": "The start date when the person joined the organization."
- },
- "domain": {
- "description": "The domain name associated with the organization; for example, `google.com`.",
- "type": "string"
- },
- "department": {
- "description": "The person's department at the organization.",
- "type": "string"
- },
- "type": {
- "description": "The type of the organization. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `work`\n* `school`",
- "type": "string"
- },
- "phoneticName": {
- "description": "The phonetic name of the organization.",
- "type": "string"
- },
- "jobDescription": {
- "description": "The person's job description at the organization.",
- "type": "string"
- },
- "endDate": {
- "$ref": "Date",
- "description": "The end date when the person left the organization."
- },
"symbol": {
"description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
"type": "string"
@@ -1410,19 +745,65 @@
"type": "string"
},
"metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the organization."
+ "description": "Metadata about the organization.",
+ "$ref": "FieldMetadata"
+ },
+ "location": {
+ "description": "The location of the organization office the person works at.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The person's job title at the organization.",
+ "type": "string"
+ },
+ "current": {
+ "description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.",
+ "type": "boolean"
+ },
+ "startDate": {
+ "description": "The start date when the person joined the organization.",
+ "$ref": "Date"
+ },
+ "formattedType": {
+ "description": "The read-only type of the organization translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "The domain name associated with the organization; for example, `google.com`.",
+ "type": "string"
+ },
+ "department": {
+ "description": "The person's department at the organization.",
+ "type": "string"
+ },
+ "phoneticName": {
+ "description": "The phonetic name of the organization.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the organization. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `work`\n* `school`",
+ "type": "string"
+ },
+ "jobDescription": {
+ "description": "The person's job description at the organization.",
+ "type": "string"
+ },
+ "endDate": {
+ "$ref": "Date",
+ "description": "The end date when the person left the organization."
}
},
"id": "Organization"
},
"AgeRangeType": {
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the age range."
- },
"ageRange": {
+ "enum": [
+ "AGE_RANGE_UNSPECIFIED",
+ "LESS_THAN_EIGHTEEN",
+ "EIGHTEEN_TO_TWENTY",
+ "TWENTY_ONE_OR_OLDER"
+ ],
"description": "The age range.",
"type": "string",
"enumDescriptions": [
@@ -1430,13 +811,11 @@
"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": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the age range."
}
},
"id": "AgeRangeType",
@@ -1444,8 +823,6 @@
"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.",
@@ -1468,20 +845,14 @@
"type": "string"
}
},
- "id": "ListContactGroupsResponse"
+ "id": "ListContactGroupsResponse",
+ "description": "The response to a list contact groups request.",
+ "type": "object"
},
"PersonResponse": {
"description": "The response for a single person",
"type": "object",
"properties": {
- "person": {
- "description": "The person.",
- "$ref": "Person"
- },
- "status": {
- "description": "The status of the response.",
- "$ref": "Status"
- },
"httpStatusCode": {
"description": "**DEPRECATED** (Please use status instead)\n\n[HTTP 1.1 status code]\n(http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).",
"format": "int32",
@@ -1490,20 +861,20 @@
"requestedResourceName": {
"description": "The original requested resource name. May be different than the resource\nname on the returned person.\n\nThe resource name can change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or a\nprofile URL.",
"type": "string"
+ },
+ "person": {
+ "description": "The person.",
+ "$ref": "Person"
+ },
+ "status": {
+ "description": "The status of the response.",
+ "$ref": "Status"
}
},
"id": "PersonResponse"
},
"Relation": {
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the relation."
- },
- "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`",
- "type": "string"
- },
"person": {
"description": "The name of the other person this relation refers to.",
"type": "string"
@@ -1511,6 +882,14 @@
"formattedType": {
"description": "The type of the relation translated and formatted in the viewer's account\nlocale or the locale specified in the Accept-Language HTTP header.",
"type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the relation."
+ },
+ "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`",
+ "type": "string"
}
},
"id": "Relation",
@@ -1518,33 +897,22 @@
"type": "object"
},
"Occupation": {
- "description": "A person's occupation.",
- "type": "object",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the occupation."
- },
"value": {
"description": "The occupation; for example, `carpenter`.",
"type": "string"
- }
- },
- "id": "Occupation"
- },
- "ContactGroup": {
- "description": "A contact group.",
- "type": "object",
- "properties": {
- "memberCount": {
- "description": "The total number of contacts in the group irrespective of max members in\nspecified in the request.",
- "format": "int32",
- "type": "integer"
},
"metadata": {
- "$ref": "ContactGroupMetadata",
- "description": "Metadata about the contact group."
- },
+ "description": "Metadata about the occupation.",
+ "$ref": "FieldMetadata"
+ }
+ },
+ "id": "Occupation",
+ "description": "A person's occupation.",
+ "type": "object"
+ },
+ "ContactGroup": {
+ "properties": {
"resourceName": {
"description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`\u003cvar\u003econtact_group_id\u003c/var\u003e.",
"type": "string"
@@ -1581,34 +949,25 @@
"items": {
"type": "string"
}
+ },
+ "memberCount": {
+ "description": "The total number of contacts in the group irrespective of max members in\nspecified in the request.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "metadata": {
+ "description": "Metadata about the contact group.",
+ "$ref": "ContactGroupMetadata"
}
},
- "id": "ContactGroup"
+ "id": "ContactGroup",
+ "description": "A contact group.",
+ "type": "object"
},
"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": {
- "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"
- }
- },
- "resourceName": {
- "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
- "type": "string"
- },
"interests": {
"description": "The person's interests.",
"type": "array",
@@ -1616,6 +975,10 @@
"$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",
@@ -1758,13 +1121,6 @@
"$ref": "Nickname"
}
},
- "names": {
- "description": "The person's names.",
- "type": "array",
- "items": {
- "$ref": "Name"
- }
- },
"relations": {
"description": "The person's relations.",
"type": "array",
@@ -1772,6 +1128,13 @@
"$ref": "Relation"
}
},
+ "names": {
+ "description": "The person's names.",
+ "type": "array",
+ "items": {
+ "$ref": "Name"
+ }
+ },
"occupations": {
"description": "The person's occupations.",
"type": "array",
@@ -1803,11 +1166,27 @@
"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"
+ }
}
},
- "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"
+ "id": "Person"
},
"UpdateContactGroupRequest": {
"description": "A request to update an existing contact group. Only the name can be updated.",
@@ -1821,8 +1200,6 @@
"id": "UpdateContactGroupRequest"
},
"ContactGroupMetadata": {
- "description": "The read-only metadata about a contact group.",
- "type": "object",
"properties": {
"updateTime": {
"description": "The time the group was last updated.",
@@ -1834,7 +1211,9 @@
"type": "boolean"
}
},
- "id": "ContactGroupMetadata"
+ "id": "ContactGroupMetadata",
+ "description": "The read-only metadata about a contact group.",
+ "type": "object"
},
"Residence": {
"description": "A person's past or current residence.",
@@ -1856,15 +1235,9 @@
"id": "Residence"
},
"Event": {
+ "description": "An event related to the person.",
+ "type": "object",
"properties": {
- "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"
- },
"date": {
"description": "The date of the event.",
"$ref": "Date"
@@ -1872,15 +1245,19 @@
"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": {
+ "$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"
}
},
- "id": "Event",
- "description": "An event related to the person.",
- "type": "object"
+ "id": "Event"
},
"ModifyContactGroupMembersResponse": {
- "description": "The response to a modify contact group members request.",
- "type": "object",
"properties": {
"notFoundResourceNames": {
"description": "The contact people resource names that were not found.",
@@ -1890,11 +1267,11 @@
}
}
},
- "id": "ModifyContactGroupMembersResponse"
+ "id": "ModifyContactGroupMembersResponse",
+ "description": "The response to a modify contact group members request.",
+ "type": "object"
},
"ProfileMetadata": {
- "description": "The read-only metadata about a profile.",
- "type": "object",
"properties": {
"objectType": {
"enumDescriptions": [
@@ -1911,31 +1288,37 @@
"type": "string"
},
"userTypes": {
- "enumDescriptions": [
- "The user type is not known.",
- "The user is a Google user.",
- "The user is a Google+ user.",
- "The user is a Google Apps for Work user."
- ],
"description": "The user types.",
"type": "array",
"items": {
- "type": "string",
"enum": [
"USER_TYPE_UNKNOWN",
"GOOGLE_USER",
"GPLUS_USER",
"GOOGLE_APPS_USER"
- ]
- }
+ ],
+ "type": "string"
+ },
+ "enumDescriptions": [
+ "The user type is not known.",
+ "The user is a Google user.",
+ "The user is a Google+ user.",
+ "The user is a Google Apps for Work user."
+ ]
}
},
- "id": "ProfileMetadata"
+ "id": "ProfileMetadata",
+ "description": "The read-only metadata about a profile.",
+ "type": "object"
},
"Gender": {
"description": "A person's gender.",
"type": "object",
"properties": {
+ "value": {
+ "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfollowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
+ "type": "string"
+ },
"formattedValue": {
"description": "The read-only value of the gender translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
"type": "string"
@@ -1943,34 +1326,32 @@
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the gender."
- },
- "value": {
- "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfollowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
- "type": "string"
}
},
"id": "Gender"
},
"CoverPhoto": {
- "description": "A person's read-only cover photo. A large image shown on the person's\nprofile page that represents who they are or what they care about.",
- "type": "object",
"properties": {
"url": {
"description": "The URL of the cover photo.",
"type": "string"
},
"metadata": {
- "description": "Metadata about the cover photo.",
- "$ref": "FieldMetadata"
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the cover photo."
},
"default": {
"description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.",
"type": "boolean"
}
},
- "id": "CoverPhoto"
+ "id": "CoverPhoto",
+ "description": "A person's read-only cover photo. A large image shown on the person's\nprofile page that represents who they are or what they care about.",
+ "type": "object"
},
"Interest": {
+ "description": "One of the person's interests.",
+ "type": "object",
"properties": {
"metadata": {
"description": "Metadata about the interest.",
@@ -1981,14 +1362,633 @@
"type": "string"
}
},
- "id": "Interest",
- "description": "One of the person's interests.",
+ "id": "Interest"
+ },
+ "EmailAddress": {
+ "description": "A person's email address.",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "The display name of the email.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the email address.",
+ "$ref": "FieldMetadata"
+ },
+ "type": {
+ "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
+ "type": "string"
+ },
+ "value": {
+ "description": "The email address.",
+ "type": "string"
+ },
+ "formattedType": {
+ "description": "The read-only type of the email address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ }
+ },
+ "id": "EmailAddress"
+ },
+ "Nickname": {
+ "properties": {
+ "value": {
+ "description": "The nickname.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the nickname.",
+ "$ref": "FieldMetadata"
+ },
+ "type": {
+ "enum": [
+ "DEFAULT",
+ "MAIDEN_NAME",
+ "INITIALS",
+ "GPLUS",
+ "OTHER_NAME"
+ ],
+ "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.",
+ "Initials.",
+ "Google+ profile nickname.",
+ "A professional affiliation or other name; for example, `Dr. Smith.`"
+ ]
+ }
+ },
+ "id": "Nickname",
+ "description": "A person's nickname.",
"type": "object"
+ },
+ "Skill": {
+ "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"
+ }
+ },
+ "id": "Skill"
+ },
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "id": "Date"
+ },
+ "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": {
+ "honorificPrefix": {
+ "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
+ "type": "string"
+ },
+ "phoneticHonorificSuffix": {
+ "description": "The honorific suffixes spelled as they sound.",
+ "type": "string"
+ },
+ "givenName": {
+ "description": "The given name.",
+ "type": "string"
+ },
+ "middleName": {
+ "description": "The middle name(s).",
+ "type": "string"
+ },
+ "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"
+ },
+ "metadata": {
+ "description": "Metadata about the name.",
+ "$ref": "FieldMetadata"
+ },
+ "phoneticMiddleName": {
+ "description": "The middle name(s) spelled as they sound.",
+ "type": "string"
+ },
+ "phoneticFullName": {
+ "description": "The full name spelled as it sounds.",
+ "type": "string"
+ },
+ "displayNameLastFirst": {
+ "description": "The read-only display name with the last name first formatted according to\nthe locale specified by the viewer's account or the\n`Accept-Language` HTTP header.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the `Accept-Language` HTTP header.",
+ "type": "string"
+ },
+ "honorificSuffix": {
+ "description": "The honorific suffixes, such as `Jr.`",
+ "type": "string"
+ }
+ },
+ "id": "Name"
+ },
+ "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": {
+ "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",
+ "description": "Arbitrary user data that is populated by the end users.",
+ "type": "object"
+ },
+ "Biography": {
+ "description": "A person's short biography.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The short biography.",
+ "type": "string"
+ },
+ "contentType": {
+ "enum": [
+ "CONTENT_TYPE_UNSPECIFIED",
+ "TEXT_PLAIN",
+ "TEXT_HTML"
+ ],
+ "description": "The content type of the biography.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Plain text.",
+ "HTML text."
+ ]
+ },
+ "metadata": {
+ "description": "Metadata about the biography.",
+ "$ref": "FieldMetadata"
+ }
+ },
+ "id": "Biography"
+ },
+ "FieldMetadata": {
+ "description": "Metadata about a field.",
+ "type": "object",
+ "properties": {
+ "primary": {
+ "description": "True if the field is the primary field; false if the field is a secondary\nfield.",
+ "type": "boolean"
+ },
+ "source": {
+ "description": "The source of the field.",
+ "$ref": "Source"
+ },
+ "verified": {
+ "description": "True if the field is verified; false if the field is unverified. A\nverified field is typically a name, email address, phone number, or\nwebsite that has been confirmed to be owned by the person.",
+ "type": "boolean"
+ }
+ },
+ "id": "FieldMetadata"
+ },
+ "RelationshipInterest": {
+ "description": "A person's read-only relationship interest .",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "Source": {
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "Source",
+ "description": "The source of a field.",
+ "type": "object"
+ },
+ "GetPeopleResponse": {
+ "type": "object",
+ "properties": {
+ "responses": {
+ "description": "The response for each requested resource name.",
+ "type": "array",
+ "items": {
+ "$ref": "PersonResponse"
+ }
+ }
+ },
+ "id": "GetPeopleResponse"
+ },
+ "PhoneNumber": {
+ "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",
+ "description": "A person's phone number.",
+ "type": "object"
+ },
+ "Photo": {
+ "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the photo."
+ },
+ "default": {
+ "description": "True if the photo is a default photo;\nfalse if the photo is a user-provided photo.",
+ "type": "boolean"
+ },
+ "url": {
+ "description": "The URL of the photo. You can change the desired size by appending a query\nparameter `sz=`\u003cvar\u003esize\u003c/var\u003e at the end of the url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`",
+ "type": "string"
+ }
+ },
+ "id": "Photo"
+ },
+ "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": {
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the birthday."
+ },
+ "text": {
+ "description": "A free-form string representing the user's birthday.",
+ "type": "string"
+ },
+ "date": {
+ "$ref": "Date",
+ "description": "The date of the birthday."
+ }
+ },
+ "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": {
+ "description": "The contact group to create.",
+ "$ref": "ContactGroup"
+ }
+ },
+ "id": "CreateContactGroupRequest",
+ "description": "A request to create a new contact group.",
+ "type": "object"
+ },
+ "Address": {
+ "properties": {
+ "poBox": {
+ "description": "The P.O. box of the address.",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "The postal code of the address.",
+ "type": "string"
+ },
+ "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."
+ },
+ "countryCode": {
+ "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
+ "type": "string"
+ },
+ "formattedType": {
+ "description": "The read-only type of the address translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "city": {
+ "description": "The city of the address.",
+ "type": "string"
+ },
+ "formattedValue": {
+ "description": "The unstructured value of the address. If this is not set by the user it\nwill be automatically constructed from structured values.",
+ "type": "string"
+ },
+ "country": {
+ "description": "The country of the address.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the 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"
+ },
+ "extendedAddress": {
+ "description": "The extended address of the address; for example, the apartment number.",
+ "type": "string"
+ }
+ },
+ "id": "Address",
+ "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
+ "type": "object"
+ },
+ "ContactGroupMembership": {
+ "properties": {
+ "contactGroupId": {
+ "description": "The contact group ID for the contact group membership. The contact group\nID can be custom or predefined. Possible values include, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\n* A numerical ID for user-created groups.",
+ "type": "string"
+ }
+ },
+ "id": "ContactGroupMembership",
+ "description": "A Google contact group membership.",
+ "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"
+ },
+ "PersonMetadata": {
+ "description": "The read-only metadata about a person.",
+ "type": "object",
+ "properties": {
+ "linkedPeopleResourceNames": {
+ "description": "Resource names of people linked to this resource.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "sources": {
+ "description": "The sources of data for the person.",
+ "type": "array",
+ "items": {
+ "$ref": "Source"
+ }
+ },
+ "previousResourceNames": {
+ "description": "Any former resource names this person has had. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.\n\nThe resource name may change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or\nprofile URL.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deleted": {
+ "description": "True if the person resource has been deleted. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.",
+ "type": "boolean"
+ },
+ "objectType": {
+ "enum": [
+ "OBJECT_TYPE_UNSPECIFIED",
+ "PERSON",
+ "PAGE"
+ ],
+ "description": "**DEPRECATED** (Please use\n`person.metadata.sources.profileMetadata.objectType` instead)\n\nThe type of the person object.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Person.",
+ "[Google+ Page.](http://www.google.com/+/brands/)"
+ ]
+ }
+ },
+ "id": "PersonMetadata"
}
},
"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"
+ "protocol": "rest",
+ "canonicalName": "People Service",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/plus.login": {
+ "description": "Know the list of people in your circles, your age range, and language"
+ },
+ "https://www.googleapis.com/auth/userinfo.profile": {
+ "description": "View your basic profile info"
+ },
+ "https://www.googleapis.com/auth/user.emails.read": {
+ "description": "View your email addresses"
+ },
+ "https://www.googleapis.com/auth/contacts": {
+ "description": "Manage your contacts"
+ },
+ "https://www.googleapis.com/auth/user.addresses.read": {
+ "description": "View your street addresses"
+ },
+ "https://www.googleapis.com/auth/user.phonenumbers.read": {
+ "description": "View your phone numbers"
+ },
+ "https://www.googleapis.com/auth/userinfo.email": {
+ "description": "View your email address"
+ },
+ "https://www.googleapis.com/auth/user.birthday.read": {
+ "description": "View your complete date of birth"
+ },
+ "https://www.googleapis.com/auth/contacts.readonly": {
+ "description": "View your contacts"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://people.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "people",
+ "batchPath": "batch"
}
diff --git a/poly/v1/poly-api.json b/poly/v1/poly-api.json
index 2b77f88..bacf99b 100644
--- a/poly/v1/poly-api.json
+++ b/poly/v1/poly-api.json
@@ -1,64 +1,322 @@
{
- "schemas": {
- "ListUserAssetsResponse": {
- "type": "object",
- "properties": {
- "userAssets": {
- "description": "A list of UserAssets matching the request.",
- "type": "array",
- "items": {
- "$ref": "UserAsset"
+ "rootUrl": "https://poly.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "poly",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Poly API",
+ "ownerName": "Google",
+ "resources": {
+ "assets": {
+ "methods": {
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Asset"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^assets/[^/]+$",
+ "location": "path",
+ "description": "Required. An asset's name in the form `assets/{ASSET_ID}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/assets/{assetsId}",
+ "id": "poly.assets.get",
+ "path": "v1/{+name}",
+ "description": "Returns detailed information about an asset given its name.\nPRIVATE assets are returned only if\n the currently authenticated user (via OAuth token) is the author of the asset."
+ },
+ "list": {
+ "description": "Lists all public, remixable assets. These are assets with an access level of\nPUBLIC and published under the\nCC-By license.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListAssetsResponse"
+ },
+ "parameterOrder": [],
+ "parameters": {
+ "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"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of assets to be returned. This value must be between `1`\nand `100`. Defaults to `20`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "keywords": {
+ "description": "One or more search terms to be matched against all text that Poly has\nindexed for assets, which includes display_name,\ndescription, and tags. Multiple keywords should be\nseparated by spaces.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets\nbased on a combination of popularity and other features.",
+ "type": "string",
+ "location": "query"
+ },
+ "format": {
+ "location": "query",
+ "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.",
+ "type": "string"
+ },
+ "curated": {
+ "location": "query",
+ "description": "Return only assets that have been curated by the Poly team.",
+ "type": "boolean"
+ },
+ "category": {
+ "location": "query",
+ "description": "Filter assets based on the specified category. Supported values are:\n`animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, `scenes`,\n`technology`, and `transport`.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/assets",
+ "id": "poly.assets.list",
+ "path": "v1/assets"
+ }
+ }
+ },
+ "users": {
+ "resources": {
+ "likedassets": {
+ "methods": {
+ "list": {
+ "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.",
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+$",
+ "location": "path"
+ },
+ "orderBy": {
+ "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`, 'LIKED_TIME'. Defaults to `LIKED_TIME`, which\nranks assets based on how recently they were liked.",
+ "type": "string",
+ "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"
+ },
+ "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",
+ "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."
+ }
}
},
- "nextPageToken": {
- "type": "string",
- "description": "The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token."
- },
- "totalSize": {
- "description": "The total number of assets in the list, without pagination.",
- "format": "int32",
- "type": "integer"
+ "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": {
+ "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": {
+ "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"
+ },
+ "visibility": {
+ "enum": [
+ "VISIBILITY_UNSPECIFIED",
+ "PUBLISHED",
+ "PRIVATE"
+ ],
+ "description": "The visibility of the assets to be returned.\nDefaults to VISIBILITY_UNSPECIFIED which returns all assets.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "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`, and `TILT`.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/users/{usersId}/assets"
+ }
+ }
}
- },
- "id": "ListUserAssetsResponse",
- "description": "A response message from a request to list."
+ }
+ }
+ },
+ "parameters": {
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
},
- "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"
+ "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": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "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://poly.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "The Poly API provides read-only access to assets hosted on \u003ca href=\"https://poly.google.com\"\u003epoly.google.com\u003c/a\u003e.\n",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20180114",
+ "documentationLink": "https://developers.google.com/poly/",
+ "id": "poly:v1",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
"UserAsset": {
- "description": "Data about the user's asset.",
- "type": "object",
"properties": {
"asset": {
"$ref": "Asset",
"description": "An Asset."
}
},
- "id": "UserAsset"
+ "id": "UserAsset",
+ "description": "Data about the user's asset.",
+ "type": "object"
},
"File": {
"description": "Represents a file in Poly, which can be a root,\nresource, or thumbnail file.",
"type": "object",
"properties": {
- "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"
@@ -66,13 +324,15 @@
"contentType": {
"description": "The MIME content-type, such as `image/png`.\nFor more information, see\n[MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).",
"type": "string"
+ },
+ "relativePath": {
+ "description": "The path of the resource file relative to the root file.\nFor root or thumbnail files, this is just the filename.",
+ "type": "string"
}
},
"id": "File"
},
"ListLikedAssetsResponse": {
- "description": "A response message from a request to list.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token.",
@@ -91,7 +351,9 @@
"type": "integer"
}
},
- "id": "ListLikedAssetsResponse"
+ "id": "ListLikedAssetsResponse",
+ "description": "A response message from a request to list.",
+ "type": "object"
},
"ListAssetsResponse": {
"description": "A response message from a request to list.",
@@ -117,8 +379,6 @@
"id": "ListAssetsResponse"
},
"Format": {
- "description": "The same asset can be represented in different formats, for example,\na [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its\ncorresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file\nwith its corresponding .glb binary data. A format refers to a specific\nrepresentation of an asset and contains all information needed to\nretrieve and describe this representation.",
- "type": "object",
"properties": {
"resources": {
"description": "A list of dependencies of the root element. May include, but is not\nlimited to, materials, textures, and shader programs.",
@@ -128,8 +388,8 @@
}
},
"formatComplexity": {
- "description": "Complexity stats about this representation of the asset.",
- "$ref": "FormatComplexity"
+ "$ref": "FormatComplexity",
+ "description": "Complexity stats about this representation of the asset."
},
"root": {
"$ref": "File",
@@ -140,12 +400,37 @@
"type": "string"
}
},
- "id": "Format"
+ "id": "Format",
+ "description": "The same asset can be represented in different formats, for example,\na [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its\ncorresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file\nwith its corresponding .glb binary data. A format refers to a specific\nrepresentation of an asset and contains all information needed to\nretrieve and describe this representation.",
+ "type": "object"
},
"Asset": {
"description": "Represents and describes an asset in the Poly library. An asset is a 3D model\nor scene created using [Tilt Brush](//www.tiltbrush.com),\n[Blocks](//vr.google.com/blocks/), or any 3D program that produces a file\nthat can be upload to Poly.",
"type": "object",
"properties": {
+ "license": {
+ "enum": [
+ "UNKNOWN",
+ "CREATIVE_COMMONS_BY",
+ "ALL_RIGHTS_RESERVED"
+ ],
+ "description": "The license under which the author has made the asset available\nfor use, if any.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown license value.",
+ "Creative Commons CC-BY 3.0. https://creativecommons.org/licenses/by/3.0/",
+ "Unlicensed: All Rights Reserved by the author. Unlicensed assets are\n**not** returned by List Assets."
+ ]
+ },
+ "updateTime": {
+ "description": "The time when the asset was last modified. For published assets, whose\ncontents are immutable, the update time changes only when metadata\nproperties, such as visibility, are updated.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "isCurated": {
+ "description": "Whether this asset has been curated by the Poly team.",
+ "type": "boolean"
+ },
"formats": {
"description": "A list of Formats where each\nformat describes one representation of the asset.",
"type": "array",
@@ -166,6 +451,12 @@
"type": "string"
},
"visibility": {
+ "enum": [
+ "VISIBILITY_UNSPECIFIED",
+ "PRIVATE",
+ "UNLISTED",
+ "PUBLIC"
+ ],
"description": "The visibility of the asset and who can access it.",
"type": "string",
"enumDescriptions": [
@@ -173,12 +464,6 @@
"Access to the asset and its underlying files and resources is restricted to\nthe author.\n**Authentication:** You must supply an OAuth token that corresponds to the\nauthor's account.",
"Access to the asset and its underlying files and resources is available to\nanyone with the asset's name. Unlisted assets are **not**\nreturned by List Assets.",
"Access to the asset and its underlying files and resources is available\nto anyone."
- ],
- "enum": [
- "VISIBILITY_UNSPECIFIED",
- "PRIVATE",
- "UNLISTED",
- "PUBLIC"
]
},
"authorName": {
@@ -197,29 +482,6 @@
"description": "For published assets, the time when the asset was published.\nFor unpublished assets, the time when the asset was created.",
"format": "google-datetime",
"type": "string"
- },
- "license": {
- "description": "The license under which the author has made the asset available\nfor use, if any.",
- "type": "string",
- "enumDescriptions": [
- "Unknown license value.",
- "Creative Commons CC-BY 3.0. https://creativecommons.org/licenses/by/3.0/",
- "Unlicensed: All Rights Reserved by the author. Unlicensed assets are\n**not** returned by List Assets."
- ],
- "enum": [
- "UNKNOWN",
- "CREATIVE_COMMONS_BY",
- "ALL_RIGHTS_RESERVED"
- ]
- },
- "updateTime": {
- "description": "The time when the asset was last modified. For published assets, whose\ncontents are immutable, the update time changes only when metadata\nproperties, such as visibility, are updated.",
- "format": "google-datetime",
- "type": "string"
- },
- "isCurated": {
- "description": "Whether this asset has been curated by the Poly team.",
- "type": "boolean"
}
},
"id": "Asset"
@@ -250,13 +512,7 @@
"id": "PresentationParams"
},
"Quaternion": {
- "type": "object",
"properties": {
- "w": {
- "description": "The scalar component.",
- "format": "double",
- "type": "number"
- },
"y": {
"description": "The y component.",
"format": "double",
@@ -271,318 +527,62 @@
"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."
+ "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"
+ },
+ "ListUserAssetsResponse": {
+ "properties": {
+ "userAssets": {
+ "description": "A list of UserAssets matching the request.",
+ "type": "array",
+ "items": {
+ "$ref": "UserAsset"
+ }
+ },
+ "nextPageToken": {
+ "description": "The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token.",
+ "type": "string"
+ },
+ "totalSize": {
+ "description": "The total number of assets in the list, without pagination.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ListUserAssetsResponse",
+ "description": "A response message from a request to list.",
+ "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"
}
},
+ "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": "Poly Service",
- "rootUrl": "https://poly.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "poly",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Poly API",
- "ownerName": "Google",
- "resources": {
- "assets": {
- "methods": {
- "get": {
- "description": "Returns detailed information about an asset given its name.\nPRIVATE assets are returned only if\n the currently authenticated user (via OAuth token) is the author of the asset.",
- "response": {
- "$ref": "Asset"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Required. An asset's name in the form `assets/{ASSET_ID}`.",
- "required": true,
- "type": "string",
- "pattern": "^assets/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/assets/{assetsId}",
- "path": "v1/{+name}",
- "id": "poly.assets.get"
- },
- "list": {
- "path": "v1/assets",
- "id": "poly.assets.list",
- "description": "Lists all public, remixable assets. These are assets with an access level of\nPUBLIC and published under the\nCC-By license.",
- "response": {
- "$ref": "ListAssetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "category": {
- "location": "query",
- "description": "Filter assets based on the specified category. Supported values are:\n`animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, `scenes`,\n`technology`, and `transport`.",
- "type": "string"
- },
- "maxComplexity": {
- "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",
- "enum": [
- "COMPLEXITY_UNSPECIFIED",
- "COMPLEX",
- "MEDIUM",
- "SIMPLE"
- ]
- },
- "pageToken": {
- "description": "Specifies a continuation token from a previous search whose results were\nsplit into multiple pages. To get the next page, submit the same request\nspecifying the value from next_page_token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of assets to be returned. This value must be between `1`\nand `100`. Defaults to `20`.",
- "format": "int32",
- "type": "integer"
- },
- "keywords": {
- "description": "One or more search terms to be matched against all text that Poly has\nindexed for assets, which includes display_name,\ndescription, and tags. Multiple keywords should be\nseparated by spaces.",
- "type": "string",
- "location": "query"
- },
- "orderBy": {
- "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets\nbased on a combination of popularity and other features.",
- "type": "string",
- "location": "query"
- },
- "format": {
- "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.",
- "type": "string",
- "location": "query"
- },
- "curated": {
- "location": "query",
- "description": "Return only assets that have been curated by the Poly team.",
- "type": "boolean"
- }
- },
- "flatPath": "v1/assets"
- }
- }
- },
- "users": {
- "resources": {
- "likedassets": {
- "methods": {
- "list": {
- "flatPath": "v1/users/{usersId}/likedassets",
- "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",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListLikedAssetsResponse"
- },
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+$",
- "location": "path",
- "description": "A valid user id. Currently, only the special value 'me', representing the\ncurrently-authenticated user is supported. To use 'me', you must pass\nan OAuth token with the request."
- },
- "orderBy": {
- "location": "query",
- "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`, 'LIKED_TIME'. Defaults to `LIKED_TIME`, which\nranks assets based on how recently they were liked.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a continuation token from a previous search whose results were\nsplit into multiple pages. To get the next page, submit the same request\nspecifying the value from\nnext_page_token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of assets to be returned. This value must be between `1`\nand `100`. Defaults to `20`.",
- "format": "int32",
- "type": "integer"
- },
- "format": {
- "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.",
- "type": "string",
- "location": "query"
- }
- }
- }
- }
- },
- "assets": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListUserAssetsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Specifies a continuation token from a previous search whose results were\nsplit into multiple pages. To get the next page, submit the same request\nspecifying the value from\nnext_page_token.",
- "type": "string"
- },
- "pageSize": {
- "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"
- },
- "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"
- },
- "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"
- },
- "name": {
- "description": "A valid user id. Currently, only the special value 'me', representing the\ncurrently-authenticated user is supported. To use 'me', you must pass\nan OAuth token with the request.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+$",
- "location": "path"
- },
- "format": {
- "location": "query",
- "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.",
- "type": "string"
- }
- },
- "flatPath": "v1/users/{usersId}/assets",
- "id": "poly.users.assets.list",
- "path": "v1/{+name}/assets",
- "description": "Lists assets authored by the given user. Only the value 'me', representing\nthe currently-authenticated user, is supported. May include assets with an\naccess level of PRIVATE or\nUNLISTED and assets which are\nAll Rights Reserved for the\ncurrently-authenticated user."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "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": {
- "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://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",
- "basePath": "",
- "documentationLink": "https://developers.google.com/poly/",
- "revision": "20180114",
- "id": "poly:v1",
- "discoveryVersion": "v1",
- "version_module": true
+ "canonicalName": "Poly Service"
}
diff --git a/proximitybeacon/v1beta1/proximitybeacon-api.json b/proximitybeacon/v1beta1/proximitybeacon-api.json
index fcbcf8f..7ebad4d 100644
--- a/proximitybeacon/v1beta1/proximitybeacon-api.json
+++ b/proximitybeacon/v1beta1/proximitybeacon-api.json
@@ -1,38 +1,8 @@
{
- "version": "v1beta1",
- "baseUrl": "https://proximitybeacon.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/userlocation.beacon.registry": {
- "description": "View and modify your beacons"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "servicePath": "",
- "description": "Registers, manages, indexes, and searches beacons.",
- "rootUrl": "https://proximitybeacon.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "proximitybeacon",
- "batchPath": "batch",
- "revision": "20180117",
- "documentationLink": "https://developers.google.com/beacons/proximity/",
- "id": "proximitybeacon:v1beta1",
- "title": "Google Proximity Beacon API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "version_module": true,
"resources": {
"beaconinfo": {
"methods": {
"getforobserved": {
- "description": "Given one or more beacon observations, returns any beacon information\nand attachments accessible to your application. Authorize by using the\n[API key](https://developers.google.com/beacons/proximity/get-started#request_a_browser_api_key)\nfor the application.",
- "request": {
- "$ref": "GetInfoForObservedBeaconsRequest"
- },
"response": {
"$ref": "GetInfoForObservedBeaconsResponse"
},
@@ -41,24 +11,22 @@
"parameters": {},
"flatPath": "v1beta1/beaconinfo:getforobserved",
"path": "v1beta1/beaconinfo:getforobserved",
- "id": "proximitybeacon.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": {
- "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.",
"response": {
"$ref": "ListNamespacesResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
"parameters": {
"projectId": {
"location": "query",
@@ -66,23 +34,29 @@
"type": "string"
}
},
- "flatPath": "v1beta1/namespaces"
+ "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": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "namespaceName"
- ],
"response": {
"$ref": "Namespace"
},
+ "parameterOrder": [
+ "namespaceName"
+ ],
+ "httpMethod": "PUT",
"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"
+ "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.",
@@ -94,8 +68,8 @@
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
"flatPath": "v1beta1/namespaces/{namespacesId}",
- "id": "proximitybeacon.namespaces.update",
"path": "v1beta1/{+namespaceName}",
+ "id": "proximitybeacon.namespaces.update",
"request": {
"$ref": "Namespace"
},
@@ -106,402 +80,24 @@
"v1beta1": {
"methods": {
"getEidparams": {
- "httpMethod": "GET",
- "parameterOrder": [],
+ "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"
],
"flatPath": "v1beta1/eidparams",
- "id": "proximitybeacon.getEidparams",
"path": "v1beta1/eidparams",
- "description": "Gets the Proximity Beacon API's current public key and associated\nparameters used to initiate the Diffie-Hellman key exchange required to\nregister a beacon that broadcasts the Eddystone-EID format. This key\nchanges periodically; clients may cache it and re-use the same public key\nto provision and register multiple beacons. However, clients should be\nprepared to refresh this key when they encounter an error registering an\nEddystone-EID beacon."
+ "id": "proximitybeacon.getEidparams"
}
}
},
"beacons": {
- "resources": {
- "diagnostics": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListDiagnosticsResponse"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "beaconName": {
- "description": "Beacon that the diagnostics are for.",
- "required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional.",
- "type": "string"
- },
- "pageSize": {
- "description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "alertFilter": {
- "enum": [
- "ALERT_UNSPECIFIED",
- "WRONG_LOCATION",
- "LOW_BATTERY",
- "LOW_ACTIVITY"
- ],
- "description": "Requests only beacons that have the given alert. For example, to find\nbeacons that have low batteries use `alert_filter=LOW_BATTERY`.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "description": "Requests only diagnostic records for the given project id. If not set,\nthen the project making the request will be used for looking up\ndiagnostic records. Optional.",
- "type": "string",
- "location": "query"
- }
- },
- "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."
- }
- }
- },
- "attachments": {
- "methods": {
- "create": {
- "description": "Associates the given data with the specified beacon. Attachment data must\ncontain two parts:\n\u003cul\u003e\n\u003cli\u003eA namespaced type.\u003c/li\u003e\n\u003cli\u003eThe actual attachment data itself.\u003c/li\u003e\n\u003c/ul\u003e\nThe namespaced type consists of two parts, the namespace and the type.\nThe namespace must be one of the values returned by the `namespaces`\nendpoint, while the type can be a string of any characters except for the\nforward slash (`/`) up to 100 characters in length.\n\nAttachment data can be up to 1024 bytes long.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "request": {
- "$ref": "BeaconAttachment"
- },
- "response": {
- "$ref": "BeaconAttachment"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "beaconName": {
- "description": "Beacon on which the attachment should be created. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$",
- "location": "path"
- },
- "projectId": {
- "location": "query",
- "description": "The project id of the project the attachment will belong to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.",
- "type": "string"
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
- "path": "v1beta1/{+beaconName}/attachments",
- "id": "proximitybeacon.beacons.attachments.create"
- },
- "batchDelete": {
- "id": "proximitybeacon.beacons.attachments.batchDelete",
- "path": "v1beta1/{+beaconName}/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",
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "DeleteAttachmentsResponse"
- },
- "parameters": {
- "namespacedType": {
- "description": "Specifies the namespace and type of attachments to delete in\n`namespace/type` format. Accepts `*/*` to specify\n\"all types in all namespaces\".\nOptional.",
- "type": "string",
- "location": "query"
- },
- "beaconName": {
- "description": "The beacon whose attachments should be deleted. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$",
- "location": "path"
- },
- "projectId": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments:batchDelete"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "attachmentName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "attachmentName": {
- "pattern": "^beacons/[^/]+/attachments/[^/]+$",
- "location": "path",
- "description": "The attachment name (`attachmentName`) of\nthe attachment to remove. For example:\n`beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For\nEddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the\nbeacon's current EID, or its \"stable\" Eddystone-UID.\nRequired.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "query",
- "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
- "type": "string"
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments/{attachmentsId}",
- "path": "v1beta1/{+attachmentName}",
- "id": "proximitybeacon.beacons.attachments.delete",
- "description": "Deletes the specified attachment for the given beacon. Each attachment has\na unique attachment name (`attachmentName`) which is returned when you\nfetch the attachment data via this API. You specify this with the delete\nrequest to control which attachment is removed. This operation cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
- },
- "list": {
- "response": {
- "$ref": "ListBeaconAttachmentsResponse"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "beaconName": {
- "pattern": "^beacons/[^/]+$",
- "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"
- },
- "projectId": {
- "location": "query",
- "description": "The project id to list beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
- "type": "string"
- },
- "namespacedType": {
- "description": "Specifies the namespace and type of attachment to include in response in\n\u003cvar\u003enamespace/type\u003c/var\u003e format. Accepts `*/*` to specify\n\"all types in all namespaces\".",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
- "path": "v1beta1/{+beaconName}/attachments",
- "id": "proximitybeacon.beacons.attachments.list",
- "description": "Returns the attachments for the specified beacon that match the specified\nnamespaced-type pattern.\n\nTo control which namespaced types are returned, you add the\n`namespacedType` query parameter to the request. You must either use\n`*/*`, to return all attachments, or the namespace must be one of\nthe ones returned from the `namespaces` endpoint.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project."
- }
- }
- }
- },
"methods": {
- "activate": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "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"
- },
- "projectId": {
- "description": "The project id of the beacon to activate. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "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": {
- "response": {
- "$ref": "Beacon"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "beaconName": {
- "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$",
- "location": "path"
- },
- "projectId": {
- "location": "query",
- "description": "The project id of the beacon to request. If the project id is not specified\nthen the project making the request is used. The project id must match the\nproject that owns the beacon.\nOptional.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}",
- "path": "v1beta1/{+beaconName}",
- "id": "proximitybeacon.beacons.get",
- "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."
- },
- "update": {
- "description": "Updates the information about the specified beacon. **Any field that you do\nnot populate in the submitted beacon will be permanently erased**, so you\nshould follow the \"read, modify, write\" pattern to avoid inadvertently\ndestroying data.\n\nChanges to the beacon status via this method will be silently ignored.\nTo update beacon status, use the separate methods on this API for\nactivation, deactivation, and decommissioning.\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "request": {
- "$ref": "Beacon"
- },
- "response": {
- "$ref": "Beacon"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "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.",
- "required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$",
- "location": "path"
- },
- "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"
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}",
- "path": "v1beta1/{+beaconName}",
- "id": "proximitybeacon.beacons.update"
- },
- "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",
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "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"
- },
- "projectId": {
- "description": "The project id of the beacon to decommission. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}:decommission"
- },
- "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.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "beaconName": {
- "description": "Beacon that should be deleted. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "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": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}",
- "id": "proximitybeacon.beacons.delete",
- "path": "v1beta1/{+beaconName}"
- },
- "deactivate": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "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.",
- "required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$",
- "location": "path"
- },
- "projectId": {
- "location": "query",
- "description": "The project id of the beacon to deactivate. If the project id is not\nspecified then the project making the request is used. The project id must\nmatch the project that owns the beacon.\nOptional.",
- "type": "string"
- }
- },
- "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."
- },
"list": {
"response": {
"$ref": "ListBeaconsResponse"
@@ -512,26 +108,26 @@
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
"parameters": {
+ "q": {
+ "location": "query",
+ "description": "Filter query string that supports the following field filters:\n\n* **description:`\"\u003cstring\u003e\"`**\n For example: **description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string must be double-quoted.\n* **status:`\u003cenum\u003e`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of the Beacon.Status enum values (case insensitive). Accepts\n multiple filters which will be combined with OR logic.\n* **stability:`\u003cenum\u003e`**\n For example: **stability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insensitive). Accepts multiple filters which will be combined with\n OR logic.\n* **place\\_id:`\"\u003cstring\u003e\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"**\n Returns beacons explicitly registered at the given place, expressed as\n a Place ID obtained from [Google Places API](/places/place-id). Does not\n match places inside the given place. Does not consider the beacon's\n actual location (which may be different from its registered place).\n Accepts multiple filters that will be combined with OR logic. The place\n ID must be double-quoted.\n* **registration\\_time`[\u003c|\u003e|\u003c=|\u003e=]\u003cinteger\u003e`**\n For example: **registration\\_time\u003e=1433116800**\n Returns beacons whose registration time matches the given filter.\n Supports the operators: \u003c, \u003e, \u003c=, and \u003e=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support\n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`\u003cdouble\u003e lng:\u003cdouble\u003e radius:\u003cinteger\u003e`**\n For example: **lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered location is within the given circle.\n When any of these fields are given, all are required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer number of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"\u003cstring\u003e=\u003cstring\u003e\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns beacons which have a property of the given name and value.\n Supports multiple filters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"\u003cstring\u003e\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within this namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be double-quoted.\n* **indoor\\_level:`\"\u003cstring\u003e\"`**\n For example: **indoor\\_level:\"1\"**\n Returns beacons which are located on the given indoor level. Accepts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined with AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample REST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`",
+ "type": "string"
+ },
+ "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"
+ },
"pageToken": {
"location": "query",
"description": "A pagination token obtained from a previous request to list beacons.",
"type": "string"
- },
- "q": {
- "description": "Filter query string that supports the following field filters:\n\n* **description:`\"\u003cstring\u003e\"`**\n For example: **description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string must be double-quoted.\n* **status:`\u003cenum\u003e`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of the Beacon.Status enum values (case insensitive). Accepts\n multiple filters which will be combined with OR logic.\n* **stability:`\u003cenum\u003e`**\n For example: **stability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insensitive). Accepts multiple filters which will be combined with\n OR logic.\n* **place\\_id:`\"\u003cstring\u003e\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"**\n Returns beacons explicitly registered at the given place, expressed as\n a Place ID obtained from [Google Places API](/places/place-id). Does not\n match places inside the given place. Does not consider the beacon's\n actual location (which may be different from its registered place).\n Accepts multiple filters that will be combined with OR logic. The place\n ID must be double-quoted.\n* **registration\\_time`[\u003c|\u003e|\u003c=|\u003e=]\u003cinteger\u003e`**\n For example: **registration\\_time\u003e=1433116800**\n Returns beacons whose registration time matches the given filter.\n Supports the operators: \u003c, \u003e, \u003c=, and \u003e=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support\n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`\u003cdouble\u003e lng:\u003cdouble\u003e radius:\u003cinteger\u003e`**\n For example: **lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered location is within the given circle.\n When any of these fields are given, all are required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer number of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"\u003cstring\u003e=\u003cstring\u003e\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns beacons which have a property of the given name and value.\n Supports multiple filters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"\u003cstring\u003e\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within this namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be double-quoted.\n* **indoor\\_level:`\"\u003cstring\u003e\"`**\n For example: **indoor\\_level:\"1\"**\n Returns beacons which are located on the given indoor level. Accepts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined with AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample REST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`",
- "type": "string",
- "location": "query"
- },
- "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",
@@ -540,6 +136,9 @@
"description": "Searches the beacon registry for beacons that match the given search\ncriteria. Only those beacons that the client has permission to list\nwill be returned.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project."
},
"register": {
+ "flatPath": "v1beta1/beacons:register",
+ "path": "v1beta1/beacons:register",
+ "id": "proximitybeacon.beacons.register",
"description": "Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
"request": {
"$ref": "Beacon"
@@ -558,20 +157,460 @@
"type": "string",
"location": "query"
}
+ }
+ },
+ "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"
},
- "flatPath": "v1beta1/beacons:register",
- "path": "v1beta1/beacons:register",
- "id": "proximitybeacon.beacons.register"
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "beaconName": {
+ "description": "Beacon that should be activated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "type": "string",
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/beacons/{beaconsId}:activate",
+ "path": "v1beta1/{+beaconName}:activate",
+ "id": "proximitybeacon.beacons.activate"
+ },
+ "get": {
+ "response": {
+ "$ref": "Beacon"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The project id of the beacon to request. If the project id is not specified\nthen the project making the request is used. The project id must match the\nproject that owns the beacon.\nOptional.",
+ "type": "string"
+ },
+ "beaconName": {
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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."
+ },
+ "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",
+ "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, `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": {
+ "location": "query",
+ "description": "The project id of the beacon to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}"
+ },
+ "decommission": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "beaconName": {
+ "description": "Beacon that should be decommissioned. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID of the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "type": "string",
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The project id of the beacon to decommission. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "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."
+ },
+ "deactivate": {
+ "path": "v1beta1/{+beaconName}:deactivate",
+ "id": "proximitybeacon.beacons.deactivate",
+ "description": "Deactivates a beacon. Once deactivated, the API will not return\ninformation nor attachment data for the beacon when queried via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nbeacon will do nothing (but will return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "beaconName": {
+ "pattern": "^beacons/[^/]+$",
+ "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"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "The project id of the beacon to deactivate. If the project id is not\nspecified then the project making the request is used. The project id must\nmatch the project that owns the beacon.\nOptional.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}:deactivate"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "beaconName": {
+ "location": "path",
+ "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/[^/]+$"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}",
+ "id": "proximitybeacon.beacons.delete",
+ "path": "v1beta1/{+beaconName}",
+ "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."
+ }
+ },
+ "resources": {
+ "attachments": {
+ "methods": {
+ "delete": {
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments/{attachmentsId}",
+ "path": "v1beta1/{+attachmentName}",
+ "id": "proximitybeacon.beacons.attachments.delete",
+ "description": "Deletes the specified attachment for the given beacon. Each attachment has\na unique attachment name (`attachmentName`) which is returned when you\nfetch the attachment data via this API. You specify this with the delete\nrequest to control which attachment is removed. This operation cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "attachmentName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
+ "type": "string"
+ },
+ "attachmentName": {
+ "pattern": "^beacons/[^/]+/attachments/[^/]+$",
+ "location": "path",
+ "description": "The attachment name (`attachmentName`) of\nthe attachment to remove. For example:\n`beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For\nEddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the\nbeacon's current EID, or its \"stable\" Eddystone-UID.\nRequired.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "list": {
+ "path": "v1beta1/{+beaconName}/attachments",
+ "id": "proximitybeacon.beacons.attachments.list",
+ "description": "Returns the attachments for the specified beacon that match the specified\nnamespaced-type pattern.\n\nTo control which namespaced types are returned, you add the\n`namespacedType` query parameter to the request. You must either use\n`*/*`, to return all attachments, or the namespace must be one of\nthe ones returned from the `namespaces` endpoint.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
+ "response": {
+ "$ref": "ListBeaconAttachmentsResponse"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The project id to list beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
+ "type": "string"
+ },
+ "namespacedType": {
+ "location": "query",
+ "description": "Specifies the namespace and type of attachment to include in response in\n\u003cvar\u003enamespace/type\u003c/var\u003e format. Accepts `*/*` to specify\n\"all types in all namespaces\".",
+ "type": "string"
+ },
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments"
+ },
+ "create": {
+ "request": {
+ "$ref": "BeaconAttachment"
+ },
+ "description": "Associates the given data with the specified beacon. Attachment data must\ncontain two parts:\n\u003cul\u003e\n\u003cli\u003eA namespaced type.\u003c/li\u003e\n\u003cli\u003eThe actual attachment data itself.\u003c/li\u003e\n\u003c/ul\u003e\nThe namespaced type consists of two parts, the namespace and the type.\nThe namespace must be one of the values returned by the `namespaces`\nendpoint, while the type can be a string of any characters except for the\nforward slash (`/`) up to 100 characters in length.\n\nAttachment data can be up to 1024 bytes long.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "response": {
+ "$ref": "BeaconAttachment"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "beaconName": {
+ "location": "path",
+ "description": "Beacon on which the attachment should be created. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "type": "string",
+ "pattern": "^beacons/[^/]+$"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "The project id of the project the attachment will belong to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
+ "path": "v1beta1/{+beaconName}/attachments",
+ "id": "proximitybeacon.beacons.attachments.create"
+ },
+ "batchDelete": {
+ "description": "Deletes multiple attachments on a given beacon. This operation is\npermanent and cannot be undone.\n\nYou can optionally specify `namespacedType` to choose which attachments\nshould be deleted. If you do not specify `namespacedType`, all your\nattachments on the given beacon will be deleted. You also may explicitly\nspecify `*/*` to delete all.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "response": {
+ "$ref": "DeleteAttachmentsResponse"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments:batchDelete",
+ "path": "v1beta1/{+beaconName}/attachments:batchDelete",
+ "id": "proximitybeacon.beacons.attachments.batchDelete"
+ }
+ }
+ },
+ "diagnostics": {
+ "methods": {
+ "list": {
+ "description": "List the diagnostics for a single beacon. You can also list diagnostics for\nall the beacons owned by your Google Developers Console project by using\nthe beacon name `beacons/-`.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "response": {
+ "$ref": "ListDiagnosticsResponse"
+ },
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "alertFilter": {
+ "location": "query",
+ "enum": [
+ "ALERT_UNSPECIFIED",
+ "WRONG_LOCATION",
+ "LOW_BATTERY",
+ "LOW_ACTIVITY"
+ ],
+ "description": "Requests only beacons that have the given alert. For example, to find\nbeacons that have low batteries use `alert_filter=LOW_BATTERY`.",
+ "type": "string"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "Requests only diagnostic records for the given project id. If not set,\nthen the project making the request will be used for looking up\ndiagnostic records. Optional.",
+ "type": "string"
+ },
+ "beaconName": {
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "description": "Beacon that the diagnostics are for.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}/diagnostics",
+ "id": "proximitybeacon.beacons.diagnostics.list",
+ "path": "v1beta1/{+beaconName}/diagnostics"
+ }
+ }
}
}
}
},
"parameters": {
- "access_token": {
- "description": "OAuth access token.",
+ "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": {
+ "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": {
+ "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",
@@ -587,341 +626,14 @@
"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"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
}
},
"schemas": {
- "Observation": {
- "properties": {
- "telemetry": {
- "description": "The array of telemetry bytes received from the beacon. The server is\nresponsible for parsing it. This field may frequently be empty, as\nwith a beacon that transmits telemetry only occasionally.",
- "format": "byte",
- "type": "string"
- },
- "timestampMs": {
- "description": "Time when the beacon was observed.",
- "format": "google-datetime",
- "type": "string"
- },
- "advertisedId": {
- "description": "The ID advertised by the beacon the client has encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then the client\nmust be authorized to resolve the given beacon. Otherwise no data will be\nreturned for that beacon.\nRequired.",
- "$ref": "AdvertisedId"
- }
- },
- "id": "Observation",
- "description": "Represents one beacon observed once.",
- "type": "object"
- },
- "ListDiagnosticsResponse": {
- "description": "Response that contains the requested diagnostics.",
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
- "properties": {
- "diagnostics": {
- "description": "The diagnostics matching the given request.",
- "type": "array",
- "items": {
- "$ref": "Diagnostics"
- }
- },
- "nextPageToken": {
- "description": "Token that can be used for pagination. Returned only if the\nrequest matches more beacons than can be returned in this response.",
- "type": "string"
- }
- },
- "id": "ListDiagnosticsResponse"
- },
- "GetInfoForObservedBeaconsResponse": {
- "description": "Information about the requested beacons, optionally including attachment\ndata.",
- "type": "object",
- "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": {
- "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"
- },
- "status": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "ACTIVE",
- "DECOMMISSIONED",
- "INACTIVE"
- ],
- "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."
- ]
- },
- "indoorLevel": {
- "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional.",
- "$ref": "IndoorLevel"
- },
- "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": {
- "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"
- ],
- "description": "Expected location stability. This is set when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.",
- "type": "string"
- },
- "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."
- },
- "provisioningKey": {
- "description": "Some beacons may require a user to provide an authorization key before\nchanging any of its configuration (e.g. broadcast frames, transmit power).\nThis field provides a place to store and control access to that key.\nThis field is populated in responses to `GET /v1beta1/beacons/3!beaconId`\nfrom users with write access to the given beacon. That is to say: If the\nuser is authorized to write the beacon's confidential data in the service,\nthe service considers them authorized to configure the beacon. Note\nthat this key grants nothing on the service, only on the beacon itself.",
- "format": "byte",
- "type": "string"
- },
- "ephemeralIdRegistration": {
- "description": "Write-only registration parameters for beacons using Eddystone-EID\n(remotely resolved ephemeral ID) format. This information will not be\npopulated in API responses. When submitting this data, the `advertised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type will\nresult in an error.",
- "$ref": "EphemeralIdRegistration"
- }
- },
- "id": "Beacon"
- },
- "AdvertisedId": {
- "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",
- "description": "Defines a unique identifier of a beacon as broadcast by the device.",
- "type": "object"
- },
- "IndoorLevel": {
- "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.",
- "type": "object"
- },
- "Date": {
- "properties": {
- "year": {
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
- "format": "int32",
- "type": "integer"
- },
- "day": {
- "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
- "format": "int32",
- "type": "integer"
- },
- "month": {
- "description": "Month of year. Must be from 1 to 12.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Date",
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
- "type": "object"
- },
- "ListNamespacesResponse": {
- "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.",
- "type": "object"
- },
- "Diagnostics": {
- "description": "Diagnostics for a single beacon.",
- "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": {
- "description": "An unordered list of Alerts that the beacon has.",
- "type": "array",
- "items": {
- "enum": [
- "ALERT_UNSPECIFIED",
- "WRONG_LOCATION",
- "LOW_BATTERY",
- "LOW_ACTIVITY"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "Invalid value. Should never appear.",
- "The beacon has been reported far from its expected location (the beacon's\nlat_lng field if populated, otherwise, if the beacon's place_id field is\npresent, the center of that place). This may indicate that the beacon has\nbeen moved. This signal is not 100% accurate, but indicates that further\ninvestigation is worthwhile.",
- "The battery level for the beacon is low enough that, given the beacon's\ncurrent use, its battery will run out with in the next 60 days. This\nindicates that the battery should be replaced soon.",
- "The beacon has been reported at a very low rate or not at all. This may\nindicate that the beacon is broken or just that no one has gone near the\nbeacon in recent days. If this status appears unexpectedly, the beacon\nowner should investigate further."
- ]
- }
- },
- "id": "Diagnostics"
- },
- "ListBeaconsResponse": {
- "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.",
- "type": "object"
+ "properties": {},
+ "id": "Empty"
},
"GetInfoForObservedBeaconsRequest": {
"description": "Request for beacon and attachment information about beacons that\na mobile client has encountered \"in the wild\".",
@@ -944,12 +656,6 @@
},
"id": "GetInfoForObservedBeaconsRequest"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
"BeaconAttachment": {
"description": "Project-specific data associated with a beacon.",
"type": "object",
@@ -984,16 +690,6 @@
"description": "Write-only registration parameters for beacons using Eddystone-EID format.\nTwo ways of securely registering an Eddystone-EID beacon with the service\nare supported:\n\n1. Perform an ECDH key exchange via this API, including a previous call\n to `GET /v1beta1/eidparams`. In this case the fields\n `beacon_ecdh_public_key` and `service_ecdh_public_key` should be\n populated and `beacon_identity_key` should not be populated. This\n method ensures that only the two parties in the ECDH key exchange can\n compute the identity key, which becomes a secret between them.\n2. Derive or obtain the beacon's identity key via other secure means\n (perhaps an ECDH key exchange between the beacon and a mobile device\n or any other secure method), and then submit the resulting identity key\n to the service. In this case `beacon_identity_key` field should be\n populated, and neither of `beacon_ecdh_public_key` nor\n `service_ecdh_public_key` fields should be. The security of this method\n depends on how securely the parties involved (in particular the\n bluetooth client) handle the identity key, and obviously on how\n securely the identity key was generated.\n\nSee [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
"type": "object",
"properties": {
- "initialClockValue": {
- "description": "The initial clock value of the beacon. The beacon's clock must have\nbegun counting at this value immediately prior to transmitting this\nvalue to the resolving service. Significant delay in transmitting this\nvalue to the service risks registration or resolution failures. If a\nvalue is not provided, the default is zero.",
- "format": "uint64",
- "type": "string"
- },
- "beaconEcdhPublicKey": {
- "description": "The beacon's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
- "format": "byte",
- "type": "string"
- },
"rotationPeriodExponent": {
"description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.",
"format": "uint32",
@@ -1013,6 +709,16 @@
"description": "An initial ephemeral ID calculated using the clock value submitted as\n`initial_clock_value`, and the secret key generated by the\nDiffie-Hellman key exchange using `service_ecdh_public_key` and\n`service_ecdh_public_key`. This initial EID value will be used by the\nservice to confirm that the key exchange process was successful.",
"format": "byte",
"type": "string"
+ },
+ "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"
@@ -1035,6 +741,8 @@
"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.",
@@ -1044,38 +752,34 @@
}
}
},
- "id": "ListBeaconAttachmentsResponse",
- "description": "Response to `ListBeaconAttachments` that contains the requested attachments.",
- "type": "object"
+ "id": "ListBeaconAttachmentsResponse"
},
"Namespace": {
+ "description": "An attachment namespace defines read and write access for all the attachments\ncreated under it. Each namespace is globally unique, and owned by one\nproject which is the only project that can create attachments under it.",
+ "type": "object",
"properties": {
"namespaceName": {
"description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
"type": "string"
},
"servingVisibility": {
- "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."
+ ],
+ "enum": [
+ "VISIBILITY_UNSPECIFIED",
+ "UNLISTED",
+ "PUBLIC"
]
}
},
- "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"
+ "id": "Namespace"
},
"BeaconInfo": {
- "description": "A subset of beacon information served via the `beaconinfo.getforobserved`\nmethod, which you call when users of your app encounter your beacons.",
- "type": "object",
"properties": {
"beaconName": {
"description": "The name under which the beacon is registered.",
@@ -1093,7 +797,9 @@
}
}
},
- "id": "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"
},
"AttachmentInfo": {
"description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.",
@@ -1116,6 +822,28 @@
},
"id": "AttachmentInfo"
},
+ "EphemeralIdRegistrationParams": {
+ "description": "Information a client needs to provision and register beacons that\nbroadcast Eddystone-EID format beacon IDs, using Elliptic curve\nDiffie-Hellman key exchange. See\n[the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
+ "type": "object",
+ "properties": {
+ "serviceEcdhPublicKey": {
+ "description": "The beacon service's public key for use by a beacon to derive its\nIdentity Key using Elliptic Curve Diffie-Hellman key exchange.",
+ "format": "byte",
+ "type": "string"
+ },
+ "minRotationPeriodExponent": {
+ "description": "Indicates the minimum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "maxRotationPeriodExponent": {
+ "description": "Indicates the maximum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "id": "EphemeralIdRegistrationParams"
+ },
"DeleteAttachmentsResponse": {
"description": "Response for a request to delete attachments.",
"type": "object",
@@ -1128,32 +856,304 @@
},
"id": "DeleteAttachmentsResponse"
},
- "EphemeralIdRegistrationParams": {
+ "Observation": {
+ "description": "Represents one beacon observed once.",
+ "type": "object",
"properties": {
- "minRotationPeriodExponent": {
- "description": "Indicates the minimum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
- "format": "uint32",
- "type": "integer"
+ "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"
},
- "maxRotationPeriodExponent": {
- "description": "Indicates the maximum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
- "format": "uint32",
- "type": "integer"
+ "timestampMs": {
+ "description": "Time when the beacon was observed.",
+ "format": "google-datetime",
+ "type": "string"
},
- "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.",
+ "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"
+ },
+ "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": {
+ "latLng": {
+ "description": "The location of the beacon, expressed as a latitude and longitude pair.\nThis location is given when the beacon is registered or updated. It does\nnot necessarily indicate the actual current location of the beacon.\nOptional.",
+ "$ref": "LatLng"
+ },
+ "placeId": {
+ "description": "The [Google Places API](/places/place-id) Place ID of the place where\nthe beacon is deployed. This is given when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.",
+ "type": "string"
+ },
+ "properties": {
+ "description": "Properties of the beacon device, for example battery type or firmware\nversion.\nOptional.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "indoorLevel": {
+ "$ref": "IndoorLevel",
+ "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional."
+ },
+ "status": {
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "ACTIVE",
+ "DECOMMISSIONED",
+ "INACTIVE"
+ ],
+ "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."
+ ]
+ },
+ "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": {
+ "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"
+ ],
+ "description": "Expected location stability. This is set when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.",
+ "type": "string"
+ },
+ "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": {
+ "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"
}
},
- "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"
+ "id": "Beacon"
+ },
+ "AdvertisedId": {
+ "description": "Defines a unique identifier of a beacon as broadcast by the device.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ },
+ "IndoorLevel": {
+ "description": "Indoor level, a human-readable string as returned by Google Maps APIs,\nuseful to indicate which floor of a building a beacon is located on.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of this level.",
+ "type": "string"
+ }
+ },
+ "id": "IndoorLevel"
+ },
+ "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"
+ },
+ "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": {
+ "description": "Diagnostics for a single beacon.",
+ "type": "object",
+ "properties": {
+ "beaconName": {
+ "description": "Resource name of the beacon. For Eddystone-EID beacons, this may\nbe the beacon's current EID, or the beacon's \"stable\" Eddystone-UID.",
+ "type": "string"
+ },
+ "alerts": {
+ "enumDescriptions": [
+ "Invalid value. Should never appear.",
+ "The beacon has been reported far from its expected location (the beacon's\nlat_lng field if populated, otherwise, if the beacon's place_id field is\npresent, the center of that place). This may indicate that the beacon has\nbeen moved. This signal is not 100% accurate, but indicates that further\ninvestigation is worthwhile.",
+ "The battery level for the beacon is low enough that, given the beacon's\ncurrent use, its battery will run out with in the next 60 days. This\nindicates that the battery should be replaced soon.",
+ "The beacon has been reported at a very low rate or not at all. This may\nindicate that the beacon is broken or just that no one has gone near the\nbeacon in recent days. If this status appears unexpectedly, the beacon\nowner should investigate further."
+ ],
+ "description": "An unordered list of Alerts that the beacon has.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "ALERT_UNSPECIFIED",
+ "WRONG_LOCATION",
+ "LOW_BATTERY",
+ "LOW_ACTIVITY"
+ ],
+ "type": "string"
+ }
+ },
+ "estimatedLowBatteryDate": {
+ "$ref": "Date",
+ "description": "The date when the battery is expected to be low. If the value is missing\nthen there is no estimate for when the battery will be low.\nThis value is only an estimate, not an exact date."
+ }
+ },
+ "id": "Diagnostics"
}
},
- "protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- }
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
+ "protocol": "rest",
+ "version": "v1beta1",
+ "baseUrl": "https://proximitybeacon.googleapis.com/",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/userlocation.beacon.registry": {
+ "description": "View and modify your beacons"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "Registers, manages, indexes, and searches beacons.",
+ "servicePath": "",
+ "rootUrl": "https://proximitybeacon.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "proximitybeacon",
+ "batchPath": "batch",
+ "id": "proximitybeacon:v1beta1",
+ "documentationLink": "https://developers.google.com/beacons/proximity/",
+ "revision": "20180117",
+ "title": "Google Proximity Beacon API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "version_module": true
}
diff --git a/pubsub/v1/pubsub-api.json b/pubsub/v1/pubsub-api.json
index e0c6098..d753f1f 100644
--- a/pubsub/v1/pubsub-api.json
+++ b/pubsub/v1/pubsub-api.json
@@ -1,4 +1,11 @@
{
+ "ownerDomain": "google.com",
+ "name": "pubsub",
+ "batchPath": "batch",
+ "revision": "20180116",
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "id": "pubsub:v1",
+ "title": "Google Cloud Pub/Sub API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
@@ -6,98 +13,126 @@
"resources": {
"subscriptions": {
"methods": {
- "acknowledge": {
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
- "id": "pubsub.projects.subscriptions.acknowledge",
- "path": "v1/{+subscription}:acknowledge",
- "request": {
- "$ref": "AcknowledgeRequest"
- },
- "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.",
- "httpMethod": "POST",
- "parameterOrder": [
- "subscription"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "subscription": {
- "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
- },
- "patch": {
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "create": {
"path": "v1/{+name}",
- "id": "pubsub.projects.subscriptions.patch",
+ "id": "pubsub.projects.subscriptions.create",
"request": {
- "$ref": "UpdateSubscriptionRequest"
+ "$ref": "Subscription"
},
- "description": "Updates an existing subscription. Note that certain properties of a\nsubscription, such as its topic, are not modifiable.",
+ "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.",
"response": {
"$ref": "Subscription"
},
"parameterOrder": [
"name"
],
- "httpMethod": "PATCH",
+ "httpMethod": "PUT",
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"location": "path",
"description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
- ]
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}"
},
- "get": {
- "description": "Gets the configuration details of a subscription.",
- "httpMethod": "GET",
+ "acknowledge": {
+ "response": {
+ "$ref": "Empty"
+ },
"parameterOrder": [
"subscription"
],
+ "httpMethod": "POST",
+ "parameters": {
+ "subscription": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
+ "path": "v1/{+subscription}:acknowledge",
+ "id": "pubsub.projects.subscriptions.acknowledge",
+ "request": {
+ "$ref": "AcknowledgeRequest"
+ },
+ "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error."
+ },
+ "patch": {
+ "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.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
"response": {
"$ref": "Subscription"
},
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}"
+ },
+ "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.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "id": "pubsub.projects.subscriptions.get",
- "path": "v1/{+subscription}"
+ "path": "v1/{+subscription}",
+ "id": "pubsub.projects.subscriptions.get"
},
"testIamPermissions": {
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
"id": "pubsub.projects.subscriptions.testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"request": {
"$ref": "TestIamPermissionsRequest"
},
+ "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"
},
@@ -105,25 +140,57 @@
"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"
+ },
+ "modifyPushConfig": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "subscription": {
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
}
+ },
+ "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"
}
},
"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"
},
- "description": "Seeks an existing subscription to a point in time or to a given snapshot,\nwhichever is provided in the request.",
"response": {
"$ref": "SeekResponse"
},
@@ -131,6 +198,10 @@
"subscription"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"parameters": {
"subscription": {
"description": "The subscription to affect.",
@@ -140,88 +211,49 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:seek",
- "path": "v1/{+subscription}:seek",
- "id": "pubsub.projects.subscriptions.seek"
- },
- "modifyPushConfig": {
- "httpMethod": "POST",
- "parameterOrder": [
- "subscription"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "location": "path",
- "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
- "id": "pubsub.projects.subscriptions.modifyPushConfig",
- "path": "v1/{+subscription}: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"
- }
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:seek"
},
"delete": {
+ "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.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "subscription"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"parameters": {
"subscription": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"location": "path",
"description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "id": "pubsub.projects.subscriptions.delete",
- "path": "v1/{+subscription}"
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}"
},
"setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "response": {
- "$ref": "Policy"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Policy"
+ },
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ "type": "string"
}
},
"scopes": [
@@ -229,54 +261,29 @@
"https://www.googleapis.com/auth/pubsub"
],
"flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
+ "id": "pubsub.projects.subscriptions.setIamPolicy",
"path": "v1/{+resource}:setIamPolicy",
- "id": "pubsub.projects.subscriptions.setIamPolicy"
- },
- "modifyAckDeadline": {
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
- "id": "pubsub.projects.subscriptions.modifyAckDeadline",
- "path": "v1/{+subscription}:modifyAckDeadline",
"request": {
- "$ref": "ModifyAckDeadlineRequest"
+ "$ref": "SetIamPolicyRequest"
},
- "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": {
- "location": "path",
- "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "httpMethod": "GET",
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"resource"
],
+ "httpMethod": "GET",
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ "type": "string"
}
},
"scopes": [
@@ -284,17 +291,39 @@
"https://www.googleapis.com/auth/pubsub"
],
"flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
- "id": "pubsub.projects.subscriptions.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "pubsub.projects.subscriptions.getIamPolicy"
+ },
+ "modifyAckDeadline": {
+ "path": "v1/{+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.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "subscription": {
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline"
},
"pull": {
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
- "path": "v1/{+subscription}:pull",
- "id": "pubsub.projects.subscriptions.pull",
- "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.",
- "request": {
- "$ref": "PullRequest"
- },
"response": {
"$ref": "PullResponse"
},
@@ -302,46 +331,52 @@
"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"
],
- "parameters": {
- "subscription": {
- "location": "path",
- "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- }
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
+ "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": {
- "description": "Lists matching subscriptions.",
- "httpMethod": "GET",
"response": {
"$ref": "ListSubscriptionsResponse"
},
"parameterOrder": [
"project"
],
+ "httpMethod": "GET",
"parameters": {
+ "pageToken": {
+ "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
"pageSize": {
- "location": "query",
"description": "Maximum number of subscriptions to return.",
"format": "int32",
- "type": "integer"
+ "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",
- "pattern": "^projects/[^/]+$"
- },
- "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"
}
},
@@ -350,142 +385,15 @@
"https://www.googleapis.com/auth/pubsub"
],
"flatPath": "v1/projects/{projectsId}/subscriptions",
+ "path": "v1/{+project}/subscriptions",
"id": "pubsub.projects.subscriptions.list",
- "path": "v1/{+project}/subscriptions"
- },
- "create": {
- "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic, conforming\nto the\n[resource name format](https://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populated in the returned Subscription object.\nNote that for REST API requests, you must specify a name in the request.",
- "request": {
- "$ref": "Subscription"
- },
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "path": "v1/{+name}",
- "id": "pubsub.projects.subscriptions.create"
+ "description": "Lists matching subscriptions."
}
}
},
"snapshots": {
"methods": {
- "list": {
- "flatPath": "v1/projects/{projectsId}/snapshots",
- "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": {
- "location": "query",
- "description": "The value returned by the last `ListSnapshotsResponse`; indicates that this\nis a continuation of a prior `ListSnapshots` call, and that the system\nshould return the next page of data.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of snapshots to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "project": {
- "location": "path",
- "description": "The name of the cloud project that snapshots belong to.\nFormat is `projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- }
- },
- "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.",
- "response": {
- "$ref": "Snapshot"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Optional user-provided name for this snapshot.\nIf the name is not provided in the request, the server will assign a random\nname for this snapshot on the same project as the subscription.\nNote that for REST API requests, you must specify a name.\nFormat is `projects/{project}/snapshots/{snap}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/snapshots/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
- "path": "v1/{+name}",
- "id": "pubsub.projects.snapshots.create"
- },
- "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/[^/]+/snapshots/[^/]+$"
- }
- },
- "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"
- },
"getIamPolicy": {
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "pubsub.projects.snapshots.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"response": {
"$ref": "Policy"
},
@@ -493,21 +401,28 @@
"resource"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/snapshots/[^/]+$"
+ "type": "string"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "pubsub.projects.snapshots.getIamPolicy",
+ "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/{+snapshot}",
+ "id": "pubsub.projects.snapshots.get",
+ "description": "Gets the configuration details of a snapshot.",
"response": {
"$ref": "Snapshot"
},
@@ -517,27 +432,20 @@
"httpMethod": "GET",
"parameters": {
"snapshot": {
- "location": "path",
"description": "The name of the snapshot to get.\nFormat is `projects/{project}/snapshots/{snap}`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/snapshots/[^/]+$"
+ "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/{+snapshot}",
- "id": "pubsub.projects.snapshots.get",
- "description": "Gets the configuration details of a snapshot."
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}"
},
"patch": {
- "request": {
- "$ref": "UpdateSnapshotRequest"
- },
- "description": "Updates an existing snapshot. Note that certain properties of a\nsnapshot are not modifiable.",
"response": {
"$ref": "Snapshot"
},
@@ -560,13 +468,13 @@
],
"flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
"path": "v1/{+name}",
- "id": "pubsub.projects.snapshots.patch"
+ "id": "pubsub.projects.snapshots.patch",
+ "request": {
+ "$ref": "UpdateSnapshotRequest"
+ },
+ "description": "Updates an existing snapshot. Note that certain properties of a\nsnapshot are not modifiable."
},
"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"
},
@@ -574,6 +482,10 @@
"resource"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
@@ -583,23 +495,22 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
- "id": "pubsub.projects.snapshots.testIamPermissions"
+ "id": "pubsub.projects.snapshots.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
},
"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.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "snapshot"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "snapshot"
+ ],
+ "httpMethod": "DELETE",
"parameters": {
"snapshot": {
"description": "The name of the snapshot to delete.\nFormat is `projects/{project}/snapshots/{snap}`.",
@@ -614,18 +525,257 @@
"https://www.googleapis.com/auth/pubsub"
],
"flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
+ "path": "v1/{+snapshot}",
"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",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListSnapshotsResponse`; indicates that this\nis a continuation of a prior `ListSnapshots` call, and that the system\nshould return the next page of data.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of snapshots to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "project": {
+ "description": "The name of the cloud project that snapshots 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}/snapshots"
+ },
+ "create": {
+ "response": {
+ "$ref": "Snapshot"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Optional user-provided name for this snapshot.\nIf the name is not provided in the request, the server will assign a random\nname for this snapshot on the same project as the subscription.\nNote that for REST API requests, you must specify a name.\nFormat is `projects/{project}/snapshots/{snap}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
+ "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"
+ }
+ },
+ "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/[^/]+/snapshots/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "pubsub.projects.snapshots.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
}
}
},
"topics": {
"methods": {
- "get": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "topic": {
+ "description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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.get",
- "description": "Gets the configuration of a 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": {
+ "id": "pubsub.projects.topics.list",
+ "path": "v1/{+project}/topics",
+ "description": "Lists matching topics.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of topics to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "project": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The name of the cloud project that topics belong to.\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}/topics"
+ },
+ "create": {
+ "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",
+ "request": {
+ "$ref": "Topic"
+ },
+ "description": "Creates the given topic with the given name."
+ },
+ "setIamPolicy": {
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "pubsub.projects.topics.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/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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": {
"response": {
"$ref": "Topic"
},
@@ -633,10 +783,6 @@
"topic"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"parameters": {
"topic": {
"description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.",
@@ -645,7 +791,15 @@
"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/{+topic}",
+ "id": "pubsub.projects.topics.get",
+ "description": "Gets the configuration of a topic."
},
"publish": {
"request": {
@@ -677,17 +831,13 @@
"path": "v1/{+topic}: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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"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.",
@@ -702,161 +852,19 @@
"https://www.googleapis.com/auth/pubsub"
],
"flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
"id": "pubsub.projects.topics.testIamPermissions",
- "path": "v1/{+resource}: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": {
- "description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.",
- "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/{+topic}",
- "id": "pubsub.projects.topics.delete"
- },
- "list": {
- "flatPath": "v1/projects/{projectsId}/topics",
- "path": "v1/{+project}/topics",
- "id": "pubsub.projects.topics.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": {
- "description": "Maximum number of topics to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "project": {
- "location": "path",
- "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- }
- },
- "setIamPolicy": {
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
- "id": "pubsub.projects.topics.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"request": {
- "$ref": "SetIamPolicyRequest"
+ "$ref": "TestIamPermissionsRequest"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "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/[^/]+/topics/[^/]+$"
- }
- }
- },
- "create": {
- "request": {
- "$ref": "Topic"
- },
- "description": "Creates the given topic with the given name.",
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "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",
- "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/{+name}",
- "id": "pubsub.projects.topics.create"
- },
- "getIamPolicy": {
- "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/[^/]+/topics/[^/]+$"
- }
- },
- "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",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
}
},
"resources": {
"subscriptions": {
"methods": {
"list": {
+ "description": "Lists the names of the subscriptions on this topic.",
"response": {
"$ref": "ListTopicSubscriptionsResponse"
},
@@ -877,11 +885,11 @@
"location": "query"
},
"topic": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "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/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -890,15 +898,13 @@
],
"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."
+ "id": "pubsub.projects.topics.subscriptions.list"
}
}
},
"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.",
@@ -909,30 +915,31 @@
"topic"
],
"httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "The value returned by the last `ListTopicSnapshotsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSnapshots` call, and\nthat the system should return the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Maximum number of snapshot names to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "topic": {
+ "description": "The name of the topic that snapshots are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "parameters": {
- "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/[^/]+$"
- },
- "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"
- }
- }
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}/snapshots"
}
}
}
@@ -953,20 +960,20 @@
"type": "boolean",
"default": "true"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
"location": "query",
@@ -974,13 +981,18 @@
"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"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "callback": {
+ "description": "JSONP",
"type": "string",
"location": "query"
},
@@ -997,12 +1009,9 @@
"description": "V1 error format.",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -1014,34 +1023,191 @@
"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"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
}
},
"schemas": {
+ "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.",
+ "type": "string"
+ },
+ "snapshots": {
+ "description": "The names of the snapshots that match the request.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ListTopicSnapshotsResponse"
+ },
+ "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": "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",
+ "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"
+ },
+ "Topic": {
+ "properties": {
+ "name": {
+ "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
+ "type": "string"
+ }
+ },
+ "id": "Topic",
+ "description": "A topic resource.",
+ "type": "object"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "SeekRequest"
+ },
+ "ReceivedMessage": {
+ "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.",
+ "type": "object"
+ },
+ "PushConfig": {
+ "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",
+ "description": "Configuration for a push delivery endpoint.",
+ "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"
+ },
"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"
+ },
+ "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"
@@ -1061,12 +1227,10 @@
"id": "PublishRequest"
},
"UpdateSubscriptionRequest": {
- "description": "Request for the UpdateSubscription method.",
- "type": "object",
"properties": {
"subscription": {
- "$ref": "Subscription",
- "description": "The updated subscription object."
+ "description": "The updated subscription object.",
+ "$ref": "Subscription"
},
"updateMask": {
"description": "Indicates which fields in the provided subscription to update.\nMust be specified and non-empty.",
@@ -1074,11 +1238,11 @@
"type": "string"
}
},
- "id": "UpdateSubscriptionRequest"
+ "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.",
@@ -1088,21 +1252,12 @@
}
}
},
- "id": "PublishResponse"
+ "id": "PublishResponse",
+ "description": "Response for the `Publish` method.",
+ "type": "object"
},
"Subscription": {
- "description": "A subscription resource.",
- "type": "object",
"properties": {
- "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"
@@ -1112,16 +1267,27 @@
"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"
+ "$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"
}
},
- "id": "Subscription"
+ "id": "Subscription",
+ "description": "A subscription resource.",
+ "type": "object"
},
"SeekResponse": {
"type": "object",
@@ -1129,23 +1295,23 @@
"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"
}
- },
- "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"
}
},
- "id": "ModifyAckDeadlineRequest"
+ "id": "ModifyAckDeadlineRequest",
+ "description": "Request for the ModifyAckDeadline method.",
+ "type": "object"
},
"Snapshot": {
"description": "A snapshot resource.",
@@ -1172,8 +1338,8 @@
"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"
@@ -1232,25 +1398,25 @@
"id": "AcknowledgeRequest"
},
"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"
},
"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"
}
- },
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.",
- "type": "string"
}
},
"id": "ListTopicsResponse"
@@ -1288,8 +1454,6 @@
"id": "PullResponse"
},
"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.",
@@ -1297,11 +1461,13 @@
"type": "string"
},
"snapshot": {
- "description": "The updated snpashot object.",
- "$ref": "Snapshot"
+ "$ref": "Snapshot",
+ "description": "The updated snpashot object."
}
},
- "id": "UpdateSnapshotRequest"
+ "id": "UpdateSnapshotRequest",
+ "description": "Request for the UpdateSnapshot method.",
+ "type": "object"
},
"ListSnapshotsResponse": {
"description": "Response for the `ListSnapshots` method.",
@@ -1338,170 +1504,11 @@
}
},
"id": "ListSubscriptionsResponse"
- },
- "CreateSnapshotRequest": {
- "description": "Request for the `CreateSnapshot` method.",
- "type": "object",
- "properties": {
- "subscription": {
- "description": "The subscription whose backlog the snapshot retains.\nSpecifically, the created snapshot is guaranteed to retain:\n (a) The existing backlog on the subscription. More precisely, this is\n defined as the messages in the subscription's backlog that are\n unacknowledged upon the successful completion of the\n `CreateSnapshot` request; as well as:\n (b) Any messages published to the subscription's topic following the\n successful completion of the CreateSnapshot request.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "type": "string"
- }
- },
- "id": "CreateSnapshotRequest"
- },
- "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.",
- "type": "string"
- },
- "snapshots": {
- "description": "The names of the snapshots that match the request.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ListTopicSnapshotsResponse"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "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"
- }
- },
- "id": "SeekRequest"
- },
- "ReceivedMessage": {
- "description": "A message and its corresponding acknowledgment ID.",
- "type": "object",
- "properties": {
- "ackId": {
- "description": "This ID can be used to acknowledge the received message.",
- "type": "string"
- },
- "message": {
- "description": "The message.",
- "$ref": "PubsubMessage"
- }
- },
- "id": "ReceivedMessage"
- },
- "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": {
- "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"
}
},
"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",
@@ -1519,16 +1526,9 @@
}
}
},
- "kind": "discovery#restDescription",
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
"servicePath": "",
+ "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
+ "kind": "discovery#restDescription",
"rootUrl": "https://pubsub.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "pubsub",
- "batchPath": "batch",
- "revision": "20180116",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "id": "pubsub:v1",
- "title": "Google Cloud Pub/Sub API"
+ "basePath": ""
}
diff --git a/pubsub/v1beta1a/pubsub-api.json b/pubsub/v1beta1a/pubsub-api.json
index 4f1205d..d918a28 100644
--- a/pubsub/v1beta1a/pubsub-api.json
+++ b/pubsub/v1beta1a/pubsub-api.json
@@ -1,26 +1,126 @@
{
+ "kind": "discovery#restDescription",
+ "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
+ "servicePath": "",
+ "rootUrl": "https://pubsub.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "pubsub",
+ "batchPath": "batch",
+ "revision": "20180116",
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "id": "pubsub:v1beta1a",
+ "title": "Google Cloud Pub/Sub API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
- "subscriptions": {
+ "topics": {
"methods": {
- "list": {
- "flatPath": "v1beta1a/subscriptions",
- "path": "v1beta1a/subscriptions",
- "id": "pubsub.subscriptions.list",
- "description": "Lists matching subscriptions.",
- "response": {
- "$ref": "ListSubscriptionsResponse"
- },
- "parameterOrder": [],
+ "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": {
+ "location": "path",
+ "description": "The name of the topic to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^.+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "flatPath": "v1beta1a/topics/{topicsId}",
+ "id": "pubsub.topics.get",
+ "path": "v1beta1a/topics/{+topic}"
+ },
+ "publish": {
+ "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not\nexist.",
+ "request": {
+ "$ref": "PublishRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1a/topics/publish",
+ "path": "v1beta1a/topics/publish",
+ "id": "pubsub.topics.publish"
+ },
+ "delete": {
+ "description": "Deletes the topic with the given name. Returns NOT_FOUND if the topic does\nnot exist. After a topic is deleted, a new topic may be created with the\nsame name.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "topic": {
+ "description": "Name of the topic to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/topics/{topicsId}",
+ "path": "v1beta1a/topics/{+topic}",
+ "id": "pubsub.topics.delete"
+ },
+ "publishBatch": {
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1a/topics/publishBatch",
+ "path": "v1beta1a/topics/publishBatch",
+ "id": "pubsub.topics.publishBatch"
+ },
+ "list": {
+ "flatPath": "v1beta1a/topics",
+ "id": "pubsub.topics.list",
+ "path": "v1beta1a/topics",
+ "description": "Lists matching topics.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
+ "parameterOrder": [],
"parameters": {
"pageToken": {
- "type": "string",
"location": "query",
- "description": "The value obtained in the last \u003ccode\u003eListSubscriptionsResponse\u003c/code\u003e\nfor continuation."
+ "description": "The value obtained in the last \u003ccode\u003eListTopicsResponse\u003c/code\u003e\nfor continuation.",
+ "type": "string"
},
"query": {
"description": "A valid label query expression.",
@@ -29,49 +129,173 @@
},
"maxResults": {
"location": "query",
- "description": "Maximum number of subscriptions to return.",
+ "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"
+ ]
},
"create": {
- "description": "Creates a subscription on a given topic for a given subscriber.\nIf the subscription already exists, returns ALREADY_EXISTS.\nIf the corresponding topic doesn't exist, returns NOT_FOUND.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic.",
- "request": {
- "$ref": "Subscription"
- },
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [],
"httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Topic"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {},
- "flatPath": "v1beta1a/subscriptions",
- "path": "v1beta1a/subscriptions",
- "id": "pubsub.subscriptions.create"
- },
- "acknowledge": {
+ "flatPath": "v1beta1a/topics",
+ "id": "pubsub.topics.create",
+ "path": "v1beta1a/topics",
+ "description": "Creates the given topic with the given name.",
+ "request": {
+ "$ref": "Topic"
+ }
+ }
+ }
+ },
+ "subscriptions": {
+ "methods": {
+ "modifyPushConfig": {
+ "request": {
+ "$ref": "ModifyPushConfigRequest"
+ },
+ "description": "Modifies the \u003ccode\u003ePushConfig\u003c/code\u003e for a specified subscription.\nThis method can be used to suspend the flow of messages to an endpoint\nby clearing the \u003ccode\u003ePushConfig\u003c/code\u003e field in the request. Messages\nwill be accumulated for delivery even if no push configuration is\ndefined or while the configuration is modified.",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "Empty"
},
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "flatPath": "v1beta1a/subscriptions/modifyPushConfig",
+ "id": "pubsub.subscriptions.modifyPushConfig",
+ "path": "v1beta1a/subscriptions/modifyPushConfig"
+ },
+ "delete": {
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "description": "The subscription to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
+ "path": "v1beta1a/subscriptions/{+subscription}",
+ "id": "pubsub.subscriptions.delete"
+ },
+ "pull": {
+ "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).",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "PullResponse"
+ },
"parameters": {},
- "flatPath": "v1beta1a/subscriptions/acknowledge",
- "id": "pubsub.subscriptions.acknowledge",
- "path": "v1beta1a/subscriptions/acknowledge",
- "description": "Acknowledges a particular received message: the Pub/Sub system can remove\nthe given message from the subscription. Acknowledging a message whose\nAck deadline has expired may succeed, but the message could have been\nalready redelivered. Acknowledging a message more than once will not\nresult in an error. This is only used for messages received via pull.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "list": {
+ "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": {
+ "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",
+ "id": "pubsub.subscriptions.list",
+ "path": "v1beta1a/subscriptions",
+ "description": "Lists matching 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",
+ "path": "v1beta1a/subscriptions",
+ "id": "pubsub.subscriptions.create"
+ },
+ "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": {
"description": "Modifies the Ack deadline for a message received from a pull request.",
@@ -93,268 +317,113 @@
"id": "pubsub.subscriptions.modifyAckDeadline"
},
"pullBatch": {
- "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The system is free to return UNAVAILABLE\nif there are too many pull requests outstanding for the given subscription.",
"request": {
"$ref": "PullBatchRequest"
},
+ "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The system is free to return UNAVAILABLE\nif there are too many pull requests outstanding for the given subscription.",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "PullBatchResponse"
},
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "parameters": {},
"flatPath": "v1beta1a/subscriptions/pullBatch",
"id": "pubsub.subscriptions.pullBatch",
"path": "v1beta1a/subscriptions/pullBatch"
},
"get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "subscription"
- ],
+ "description": "Gets the configuration details of a subscription.",
"response": {
"$ref": "Subscription"
},
- "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}",
- "id": "pubsub.subscriptions.get",
- "path": "v1beta1a/subscriptions/{+subscription}",
- "description": "Gets the configuration details of a subscription."
- },
- "modifyPushConfig": {
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/subscriptions/modifyPushConfig",
- "path": "v1beta1a/subscriptions/modifyPushConfig",
- "id": "pubsub.subscriptions.modifyPushConfig",
- "request": {
- "$ref": "ModifyPushConfigRequest"
- },
- "description": "Modifies the \u003ccode\u003ePushConfig\u003c/code\u003e for a specified subscription.\nThis method can be used to suspend the flow of messages to an endpoint\nby clearing the \u003ccode\u003ePushConfig\u003c/code\u003e field in the request. Messages\nwill be accumulated for delivery even if no push configuration is\ndefined or while the configuration is modified.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"subscription"
],
- "httpMethod": "DELETE",
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {
"subscription": {
- "pattern": "^.+$",
- "location": "path",
- "description": "The subscription to delete.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
- "path": "v1beta1a/subscriptions/{+subscription}",
- "id": "pubsub.subscriptions.delete",
- "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to Pull after deletion will return\nNOT_FOUND."
- },
- "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"
- }
- }
- },
- "topics": {
- "methods": {
- "delete": {
- "flatPath": "v1beta1a/topics/{topicsId}",
- "path": "v1beta1a/topics/{+topic}",
- "id": "pubsub.topics.delete",
- "description": "Deletes the topic with the given name. Returns NOT_FOUND if the topic does\nnot exist. After a topic is deleted, a new topic may be created with the\nsame name.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "topic": {
- "location": "path",
- "description": "Name of the topic to delete.",
- "required": true,
- "type": "string",
- "pattern": "^.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
- },
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {},
- "flatPath": "v1beta1a/topics/publishBatch"
- },
- "list": {
- "response": {
- "$ref": "ListTopicsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "query": {
- "description": "A valid label query expression.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "location": "query",
- "description": "Maximum number of topics to return.",
- "format": "int32",
- "type": "integer"
- },
- "pageToken": {
- "location": "query",
- "description": "The value obtained in the last \u003ccode\u003eListTopicsResponse\u003c/code\u003e\nfor continuation.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/topics",
- "path": "v1beta1a/topics",
- "id": "pubsub.topics.list",
- "description": "Lists matching topics."
- },
- "create": {
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {},
- "flatPath": "v1beta1a/topics",
- "path": "v1beta1a/topics",
- "id": "pubsub.topics.create",
- "description": "Creates the given topic with the given name.",
- "request": {
- "$ref": "Topic"
- }
- },
- "get": {
- "parameters": {
- "topic": {
- "description": "The name of the topic to get.",
+ "description": "The name of the subscription to get.",
"required": true,
"type": "string",
"pattern": "^.+$",
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/topics/{topicsId}",
- "id": "pubsub.topics.get",
- "path": "v1beta1a/topics/{+topic}",
- "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"
- ]
- },
- "publish": {
- "flatPath": "v1beta1a/topics/publish",
- "path": "v1beta1a/topics/publish",
- "id": "pubsub.topics.publish",
- "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not\nexist.",
- "request": {
- "$ref": "PublishRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {}
+ "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
+ "path": "v1beta1a/subscriptions/{+subscription}",
+ "id": "pubsub.subscriptions.get"
}
}
}
},
"parameters": {
- "key": {
- "type": "string",
+ "upload_protocol": {
"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": "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": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
},
"access_token": {
"description": "OAuth access token.",
@@ -362,9 +431,9 @@
"location": "query"
},
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
"description": "Pretty-print response.",
@@ -378,145 +447,12 @@
"type": "string"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
"type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "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": {
- "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"
+ "location": "query"
}
},
"schemas": {
- "Topic": {
- "description": "A topic resource.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the topic.",
- "type": "string"
- }
- },
- "id": "Topic"
- },
- "Label": {
- "description": "A key-value pair applied to a given object.",
- "type": "object",
- "properties": {
- "strValue": {
- "description": "A string value.",
- "type": "string"
- },
- "numValue": {
- "description": "An integer value.",
- "format": "int64",
- "type": "string"
- },
- "key": {
- "description": "The key of a label is a syntactically valid URL (as per RFC 1738) with\nthe \"scheme\" and initial slashes omitted and with the additional\nrestrictions noted below. Each key should be globally unique. The\n\"host\" portion is called the \"namespace\" and is not necessarily\nresolvable to a network endpoint. Instead, the namespace indicates what\nsystem or entity defines the semantics of the label. Namespaces do not\nrestrict the set of objects to which a label may be associated.\n\nKeys are defined by the following grammar:\n\n key = hostname \"/\" kpath\n kpath = ksegment *[ \"/\" ksegment ]\n ksegment = alphadigit | *[ alphadigit | \"-\" | \"_\" | \".\" ]\n\nwhere \"hostname\" and \"alphadigit\" are defined as in RFC 1738.\n\nExample key:\n spanner.google.com/universe",
- "type": "string"
- }
- },
- "id": "Label"
- },
- "ModifyAckDeadlineRequest": {
- "type": "object",
- "properties": {
- "ackIds": {
- "description": "List of acknowledgment IDs. Either this field or ack_id\nshould be populated, not both.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "subscription": {
- "description": "Next Index: 5\nThe name of the subscription from which messages are being pulled.",
- "type": "string"
- },
- "ackId": {
- "description": "The acknowledgment ID. Either this or ack_ids must be populated,\nnot both.",
- "type": "string"
- },
- "ackDeadlineSeconds": {
- "description": "The new ack deadline with respect to the time this request was sent to the\nPub/Sub system. Must be \u003e= 0. For example, if the value is 10, the new ack\ndeadline will expire 10 seconds after the ModifyAckDeadline call was made.\nSpecifying zero may immediately make the message available for another pull\nrequest.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ModifyAckDeadlineRequest",
- "description": "Request for the ModifyAckDeadline method."
- },
- "PullBatchRequest": {
- "description": "Request for the PullBatch method.",
- "type": "object",
- "properties": {
- "subscription": {
- "description": "The subscription from which messages should be pulled.",
- "type": "string"
- },
- "returnImmediately": {
- "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the Pull response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.",
- "type": "boolean"
- },
- "maxEvents": {
- "type": "integer",
- "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"
- }
- },
- "id": "PullBatchRequest"
- },
"PubsubMessage": {
"description": "A message data and its labels.",
"type": "object",
@@ -549,37 +485,17 @@
"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"
+ },
+ "pushConfig": {
+ "description": "An empty \u003ccode\u003epush_config\u003c/code\u003e indicates that the Pub/Sub system should\npause pushing messages from the given subscription.",
+ "$ref": "PushConfig"
}
},
"id": "ModifyPushConfigRequest"
},
- "Empty": {
- "type": "object",
- "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"
- },
- "PullBatchResponse": {
- "properties": {
- "pullResponses": {
- "type": "array",
- "items": {
- "$ref": "PullResponse"
- },
- "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."
- }
- },
- "id": "PullBatchResponse",
- "description": "Response for the PullBatch method.",
- "type": "object"
- },
"AcknowledgeRequest": {
"description": "Request for the Acknowledge method.",
"type": "object",
@@ -598,7 +514,29 @@
},
"id": "AcknowledgeRequest"
},
+ "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": "PullBatchResponse"
+ },
+ "Empty": {
+ "description": "An empty message that you can re-use to avoid defining duplicated empty\nmessages in your project. A typical example is to use it as argument or the\nreturn value of a service API. For instance:\n\n service Foo {\n rpc Bar (proto2.Empty) returns (proto2.Empty) { };\n };\n\nBEGIN GOOGLE-INTERNAL\nThe difference between this one and net/rpc/empty-message.proto is that\n1) The generated message here is in proto2 C++ API.\n2) The proto2.Empty has minimum dependencies\n (no message_set or net/rpc dependencies)\nEND GOOGLE-INTERNAL",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
"PublishBatchRequest": {
+ "description": "Request for the PublishBatch method.",
+ "type": "object",
"properties": {
"messages": {
"description": "The messages to publish.",
@@ -612,9 +550,7 @@
"type": "string"
}
},
- "id": "PublishBatchRequest",
- "description": "Request for the PublishBatch method.",
- "type": "object"
+ "id": "PublishBatchRequest"
},
"ListTopicsResponse": {
"description": "Response for the ListTopics method.",
@@ -635,19 +571,19 @@
"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": {
- "pubsubEvent": {
- "$ref": "PubsubEvent",
- "description": "A pubsub message or truncation event."
- },
"ackId": {
"description": "This ID must be used to acknowledge the received event or message.",
"type": "string"
+ },
+ "pubsubEvent": {
+ "description": "A pubsub message or truncation event.",
+ "$ref": "PubsubEvent"
}
},
- "id": "PullResponse",
- "description": "Either a \u003ccode\u003ePubsubMessage\u003c/code\u003e or a truncation event. One of these two\nmust be populated.",
- "type": "object"
+ "id": "PullResponse"
},
"PushConfig": {
"description": "Configuration for a push delivery endpoint.",
@@ -676,38 +612,38 @@
"id": "PullRequest"
},
"ListSubscriptionsResponse": {
+ "description": "Response for the ListSubscriptions method.",
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there are more subscriptions that match the\nrequest and this value should be passed to the next\n\u003ccode\u003eListSubscriptionsRequest\u003c/code\u003e to continue.",
- "type": "string"
- },
"subscription": {
"description": "The subscriptions that match the request.",
"type": "array",
"items": {
"$ref": "Subscription"
}
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there are more subscriptions that match the\nrequest and this value should be passed to the next\n\u003ccode\u003eListSubscriptionsRequest\u003c/code\u003e to continue.",
+ "type": "string"
}
},
- "id": "ListSubscriptionsResponse",
- "description": "Response for the ListSubscriptions method.",
- "type": "object"
+ "id": "ListSubscriptionsResponse"
},
"PubsubEvent": {
"description": "An event indicating a received message or truncation event.",
"type": "object",
"properties": {
"truncated": {
- "type": "boolean",
- "description": "Indicates that this subscription has been truncated."
+ "description": "Indicates that this subscription has been truncated.",
+ "type": "boolean"
},
"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"
},
"message": {
- "$ref": "PubsubMessage",
- "description": "A received message."
+ "description": "A received message.",
+ "$ref": "PubsubMessage"
},
"subscription": {
"description": "The subscription that received the event.",
@@ -725,8 +661,8 @@
"type": "string"
},
"message": {
- "$ref": "PubsubMessage",
- "description": "The message to publish."
+ "description": "The message to publish.",
+ "$ref": "PubsubMessage"
}
},
"id": "PublishRequest"
@@ -741,8 +677,8 @@
"type": "integer"
},
"name": {
- "type": "string",
- "description": "Name of the subscription."
+ "description": "Name of the subscription.",
+ "type": "string"
},
"topic": {
"description": "The name of the topic from which this subscription is receiving messages.",
@@ -756,6 +692,8 @@
"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.",
@@ -765,14 +703,90 @@
}
}
},
- "id": "PublishBatchResponse",
- "description": "Response for the PublishBatch method.",
- "type": "object"
+ "id": "PublishBatchResponse"
+ },
+ "Topic": {
+ "description": "A topic resource.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the topic.",
+ "type": "string"
+ }
+ },
+ "id": "Topic"
+ },
+ "Label": {
+ "description": "A key-value pair applied to a given object.",
+ "type": "object",
+ "properties": {
+ "strValue": {
+ "description": "A string value.",
+ "type": "string"
+ },
+ "numValue": {
+ "description": "An integer value.",
+ "format": "int64",
+ "type": "string"
+ },
+ "key": {
+ "description": "The key of a label is a syntactically valid URL (as per RFC 1738) with\nthe \"scheme\" and initial slashes omitted and with the additional\nrestrictions noted below. Each key should be globally unique. The\n\"host\" portion is called the \"namespace\" and is not necessarily\nresolvable to a network endpoint. Instead, the namespace indicates what\nsystem or entity defines the semantics of the label. Namespaces do not\nrestrict the set of objects to which a label may be associated.\n\nKeys are defined by the following grammar:\n\n key = hostname \"/\" kpath\n kpath = ksegment *[ \"/\" ksegment ]\n ksegment = alphadigit | *[ alphadigit | \"-\" | \"_\" | \".\" ]\n\nwhere \"hostname\" and \"alphadigit\" are defined as in RFC 1738.\n\nExample key:\n spanner.google.com/universe",
+ "type": "string"
+ }
+ },
+ "id": "Label"
+ },
+ "ModifyAckDeadlineRequest": {
+ "description": "Request for the ModifyAckDeadline method.",
+ "type": "object",
+ "properties": {
+ "subscription": {
+ "description": "Next Index: 5\nThe name of the subscription from which messages are being pulled.",
+ "type": "string"
+ },
+ "ackId": {
+ "description": "The acknowledgment ID. Either this or ack_ids must be populated,\nnot both.",
+ "type": "string"
+ },
+ "ackDeadlineSeconds": {
+ "description": "The new ack deadline with respect to the time this request was sent to the\nPub/Sub system. Must be \u003e= 0. For example, if the value is 10, the new ack\ndeadline will expire 10 seconds after the ModifyAckDeadline call was made.\nSpecifying zero may immediately make the message available for another pull\nrequest.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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": {
+ "subscription": {
+ "description": "The subscription from which messages should be pulled.",
+ "type": "string"
+ },
+ "returnImmediately": {
+ "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the Pull response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.",
+ "type": "boolean"
+ },
+ "maxEvents": {
+ "description": "The maximum number of PubsubEvents returned for this request. The Pub/Sub\nsystem may return fewer than the number of events specified.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "PullBatchRequest"
}
},
"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": "v1beta1a",
@@ -789,19 +803,5 @@
}
}
}
- },
- "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": "20180116",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "id": "pubsub:v1beta1a",
- "title": "Google Cloud Pub/Sub API",
- "discoveryVersion": "v1",
- "ownerName": "Google"
+ }
}
diff --git a/pubsub/v1beta2/pubsub-api.json b/pubsub/v1beta2/pubsub-api.json
index b5f8d8f..37547ee 100644
--- a/pubsub/v1beta2/pubsub-api.json
+++ b/pubsub/v1beta2/pubsub-api.json
@@ -1,22 +1,4 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/pubsub": {
- "description": "View and manage Pub/Sub topics and subscriptions"
- }
- }
- }
- },
- "servicePath": "",
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
- "kind": "discovery#restDescription",
- "rootUrl": "https://pubsub.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
"name": "pubsub",
"batchPath": "batch",
"revision": "20180116",
@@ -28,415 +10,27 @@
"resources": {
"projects": {
"resources": {
- "topics": {
- "methods": {
- "get": {
- "description": "Gets the configuration of a topic.",
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "topic": {
- "description": "The name of the topic to get.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "path": "v1beta2/{+topic}",
- "id": "pubsub.projects.topics.get"
- },
- "publish": {
- "httpMethod": "POST",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "PublishResponse"
- },
- "parameters": {
- "topic": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The messages in the request will be published on this topic."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:publish",
- "id": "pubsub.projects.topics.publish",
- "path": "v1beta2/{+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."
- },
- "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": "v1beta2/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
- "path": "v1beta2/{+resource}:testIamPermissions",
- "id": "pubsub.projects.topics.testIamPermissions"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "Name of the topic to delete.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.delete",
- "path": "v1beta2/{+topic}",
- "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`."
- },
- "list": {
- "flatPath": "v1beta2/projects/{projectsId}/topics",
- "path": "v1beta2/{+project}/topics",
- "id": "pubsub.projects.topics.list",
- "description": "Lists matching topics.",
- "response": {
- "$ref": "ListTopicsResponse"
- },
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET",
- "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": {
- "description": "Maximum number of topics 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 topics belong to."
- }
- }
- },
- "create": {
- "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": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "path": "v1beta2/{+name}",
- "id": "pubsub.projects.topics.create",
- "request": {
- "$ref": "Topic"
- },
- "description": "Creates the given topic with the given name."
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}: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."
- },
- "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/[^/]+/topics/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
- "path": "v1beta2/{+resource}:getIamPolicy",
- "id": "pubsub.projects.topics.getIamPolicy"
- }
- },
- "resources": {
- "subscriptions": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListTopicSubscriptionsResponse"
- },
- "parameterOrder": [
- "topic"
- ],
- "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": {
- "location": "query",
- "description": "Maximum number of subscription names to return.",
- "format": "int32",
- "type": "integer"
- },
- "topic": {
- "location": "path",
- "description": "The name of the topic that subscriptions are attached to.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}/subscriptions",
- "id": "pubsub.projects.topics.subscriptions.list",
- "path": "v1beta2/{+topic}/subscriptions",
- "description": "Lists the name of the subscriptions for this topic."
- }
- }
- }
- }
- },
"subscriptions": {
"methods": {
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "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."
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "subscription"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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",
- "id": "pubsub.projects.subscriptions.acknowledge",
- "path": "v1beta2/{+subscription}:acknowledge"
- },
- "modifyAckDeadline": {
- "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.",
- "request": {
- "$ref": "ModifyAckDeadlineRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "description": "The name of the subscription.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
- "path": "v1beta2/{+subscription}:modifyAckDeadline",
- "id": "pubsub.projects.subscriptions.modifyAckDeadline"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "subscription"
- ],
- "response": {
- "$ref": "Subscription"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "location": "path",
- "description": "The name of the subscription to get.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "id": "pubsub.projects.subscriptions.get",
- "path": "v1beta2/{+subscription}",
- "description": "Gets the configuration details of a subscription."
- },
"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"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -444,27 +38,10 @@
"https://www.googleapis.com/auth/pubsub"
],
"flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
- "id": "pubsub.projects.subscriptions.testIamPermissions",
- "path": "v1beta2/{+resource}:testIamPermissions"
+ "path": "v1beta2/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.subscriptions.testIamPermissions"
},
"modifyPushConfig": {
- "path": "v1beta2/{+subscription}:modifyPushConfig",
- "id": "pubsub.projects.subscriptions.modifyPushConfig",
- "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`.",
- "request": {
- "$ref": "ModifyPushConfigRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"parameters": {
"subscription": {
"description": "The name of the subscription.",
@@ -474,35 +51,28 @@
"location": "path"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig"
- },
- "delete": {
- "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
+ "id": "pubsub.projects.subscriptions.modifyPushConfig",
+ "path": "v1beta2/{+subscription}: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 subscription to delete.",
- "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}",
- "id": "pubsub.projects.subscriptions.delete",
- "path": "v1beta2/{+subscription}",
- "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."
+ }
},
"pull": {
+ "path": "v1beta2/{+subscription}:pull",
+ "id": "pubsub.projects.subscriptions.pull",
"description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.",
"request": {
"$ref": "PullRequest"
@@ -527,9 +97,33 @@
"location": "path"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
- "path": "v1beta2/{+subscription}:pull",
- "id": "pubsub.projects.subscriptions.pull"
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:pull"
+ },
+ "delete": {
+ "path": "v1beta2/{+subscription}",
+ "id": "pubsub.projects.subscriptions.delete",
+ "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription, or its topic unless the same topic is specified.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "subscription": {
+ "description": "The subscription to delete.",
+ "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}"
},
"list": {
"description": "Lists matching subscriptions.",
@@ -541,23 +135,23 @@
],
"httpMethod": "GET",
"parameters": {
- "project": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the cloud project that subscriptions belong to.",
- "required": true,
- "type": "string"
- },
"pageToken": {
- "location": "query",
"description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"description": "Maximum number of subscriptions to return.",
"format": "int32",
"type": "integer",
"location": "query"
+ },
+ "project": {
+ "description": "The name of the cloud project that subscriptions belong to.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -568,36 +162,11 @@
"path": "v1beta2/{+project}/subscriptions",
"id": "pubsub.projects.subscriptions.list"
},
- "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": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
- "path": "v1beta2/{+resource}:setIamPolicy",
- "id": "pubsub.projects.subscriptions.setIamPolicy"
- },
"create": {
+ "request": {
+ "$ref": "Subscription"
+ },
+ "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic. Note that\nfor REST API requests, you must specify a name.",
"httpMethod": "PUT",
"parameterOrder": [
"name"
@@ -620,11 +189,424 @@
],
"flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
"id": "pubsub.projects.subscriptions.create",
- "path": "v1beta2/{+name}",
+ "path": "v1beta2/{+name}"
+ },
+ "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/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
+ "id": "pubsub.projects.subscriptions.setIamPolicy",
+ "path": "v1beta2/{+resource}:setIamPolicy"
+ },
+ "getIamPolicy": {
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
+ "id": "pubsub.projects.subscriptions.getIamPolicy",
+ "path": "v1beta2/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ]
+ },
+ "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.",
+ "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"
+ },
+ "acknowledge": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "description": "The subscription whose message is being acknowledged.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
+ "path": "v1beta2/{+subscription}:acknowledge",
+ "id": "pubsub.projects.subscriptions.acknowledge",
+ "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": {
+ "parameters": {
+ "subscription": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The name of the subscription to get.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "id": "pubsub.projects.subscriptions.get",
+ "path": "v1beta2/{+subscription}",
+ "description": "Gets the configuration details of a subscription.",
+ "httpMethod": "GET",
+ "response": {
"$ref": "Subscription"
},
- "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic. Note that\nfor REST API requests, you must specify a name."
+ "parameterOrder": [
+ "subscription"
+ ]
+ }
+ }
+ },
+ "topics": {
+ "methods": {
+ "publish": {
+ "path": "v1beta2/{+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.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:publish"
+ },
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "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",
+ "id": "pubsub.projects.topics.testIamPermissions",
+ "path": "v1beta2/{+resource}:testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
+ },
+ "delete": {
+ "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"
+ }
+ },
+ "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}",
+ "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": {
+ "path": "v1beta2/{+project}/topics",
+ "id": "pubsub.projects.topics.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": {
+ "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.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics"
+ },
+ "create": {
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
+ "id": "pubsub.projects.topics.create",
+ "path": "v1beta2/{+name}",
+ "request": {
+ "$ref": "Topic"
+ },
+ "description": "Creates the given topic with the given name.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Topic"
+ }
+ },
+ "setIamPolicy": {
+ "id": "pubsub.projects.topics.setIamPolicy",
+ "path": "v1beta2/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "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"
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
+ "path": "v1beta2/{+resource}:getIamPolicy",
+ "id": "pubsub.projects.topics.getIamPolicy"
+ },
+ "get": {
+ "description": "Gets the configuration of a topic.",
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "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"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
+ "path": "v1beta2/{+topic}",
+ "id": "pubsub.projects.topics.get"
+ }
+ },
+ "resources": {
+ "subscriptions": {
+ "methods": {
+ "list": {
+ "description": "Lists the name of the subscriptions for this topic.",
+ "response": {
+ "$ref": "ListTopicSubscriptionsResponse"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of subscription names to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "topic": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "The name of the topic that subscriptions are attached to.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}/subscriptions",
+ "path": "v1beta2/{+topic}/subscriptions",
+ "id": "pubsub.projects.topics.subscriptions.list"
+ }
+ }
}
}
}
@@ -632,65 +614,10 @@
}
},
"parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
"access_token": {
+ "description": "OAuth access token.",
"type": "string",
- "location": "query",
- "description": "OAuth access token."
+ "location": "query"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
@@ -698,9 +625,9 @@
"location": "query"
},
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
"description": "Pretty-print response.",
@@ -714,16 +641,79 @@
"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"
+ },
+ "$.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"
+ ]
}
},
"schemas": {
"ModifyAckDeadlineRequest": {
+ "id": "ModifyAckDeadlineRequest",
"description": "Request for the ModifyAckDeadline method.",
"type": "object",
"properties": {
+ "ackIds": {
+ "description": "List of acknowledgment IDs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"ackId": {
"description": "The acknowledgment ID. Either this or ack_ids must be populated, but not\nboth.",
"type": "string"
@@ -732,39 +722,41 @@
"description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. Must be \u003e= 0. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero may immediately make the message available for\nanother pull request.",
"format": "int32",
"type": "integer"
- },
- "ackIds": {
- "description": "List of acknowledgment IDs.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
- },
- "id": "ModifyAckDeadlineRequest"
+ }
},
"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"
+ }
+ },
+ "ModifyPushConfigRequest": {
+ "id": "ModifyPushConfigRequest",
+ "description": "Request for the ModifyPushConfig method.",
+ "type": "object",
+ "properties": {
+ "pushConfig": {
+ "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` is not called.",
+ "$ref": "PushConfig"
+ }
+ }
},
"PubsubMessage": {
- "id": "PubsubMessage",
"description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
"type": "object",
"properties": {
"attributes": {
+ "description": "Optional attributes for this message.",
+ "type": "object",
"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.",
@@ -780,29 +772,19 @@
"format": "byte",
"type": "string"
}
- }
- },
- "ModifyPushConfigRequest": {
- "description": "Request for the ModifyPushConfig method.",
- "type": "object",
- "properties": {
- "pushConfig": {
- "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` is not called.",
- "$ref": "PushConfig"
- }
},
- "id": "ModifyPushConfigRequest"
+ "id": "PubsubMessage"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
"members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"type": "array",
"items": {
"type": "string"
- },
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n"
+ }
},
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
@@ -811,30 +793,6 @@
},
"id": "Binding"
},
- "ListTopicsResponse": {
- "description": "Response for the `ListTopics` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`."
- },
- "topics": {
- "description": "The resulting topics.",
- "type": "array",
- "items": {
- "$ref": "Topic"
- }
- }
- },
- "id": "ListTopicsResponse"
- },
- "Empty": {
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
- },
"AcknowledgeRequest": {
"description": "Request for the Acknowledge method.",
"type": "object",
@@ -849,7 +807,32 @@
},
"id": "AcknowledgeRequest"
},
+ "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": {}
+ },
+ "ListTopicsResponse": {
+ "id": "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"
+ }
+ }
+ }
+ },
"ListTopicSubscriptionsResponse": {
+ "description": "Response for the `ListTopicSubscriptions` method.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -864,8 +847,7 @@
}
}
},
- "id": "ListTopicSubscriptionsResponse",
- "description": "Response for the `ListTopicSubscriptions` method."
+ "id": "ListTopicSubscriptionsResponse"
},
"PullResponse": {
"description": "Response for the `Pull` method.",
@@ -882,6 +864,7 @@
"id": "PullResponse"
},
"ReceivedMessage": {
+ "id": "ReceivedMessage",
"description": "A message and its corresponding acknowledgment ID.",
"type": "object",
"properties": {
@@ -893,10 +876,10 @@
"description": "This ID can be used to acknowledge the received message.",
"type": "string"
}
- },
- "id": "ReceivedMessage"
+ }
},
"PushConfig": {
+ "id": "PushConfig",
"description": "Configuration for a push delivery endpoint.",
"type": "object",
"properties": {
@@ -911,10 +894,10 @@
"type": "string"
}
}
- },
- "id": "PushConfig"
+ }
},
"TestIamPermissionsResponse": {
+ "id": "TestIamPermissionsResponse",
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
@@ -925,26 +908,26 @@
"type": "string"
}
}
- },
- "id": "TestIamPermissionsResponse"
+ }
},
"PullRequest": {
"id": "PullRequest",
"description": "Request for the `Pull` method.",
"type": "object",
"properties": {
+ "returnImmediately": {
+ "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the `Pull` response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.",
+ "type": "boolean"
+ },
"maxMessages": {
"description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
"format": "int32",
"type": "integer"
- },
- "returnImmediately": {
- "description": "If this 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"
}
}
},
"ListSubscriptionsResponse": {
+ "description": "Response for the `ListSubscriptions` method.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -959,10 +942,10 @@
}
}
},
- "id": "ListSubscriptionsResponse",
- "description": "Response for the `ListSubscriptions` method."
+ "id": "ListSubscriptionsResponse"
},
"PublishRequest": {
+ "description": "Request for the Publish method.",
"type": "object",
"properties": {
"messages": {
@@ -973,10 +956,12 @@
}
}
},
- "id": "PublishRequest",
- "description": "Request for the Publish method."
+ "id": "PublishRequest"
},
"PublishResponse": {
+ "id": "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.",
@@ -985,36 +970,35 @@
"type": "string"
}
}
- },
- "id": "PublishResponse",
- "description": "Response for the `Publish` method.",
- "type": "object"
+ }
},
"Subscription": {
+ "description": "A subscription resource.",
"type": "object",
"properties": {
+ "name": {
+ "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
+ "type": "string"
+ },
"topic": {
"description": "The name of the topic from which this subscription is receiving messages.\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"
+ "$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": {
- "type": "integer",
"description": "This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for the ack\ndeadline. To override this value for a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if using pull.\nThe maximum custom deadline you can specify is 600 seconds (10 minutes).\n\nFor push delivery, this value is also used to set the request timeout for\nthe call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will eventually redeliver the message.\n\nIf this parameter is 0, a default value of 10 seconds is used.",
- "format": "int32"
- },
- "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"
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "Subscription",
- "description": "A subscription resource."
+ "id": "Subscription"
},
"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).",
@@ -1024,33 +1008,7 @@
}
}
},
- "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/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"
+ "id": "TestIamPermissionsRequest"
},
"Topic": {
"description": "A topic resource.",
@@ -1062,14 +1020,56 @@
}
},
"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/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"
}
},
+ "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"
+ "canonicalName": "Pubsub",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/pubsub": {
+ "description": "View and manage Pub/Sub topics and subscriptions"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
+ "servicePath": "",
+ "rootUrl": "https://pubsub.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com"
}
diff --git a/runtimeconfig/v1/runtimeconfig-api.json b/runtimeconfig/v1/runtimeconfig-api.json
index 1045980..d8e5f3d 100644
--- a/runtimeconfig/v1/runtimeconfig-api.json
+++ b/runtimeconfig/v1/runtimeconfig-api.json
@@ -1,121 +1,4 @@
{
- "id": "runtimeconfig:v1",
- "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
- "revision": "20180108",
- "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": {
- "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"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- }
- },
- "id": "Operation"
- },
- "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"
- }
- },
- "protocol": "rest",
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "canonicalName": "Cloud RuntimeConfig",
- "auth": {
- "oauth2": {
- "scopes": {
- "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"
- }
- }
- }
- },
"rootUrl": "https://runtimeconfig.googleapis.com/",
"ownerDomain": "google.com",
"name": "runtimeconfig",
@@ -127,39 +10,35 @@
"operations": {
"methods": {
"cancel": {
- "response": {
- "$ref": "Empty"
+ "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"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Empty"
+ },
"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",
- "pattern": "^operations/.+$",
- "location": "path"
+ "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"
- }
+ "path": "v1/{+name}:cancel"
},
"delete": {
- "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`.",
"response": {
"$ref": "Empty"
},
@@ -173,38 +52,27 @@
],
"parameters": {
"name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
"description": "The name of the operation resource to be deleted.",
"required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
+ "type": "string"
}
- }
+ },
+ "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`."
},
"list": {
+ "httpMethod": "GET",
"response": {
"$ref": "ListOperationsResponse"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
"parameters": {
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
"name": {
"description": "The name of the operation's parent resource.",
"required": true,
@@ -216,81 +84,42 @@
"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",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
"flatPath": "v1/operations",
- "path": "v1/{+name}",
"id": "runtimeconfig.operations.list",
+ "path": "v1/{+name}",
"description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
}
}
}
},
"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"
- },
- "$.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": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"oauth_token": {
"location": "query",
@@ -312,12 +141,183 @@
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
}
},
"version": "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": ""
+ "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": "20180108",
+ "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": {
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "canonicalName": "Cloud RuntimeConfig",
+ "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/cloudruntimeconfig": {
+ "description": "Manage your Google Cloud Platform services' runtime configuration"
+ }
+ }
+ }
+ }
}
diff --git a/runtimeconfig/v1beta1/runtimeconfig-api.json b/runtimeconfig/v1beta1/runtimeconfig-api.json
index aa6b49f..10ab697 100644
--- a/runtimeconfig/v1beta1/runtimeconfig-api.json
+++ b/runtimeconfig/v1beta1/runtimeconfig-api.json
@@ -1,998 +1,8 @@
{
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Runtime Configuration API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "configs": {
- "methods": {
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy",
- "id": "runtimeconfig.projects.configs.getIamPolicy"
- },
- "get": {
- "description": "Gets information about a RuntimeConfig resource.",
- "response": {
- "$ref": "RuntimeConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.get"
- },
- "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": {
- "description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}"
- },
- "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"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions"
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "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}",
- "id": "runtimeconfig.projects.configs.delete",
- "path": "v1beta1/{+name}",
- "description": "Deletes a RuntimeConfig resource."
- },
- "list": {
- "flatPath": "v1beta1/projects/{projectsId}/configs",
- "id": "runtimeconfig.projects.configs.list",
- "path": "v1beta1/{+parent}/configs",
- "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": {
- "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 [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ]
- },
- "create": {
- "flatPath": "v1beta1/projects/{projectsId}/configs",
- "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": {
- "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "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"
- }
- }
- },
- "setIamPolicy": {
- "path": "v1beta1/{+resource}:setIamPolicy",
- "id": "runtimeconfig.projects.configs.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy"
- }
- },
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListVariablesResponse"
- },
- "parameters": {
- "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": {
- "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 RuntimeConfig resource for which you want to list variables.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
- "id": "runtimeconfig.projects.configs.variables.list",
- "path": "v1beta1/{+parent}/variables"
- },
- "create": {
- "id": "runtimeconfig.projects.configs.variables.create",
- "path": "v1beta1/{+parent}/variables",
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Variable"
- },
- "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"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables"
- },
- "get": {
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.variables.get",
- "description": "Gets information about a single variable."
- },
- "watch": {
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path",
- "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:watch",
- "path": "v1beta1/{+name}:watch",
- "id": "runtimeconfig.projects.configs.variables.watch",
- "description": "Watches a specific variable and waits for a change in the variable's value.\nWhen there is a change, this method returns the new value or times out.\n\nIf a variable is deleted while being watched, the `variableState` state is\nset to `DELETED` and the method returns the last known variable `value`.\n\nIf you set the deadline for watching to a larger value than internal timeout\n(60 seconds), the current variable value is returned and the `variableState`\nwill be `VARIABLE_STATE_UNSPECIFIED`.\n\nTo learn more about creating a watcher, read the\n[Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable)\ndocumentation.",
- "request": {
- "$ref": "WatchVariableRequest"
- }
- },
- "update": {
- "request": {
- "$ref": "Variable"
- },
- "description": "Updates an existing variable with a new value.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Variable"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path",
- "description": "The name of the variable to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "id": "runtimeconfig.projects.configs.variables.update",
- "path": "v1beta1/{+name}"
- },
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
- }
- },
- "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": {
- "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": {
- "location": "path",
- "description": "The name of the variable to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
- }
- },
- "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."
- }
- }
- },
- "operations": {
- "methods": {
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.operations.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "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 operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$"
- }
- },
- "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."
- }
- }
- },
- "waiters": {
- "methods": {
- "create": {
- "description": "Creates a Waiter resource. This operation returns a long-running Operation\nresource which can be polled for completion. However, a waiter with the\ngiven name will exist (and can be retrieved) prior to the operation\ncompleting. If the operation fails, the failed Waiter resource will\nstill exist and must be deleted prior to subsequent creation attempts.",
- "request": {
- "$ref": "Waiter"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "requestId": {
- "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path",
- "description": "The path to the 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"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
- "path": "v1beta1/{+parent}/waiters",
- "id": "runtimeconfig.projects.configs.waiters.create"
- },
- "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/[^/]+/waiters/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.waiters.testIamPermissions"
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
- "location": "path",
- "description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
- "id": "runtimeconfig.projects.configs.waiters.delete",
- "path": "v1beta1/{+name}",
- "description": "Deletes the waiter with the specified name."
- },
- "list": {
- "id": "runtimeconfig.projects.configs.waiters.list",
- "path": "v1beta1/{+parent}/waiters",
- "description": "List waiters within the given configuration.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListWaitersResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "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": {
- "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters"
- },
- "get": {
- "description": "Gets information about a single waiter.",
- "response": {
- "$ref": "Waiter"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The fully-qualified name of the Waiter resource object to retrieve, in the\nformat:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.waiters.get"
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- }
- },
- "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": "20180108",
- "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "ListVariablesResponse": {
- "description": "Response for the `ListVariables()` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
- "type": "string"
- },
- "variables": {
- "description": "A list of variables and their values. The order of returned variable\nobjects is arbitrary.",
- "type": "array",
- "items": {
- "$ref": "Variable"
- }
- }
- },
- "id": "ListVariablesResponse"
- },
- "RuntimeConfig": {
- "description": "A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig\nservice. A RuntimeConfig resource consists of metadata and a hierarchy of\nvariables.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The resource name of a runtime config. The name must have the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an\narbitrary name that matches the\n`[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression.\nThe length of `[CONFIG_NAME]` must be less than 64 characters.\n\nYou pick the RuntimeConfig resource name, but the server will validate that\nthe name adheres to this format. After you create the resource, you cannot\nchange the resource's name.",
- "type": "string"
- },
- "description": {
- "description": "An optional description of the RuntimeConfig object.",
- "type": "string"
- }
- },
- "id": "RuntimeConfig"
- },
- "WatchVariableRequest": {
- "description": "Request for the `WatchVariable()` method.",
- "type": "object",
- "properties": {
- "newerThan": {
- "description": "If specified, checks the current timestamp of the variable and if the\ncurrent timestamp is newer than `newerThan` timestamp, the method returns\nimmediately.\n\nIf not specified or the variable has an older timestamp, the watcher waits\nfor a the value to change before returning.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "WatchVariableRequest"
- },
- "ListWaitersResponse": {
- "description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
- "type": "string"
- },
- "waiters": {
- "description": "Found waiters in the project.",
- "type": "array",
- "items": {
- "$ref": "Waiter"
- }
- }
- },
- "id": "ListWaitersResponse"
- },
- "Waiter": {
- "properties": {
- "error": {
- "description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set.",
- "$ref": "Status"
- },
- "failure": {
- "$ref": "EndCondition",
- "description": "[Optional] The failure condition of this waiter. If this condition is met,\n`done` will be set to `true` and the `error` code will be set to `ABORTED`.\nThe failure condition takes precedence over the success condition. If both\nconditions are met, a failure will be indicated. This value is optional; if\nno failure condition is set, the only failure scenario will be a timeout."
- },
- "success": {
- "description": "[Required] The success condition. If this condition is met, `done` will be\nset to `true` and the `error` value will remain unset. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated.",
- "$ref": "EndCondition"
- },
- "done": {
- "description": "[Output Only] If the value is `false`, it means the waiter is still waiting\nfor one of its conditions to be met.\n\nIf true, the waiter has finished. If the waiter finished due to a timeout\nor failure, `error` will be set.",
- "type": "boolean"
- },
- "createTime": {
- "description": "[Output Only] The instant at which this Waiter resource was created. Adding\nthe value of `timeout` to this instant yields the timeout deadline for the\nwaiter.",
- "format": "google-datetime",
- "type": "string"
- },
- "timeout": {
- "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from\nthe instant that `waiters().create` method is called. If this time elapses\nbefore the success or failure conditions are met, the waiter fails and sets\nthe `error` code to `DEADLINE_EXCEEDED`.",
- "format": "google-duration",
- "type": "string"
- },
- "name": {
- "description": "The name of the Waiter resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]\n\nThe `[PROJECT_ID]` must be a valid Google Cloud project ID,\nthe `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the\n`[WAITER_NAME]` must match RFC 1035 segment specification, and the length\nof `[WAITER_NAME]` must be less than 64 bytes.\n\nAfter you create a Waiter resource, you cannot change the resource name.",
- "type": "string"
- }
- },
- "id": "Waiter",
- "description": "A Waiter resource waits for some end condition within a RuntimeConfig resource\nto be met before it returns. For example, assume you have a distributed\nsystem where each node writes to a Variable resource indidicating the node's\nreadiness as part of the startup process.\n\nYou then configure a Waiter resource with the success condition set to wait\nuntil some number of nodes have checked in. Afterwards, your application\nruns some arbitrary code after the condition has been met and the waiter\nreturns successfully.\n\nOnce created, a Waiter resource is immutable.\n\nTo learn more about using waiters, read the\n[Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)\ndocumentation.",
- "type": "object"
- },
- "TestIamPermissionsRequest": {
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
- },
- "Variable": {
- "description": "Describes a single variable within a RuntimeConfig resource.\nThe name denotes the hierarchical variable name. For example,\n`ports/serving_port` is a valid variable name. The variable value is an\nopaque string and only leaf variables can have values (that is, variables\nthat do not have any child variables).",
- "type": "object",
- "properties": {
- "value": {
- "description": "The binary value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. The value must be\nbase64 encoded. Only one of `value` or `text` can be set.",
- "format": "byte",
- "type": "string"
- },
- "updateTime": {
- "description": "[Output Only] The time of the last variable update.",
- "format": "google-datetime",
- "type": "string"
- },
- "state": {
- "enumDescriptions": [
- "Default variable state.",
- "The variable was updated, while `variables().watch` was executing.",
- "The variable was deleted, while `variables().watch` was executing."
- ],
- "enum": [
- "VARIABLE_STATE_UNSPECIFIED",
- "UPDATED",
- "DELETED"
- ],
- "description": "[Ouput only] The current state of the variable. The variable state indicates\nthe outcome of the `variables().watch` call and is visible through the\n`get` and `list` calls.",
- "type": "string"
- },
- "name": {
- "description": "The name of the variable resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a\nvalid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system\nfile path naming.\n\nThe `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and\ndashes. Slashes are used as path element separators and are not part of the\n`[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one\nnon-slash character. Multiple slashes are coalesced into single slash\ncharacter. Each path segment should match\n[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.\nThe length of a `[VARIABLE_NAME]` must be less than 256 characters.\n\nOnce you create a variable, you cannot change the variable name.",
- "type": "string"
- },
- "text": {
- "description": "The string value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. For example,\n`text: \"my text value\"`. The string must be valid UTF-8.",
- "type": "string"
- }
- },
- "id": "Variable"
- },
- "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"
- },
"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",
@@ -1016,25 +26,40 @@
},
"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"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "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"
},
"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",
@@ -1043,20 +68,11 @@
"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"
+ "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`.",
@@ -1117,21 +133,212 @@
"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"
+ "id": "EndCondition",
+ "description": "The condition that a Waiter resource is waiting for.",
+ "type": "object"
+ },
+ "TestIamPermissionsResponse": {
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
+ },
+ "ListVariablesResponse": {
+ "description": "Response for the `ListVariables()` method.",
+ "type": "object",
+ "properties": {
+ "variables": {
+ "description": "A list of variables and their values. The order of returned variable\nobjects is arbitrary.",
+ "type": "array",
+ "items": {
+ "$ref": "Variable"
+ }
+ },
+ "nextPageToken": {
+ "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
+ "type": "string"
+ }
+ },
+ "id": "ListVariablesResponse"
+ },
+ "RuntimeConfig": {
+ "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"
+ }
+ },
+ "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.",
+ "type": "object",
+ "properties": {
+ "newerThan": {
+ "description": "If specified, checks the current timestamp of the variable and if the\ncurrent timestamp is newer than `newerThan` timestamp, the method returns\nimmediately.\n\nIf not specified or the variable has an older timestamp, the watcher waits\nfor a the value to change before returning.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "WatchVariableRequest"
+ },
+ "ListWaitersResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
+ "type": "string"
+ },
+ "waiters": {
+ "description": "Found waiters in the project.",
+ "type": "array",
+ "items": {
+ "$ref": "Waiter"
+ }
+ }
+ },
+ "id": "ListWaitersResponse",
+ "description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary.",
+ "type": "object"
+ },
+ "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": {
+ "$ref": "EndCondition",
+ "description": "[Optional] The failure condition of this waiter. If this condition is met,\n`done` will be set to `true` and the `error` code will be set to `ABORTED`.\nThe failure condition takes precedence over the success condition. If both\nconditions are met, a failure will be indicated. This value is optional; if\nno failure condition is set, the only failure scenario will be a timeout."
+ },
+ "success": {
+ "description": "[Required] The success condition. If this condition is met, `done` will be\nset to `true` and the `error` value will remain unset. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated.",
+ "$ref": "EndCondition"
+ },
+ "done": {
+ "description": "[Output Only] If the value is `false`, it means the waiter is still waiting\nfor one of its conditions to be met.\n\nIf true, the waiter has finished. If the waiter finished due to a timeout\nor failure, `error` will be set.",
+ "type": "boolean"
+ },
+ "createTime": {
+ "description": "[Output Only] The instant at which this Waiter resource was created. Adding\nthe value of `timeout` to this instant yields the timeout deadline for the\nwaiter.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "timeout": {
+ "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from\nthe instant that `waiters().create` method is called. If this time elapses\nbefore the success or failure conditions are met, the waiter fails and sets\nthe `error` code to `DEADLINE_EXCEEDED`.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the Waiter resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]\n\nThe `[PROJECT_ID]` must be a valid Google Cloud project ID,\nthe `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the\n`[WAITER_NAME]` must match RFC 1035 segment specification, and the length\nof `[WAITER_NAME]` must be less than 64 bytes.\n\nAfter you create a Waiter resource, you cannot change the resource name.",
+ "type": "string"
+ }
+ },
+ "id": "Waiter"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "Variable": {
+ "description": "Describes a single variable within a RuntimeConfig resource.\nThe name denotes the hierarchical variable name. For example,\n`ports/serving_port` is a valid variable name. The variable value is an\nopaque string and only leaf variables can have values (that is, variables\nthat do not have any child variables).",
+ "type": "object",
+ "properties": {
+ "updateTime": {
+ "description": "[Output Only] The time of the last variable update.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "Default variable state.",
+ "The variable was updated, while `variables().watch` was executing.",
+ "The variable was deleted, while `variables().watch` was executing."
+ ],
+ "enum": [
+ "VARIABLE_STATE_UNSPECIFIED",
+ "UPDATED",
+ "DELETED"
+ ],
+ "description": "[Ouput only] The current state of the variable. The variable state indicates\nthe outcome of the `variables().watch` call and is visible through the\n`get` and `list` calls.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the variable resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a\nvalid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system\nfile path naming.\n\nThe `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and\ndashes. Slashes are used as path element separators and are not part of the\n`[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one\nnon-slash character. Multiple slashes are coalesced into single slash\ncharacter. Each path segment should match\n[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.\nThe length of a `[VARIABLE_NAME]` must be less than 256 characters.\n\nOnce you create a variable, you cannot change the variable name.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The string value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. For example,\n`text: \"my text value\"`. The string must be valid UTF-8.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The binary value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. The value must be\nbase64 encoded. Only one of `value` or `text` can be set.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "Variable"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/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"
}
},
"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 RuntimeConfig",
"auth": {
@@ -1149,5 +356,798 @@
"rootUrl": "https://runtimeconfig.googleapis.com/",
"ownerDomain": "google.com",
"name": "runtimeconfig",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud Runtime Configuration API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "configs": {
+ "methods": {
+ "delete": {
+ "id": "runtimeconfig.projects.configs.delete",
+ "path": "v1beta1/{+name}",
+ "description": "Deletes a RuntimeConfig resource.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "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.",
+ "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": {
+ "location": "query",
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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": {
+ "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": {
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs",
+ "path": "v1beta1/{+parent}/configs",
+ "id": "runtimeconfig.projects.configs.create"
+ },
+ "setIamPolicy": {
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy",
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "id": "runtimeconfig.projects.configs.setIamPolicy"
+ },
+ "getIamPolicy": {
+ "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": {
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:getIamPolicy",
+ "path": "v1beta1/{+resource}:getIamPolicy",
+ "id": "runtimeconfig.projects.configs.getIamPolicy"
+ },
+ "get": {
+ "description": "Gets information about a RuntimeConfig resource.",
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.get"
+ },
+ "update": {
+ "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}",
+ "id": "runtimeconfig.projects.configs.update",
+ "path": "v1beta1/{+name}",
+ "request": {
+ "$ref": "RuntimeConfig"
+ },
+ "description": "Updates a RuntimeConfig resource. The configuration must exist beforehand."
+ },
+ "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"
+ }
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "get": {
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "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 operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}"
+ },
+ "testIamPermissions": {
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.operations.testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ]
+ }
+ }
+ },
+ "waiters": {
+ "methods": {
+ "delete": {
+ "id": "runtimeconfig.projects.configs.waiters.delete",
+ "path": "v1beta1/{+name}",
+ "description": "Deletes the waiter with the specified name.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}"
+ },
+ "list": {
+ "description": "List waiters within the given configuration.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListWaitersResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The path to the configuration for which you want to get a list of waiters.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
+ "id": "runtimeconfig.projects.configs.waiters.list",
+ "path": "v1beta1/{+parent}/waiters"
+ },
+ "get": {
+ "response": {
+ "$ref": "Waiter"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The fully-qualified name of the Waiter resource object to retrieve, in the\nformat:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.waiters.get",
+ "description": "Gets information about a single waiter."
+ },
+ "create": {
+ "description": "Creates a Waiter resource. This operation returns a long-running Operation\nresource which can be polled for completion. However, a waiter with the\ngiven name will exist (and can be retrieved) prior to the operation\ncompleting. If the operation fails, the failed Waiter resource will\nstill exist and must be deleted prior to subsequent creation attempts.",
+ "request": {
+ "$ref": "Waiter"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "requestId": {
+ "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
+ "path": "v1beta1/{+parent}/waiters",
+ "id": "runtimeconfig.projects.configs.waiters.create"
+ },
+ "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/[^/]+/waiters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.waiters.testIamPermissions"
+ }
+ }
+ },
+ "variables": {
+ "methods": {
+ "get": {
+ "description": "Gets information about a single variable.",
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path",
+ "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.variables.get"
+ },
+ "watch": {
+ "description": "Watches a specific variable and waits for a change in the variable's value.\nWhen there is a change, this method returns the new value or times out.\n\nIf a variable is deleted while being watched, the `variableState` state is\nset to `DELETED` and the method returns the last known variable `value`.\n\nIf you set the deadline for watching to a larger value than internal timeout\n(60 seconds), the current variable value is returned and the `variableState`\nwill be `VARIABLE_STATE_UNSPECIFIED`.\n\nTo learn more about creating a watcher, read the\n[Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable)\ndocumentation.",
+ "request": {
+ "$ref": "WatchVariableRequest"
+ },
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path",
+ "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:watch",
+ "path": "v1beta1/{+name}:watch",
+ "id": "runtimeconfig.projects.configs.variables.watch"
+ },
+ "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": {
+ "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",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
+ },
+ "delete": {
+ "description": "Deletes 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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.variables.delete"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListVariablesResponse"
+ },
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The path to the 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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
+ "id": "runtimeconfig.projects.configs.variables.list",
+ "path": "v1beta1/{+parent}/variables",
+ "description": "Lists variables within given a configuration, matching any provided filters.\nThis only lists variable names, not the values, unless `return_values` is\ntrue, in which case only variables that user has IAM permission to GetVariable\nwill be returned."
+ },
+ "create": {
+ "id": "runtimeconfig.projects.configs.variables.create",
+ "path": "v1beta1/{+parent}/variables",
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameters": {
+ "requestId": {
+ "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "description": "The path to the 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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "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": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "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",
+ "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": "20180108",
+ "discoveryVersion": "v1"
}
diff --git a/safebrowsing/v4/safebrowsing-api.json b/safebrowsing/v4/safebrowsing-api.json
index e638559..378db5e 100644
--- a/safebrowsing/v4/safebrowsing-api.json
+++ b/safebrowsing/v4/safebrowsing-api.json
@@ -1,19 +1,82 @@
{
- "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",
- "name": "safebrowsing",
- "batchPath": "batch",
- "id": "safebrowsing:v4",
- "documentationLink": "https://developers.google.com/safe-browsing/",
- "revision": "20180123",
"title": "Google Safe Browsing API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
+ "threatListUpdates": {
+ "methods": {
+ "fetch": {
+ "request": {
+ "$ref": "FetchThreatListUpdatesRequest"
+ },
+ "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
+ "response": {
+ "$ref": "FetchThreatListUpdatesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v4/threatListUpdates:fetch",
+ "path": "v4/threatListUpdates:fetch",
+ "id": "safebrowsing.threatListUpdates.fetch"
+ }
+ }
+ },
+ "threatHits": {
+ "methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {},
+ "flatPath": "v4/threatHits",
+ "id": "safebrowsing.threatHits.create",
+ "path": "v4/threatHits",
+ "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": {
+ "flatPath": "v4/encodedFullHashes/{encodedRequest}",
+ "id": "safebrowsing.encodedFullHashes.get",
+ "path": "v4/encodedFullHashes/{encodedRequest}",
+ "description": "",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "encodedRequest"
+ ],
+ "response": {
+ "$ref": "FindFullHashesResponse"
+ },
+ "parameters": {
+ "clientVersion": {
+ "location": "query",
+ "description": "The version of the client implementation.",
+ "type": "string"
+ },
+ "encodedRequest": {
+ "location": "path",
+ "description": "A serialized FindFullHashesRequest proto.",
+ "format": "byte",
+ "required": true,
+ "type": "string"
+ },
+ "clientId": {
+ "location": "query",
+ "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
"threatLists": {
"methods": {
"list": {
@@ -34,17 +97,17 @@
"methods": {
"find": {
"flatPath": "v4/threatMatches:find",
- "id": "safebrowsing.threatMatches.find",
"path": "v4/threatMatches:find",
+ "id": "safebrowsing.threatMatches.find",
"request": {
"$ref": "FindThreatMatchesRequest"
},
"description": "Finds the threat entries that match the Safe Browsing lists.",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "FindThreatMatchesResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {}
}
}
@@ -52,6 +115,10 @@
"fullHashes": {
"methods": {
"find": {
+ "request": {
+ "$ref": "FindFullHashesRequest"
+ },
+ "description": "Finds the full hashes that match the requested hash prefixes.",
"response": {
"$ref": "FindFullHashesResponse"
},
@@ -60,11 +127,7 @@
"parameters": {},
"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"
- }
+ "id": "safebrowsing.fullHashes.find"
}
}
},
@@ -72,18 +135,18 @@
"methods": {
"get": {
"description": "",
- "httpMethod": "GET",
- "parameterOrder": [
- "encodedRequest"
- ],
"response": {
"$ref": "FetchThreatListUpdatesResponse"
},
+ "parameterOrder": [
+ "encodedRequest"
+ ],
+ "httpMethod": "GET",
"parameters": {
"clientId": {
- "location": "query",
"description": "A client ID that uniquely identifies the client implementation of the Safe\nBrowsing API.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"clientVersion": {
"location": "query",
@@ -99,82 +162,8 @@
}
},
"flatPath": "v4/encodedUpdates/{encodedRequest}",
- "id": "safebrowsing.encodedUpdates.get",
- "path": "v4/encodedUpdates/{encodedRequest}"
- }
- }
- },
- "threatListUpdates": {
- "methods": {
- "fetch": {
- "request": {
- "$ref": "FetchThreatListUpdatesRequest"
- },
- "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "FetchThreatListUpdatesResponse"
- },
- "parameters": {},
- "flatPath": "v4/threatListUpdates:fetch",
- "id": "safebrowsing.threatListUpdates.fetch",
- "path": "v4/threatListUpdates:fetch"
- }
- }
- },
- "threatHits": {
- "methods": {
- "create": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "flatPath": "v4/threatHits",
- "path": "v4/threatHits",
- "id": "safebrowsing.threatHits.create",
- "description": "Reports a Safe Browsing threat list hit to Google. Only projects with\nTRUSTED_REPORTER visibility can use this method.",
- "request": {
- "$ref": "ThreatHit"
- }
- }
- }
- },
- "encodedFullHashes": {
- "methods": {
- "get": {
- "flatPath": "v4/encodedFullHashes/{encodedRequest}",
- "path": "v4/encodedFullHashes/{encodedRequest}",
- "id": "safebrowsing.encodedFullHashes.get",
- "description": "",
- "response": {
- "$ref": "FindFullHashesResponse"
- },
- "parameterOrder": [
- "encodedRequest"
- ],
- "httpMethod": "GET",
- "parameters": {
- "clientId": {
- "location": "query",
- "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
- "type": "string"
- },
- "clientVersion": {
- "location": "query",
- "description": "The version of the client implementation.",
- "type": "string"
- },
- "encodedRequest": {
- "location": "path",
- "description": "A serialized FindFullHashesRequest proto.",
- "format": "byte",
- "required": true,
- "type": "string"
- }
- }
+ "path": "v4/encodedUpdates/{encodedRequest}",
+ "id": "safebrowsing.encodedUpdates.get"
}
}
}
@@ -186,26 +175,26 @@
"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": {
+ "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.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"fields": {
"location": "query",
@@ -217,12 +206,9 @@
"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"
@@ -231,8 +217,11 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
"type": "string"
},
"alt": {
@@ -262,139 +251,53 @@
"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"
}
},
"schemas": {
- "RawIndices": {
- "description": "A set of raw indices to remove from a local list.",
+ "ThreatEntrySet": {
+ "description": "A set of threats that should be added or removed from a client's local\ndatabase.",
"type": "object",
"properties": {
- "indices": {
- "description": "The indices to remove from a lexicographically-sorted local list.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "id": "RawIndices"
- },
- "ThreatSource": {
- "description": "A single resource related to a threat hit.",
- "type": "object",
- "properties": {
- "referrer": {
- "description": "Referrer of the resource. Only set if the referrer is available.",
- "type": "string"
- },
- "type": {
+ "compressionType": {
+ "description": "The compression type for the entries in this set.",
+ "type": "string",
"enumDescriptions": [
"Unknown.",
- "The URL that matched the threat list (for which GetFullHash returned a\nvalid hash).",
- "The final top-level URL of the tab that the client was browsing when the\nmatch occurred.",
- "A redirect URL that was fetched before hitting the final TAB_URL.",
- "A resource loaded within the final TAB_URL."
+ "Raw, uncompressed data.",
+ "Rice-Golomb encoded data."
],
"enum": [
- "THREAT_SOURCE_TYPE_UNSPECIFIED",
- "MATCHING_URL",
- "TAB_URL",
- "TAB_REDIRECT",
- "TAB_RESOURCE"
- ],
- "description": "The type of source reported.",
- "type": "string"
+ "COMPRESSION_TYPE_UNSPECIFIED",
+ "RAW",
+ "RICE"
+ ]
},
- "url": {
- "description": "The URL of the resource.",
- "type": "string"
+ "riceIndices": {
+ "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delta encoded\nand stored as encoded_data.",
+ "$ref": "RiceDeltaEncoding"
},
- "remoteIp": {
- "description": "The remote IP of the resource in ASCII format. Either IPv4 or IPv6.",
- "type": "string"
+ "rawIndices": {
+ "$ref": "RawIndices",
+ "description": "The raw removal indices for a local list."
+ },
+ "rawHashes": {
+ "$ref": "RawHashes",
+ "description": "The raw SHA256-formatted entries."
+ },
+ "riceHashes": {
+ "description": "The encoded 4-byte prefixes of SHA256-formatted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data.",
+ "$ref": "RiceDeltaEncoding"
}
},
- "id": "ThreatSource"
- },
- "UserInfo": {
- "description": "Details about the user that encountered the threat.",
- "type": "object",
- "properties": {
- "userId": {
- "description": "Unique user identifier defined by the client.",
- "format": "byte",
- "type": "string"
- },
- "regionCode": {
- "description": "The UN M.49 region code associated with the user's location.",
- "type": "string"
- }
- },
- "id": "UserInfo"
- },
- "FetchThreatListUpdatesResponse": {
- "type": "object",
- "properties": {
- "listUpdateResponses": {
- "description": "The list updates requested by the clients.",
- "type": "array",
- "items": {
- "$ref": "ListUpdateResponse"
- }
- },
- "minimumWaitDuration": {
- "description": "The minimum duration the client must wait before issuing any update\nrequest. If this field is not set clients may update as soon as they want.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "FetchThreatListUpdatesResponse"
- },
- "FindFullHashesResponse": {
- "type": "object",
- "properties": {
- "matches": {
- "description": "The full hashes that matched the requested prefixes.",
- "type": "array",
- "items": {
- "$ref": "ThreatMatch"
- }
- },
- "negativeCacheDuration": {
- "description": "For requested entities that did not match the threat list, how long to\ncache the response.",
- "format": "google-duration",
- "type": "string"
- },
- "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": {
- "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"
+ "id": "ThreatEntrySet"
},
"ThreatHit": {
"type": "object",
"properties": {
"threatType": {
- "description": "The threat type reported.",
- "type": "string",
"enumDescriptions": [
"Unknown.",
"Malware threat type.",
@@ -426,7 +329,9 @@
"CLIENT_INCIDENT_WHITELIST",
"APK_MALWARE_OFFLINE",
"SUBRESOURCE_FILTER"
- ]
+ ],
+ "description": "The threat type reported.",
+ "type": "string"
},
"resources": {
"description": "The resources related to the threat hit.",
@@ -440,90 +345,7 @@
"$ref": "ThreatEntry"
},
"platformType": {
- "enumDescriptions": [
- "Unknown platform.",
- "Threat posed to Windows.",
- "Threat posed to Linux.",
- "Threat posed to Android.",
- "Threat posed to OS X.",
- "Threat posed to iOS.",
- "Threat posed to at least one of the defined platforms.",
- "Threat posed to all defined platforms.",
- "Threat posed to Chrome."
- ],
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ],
"description": "The platform type reported.",
- "type": "string"
- },
- "userInfo": {
- "$ref": "UserInfo",
- "description": "Details about the user that encountered the threat."
- },
- "clientInfo": {
- "description": "Client-reported identification.",
- "$ref": "ClientInfo"
- }
- },
- "id": "ThreatHit"
- },
- "ThreatEntrySet": {
- "description": "A set of threats that should be added or removed from a client's local\ndatabase.",
- "type": "object",
- "properties": {
- "compressionType": {
- "enumDescriptions": [
- "Unknown.",
- "Raw, uncompressed data.",
- "Rice-Golomb encoded data."
- ],
- "enum": [
- "COMPRESSION_TYPE_UNSPECIFIED",
- "RAW",
- "RICE"
- ],
- "description": "The compression type for the entries in this set.",
- "type": "string"
- },
- "riceIndices": {
- "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delta encoded\nand stored as encoded_data.",
- "$ref": "RiceDeltaEncoding"
- },
- "rawIndices": {
- "description": "The raw removal indices for a local list.",
- "$ref": "RawIndices"
- },
- "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": {
- "description": "The type of platform at risk by entries present in the list.",
"type": "string",
"enumDescriptions": [
"Unknown platform.",
@@ -548,7 +370,55 @@
"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": {
+ "state": {
+ "description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).",
+ "format": "byte",
+ "type": "string"
+ },
+ "platformType": {
+ "enumDescriptions": [
+ "Unknown platform.",
+ "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 type of platform at risk by entries present in the list.",
+ "type": "string"
+ },
"threatType": {
+ "description": "The type of threat posed by entries present in the list.",
+ "type": "string",
"enumDescriptions": [
"Unknown.",
"Malware threat type.",
@@ -580,9 +450,7 @@
"CLIENT_INCIDENT_WHITELIST",
"APK_MALWARE_OFFLINE",
"SUBRESOURCE_FILTER"
- ],
- "description": "The type of threat posed by entries present in the list.",
- "type": "string"
+ ]
},
"constraints": {
"description": "The constraints associated with this request.",
@@ -627,21 +495,21 @@
"type": "string"
},
"supportedCompressions": {
- "description": "The compression types supported by the client.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "COMPRESSION_TYPE_UNSPECIFIED",
- "RAW",
- "RICE"
- ]
- },
"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.",
@@ -713,6 +581,8 @@
"type": "object",
"properties": {
"platformType": {
+ "description": "The platform type targeted by the list's entries.",
+ "type": "string",
"enumDescriptions": [
"Unknown platform.",
"Threat posed to Windows.",
@@ -734,9 +604,7 @@
"ANY_PLATFORM",
"ALL_PLATFORMS",
"CHROME"
- ],
- "description": "The platform type targeted by the list's entries.",
- "type": "string"
+ ]
},
"threatType": {
"description": "The threat type posed by the list's entries.",
@@ -803,13 +671,13 @@
"description": "The client metadata associated with Safe Browsing API requests.",
"type": "object",
"properties": {
- "clientVersion": {
- "description": "The version of the client implementation.",
- "type": "string"
- },
"clientId": {
"description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
"type": "string"
+ },
+ "clientVersion": {
+ "description": "The version of the client implementation.",
+ "type": "string"
}
},
"id": "ClientInfo"
@@ -818,10 +686,47 @@
"description": "The information regarding one or more threats that a client submits when\nchecking for matches in threat lists.",
"type": "object",
"properties": {
+ "platformTypes": {
+ "enumDescriptions": [
+ "Unknown platform.",
+ "Threat posed to Windows.",
+ "Threat posed to Linux.",
+ "Threat posed to Android.",
+ "Threat posed to OS X.",
+ "Threat posed to iOS.",
+ "Threat posed to at least one of the defined platforms.",
+ "Threat posed to all defined platforms.",
+ "Threat posed to Chrome."
+ ],
+ "description": "The platform types to be checked.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
+ ],
+ "type": "string"
+ }
+ },
+ "threatEntries": {
+ "description": "The threat entries to be checked.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatEntry"
+ }
+ },
"threatEntryTypes": {
"description": "The entry types to be checked.",
"type": "array",
"items": {
+ "type": "string",
"enum": [
"THREAT_ENTRY_TYPE_UNSPECIFIED",
"URL",
@@ -830,8 +735,7 @@
"CHROME_EXTENSION",
"FILENAME",
"CERT"
- ],
- "type": "string"
+ ]
},
"enumDescriptions": [
"Unspecified.",
@@ -844,22 +748,6 @@
]
},
"threatTypes": {
- "enumDescriptions": [
- "Unknown.",
- "Malware threat type.",
- "Social engineering threat type.",
- "Unwanted software threat type.",
- "Potentially harmful application threat type.",
- "Social engineering threat type for internal use.",
- "API abuse threat type.",
- "Malicious binary threat type.",
- "Client side detection whitelist threat type.",
- "Client side download detection whitelist threat type.",
- "Client incident threat type.",
- "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
- "List used for offline APK checks in PAM.",
- "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
- ],
"description": "The threat types to be checked.",
"type": "array",
"items": {
@@ -880,43 +768,23 @@
"SUBRESOURCE_FILTER"
],
"type": "string"
- }
- },
- "platformTypes": {
- "description": "The platform types to be checked.",
- "type": "array",
- "items": {
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ],
- "type": "string"
},
"enumDescriptions": [
- "Unknown platform.",
- "Threat posed to Windows.",
- "Threat posed to Linux.",
- "Threat posed to Android.",
- "Threat posed to OS X.",
- "Threat posed to iOS.",
- "Threat posed to at least one of the defined platforms.",
- "Threat posed to all defined platforms.",
- "Threat posed to Chrome."
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type.",
+ "Social engineering threat type for internal use.",
+ "API abuse threat type.",
+ "Malicious binary threat type.",
+ "Client side detection whitelist threat type.",
+ "Client side download detection whitelist threat type.",
+ "Client incident threat type.",
+ "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
+ "List used for offline APK checks in PAM.",
+ "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
]
- },
- "threatEntries": {
- "description": "The threat entries to be checked.",
- "type": "array",
- "items": {
- "$ref": "ThreatEntry"
- }
}
},
"id": "ThreatInfo"
@@ -963,8 +831,8 @@
"type": "object",
"properties": {
"apiClient": {
- "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation.",
- "$ref": "ClientInfo"
+ "$ref": "ClientInfo",
+ "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation."
},
"clientStates": {
"description": "The current client states for each of the client's local threat lists.",
@@ -1007,79 +875,6 @@
"description": "An update to an individual list.",
"type": "object",
"properties": {
- "additions": {
- "description": "A set of entries to add to a local threat type's list. Repeated to allow\nfor a combination of compressed and raw data to be sent in a single\nresponse.",
- "type": "array",
- "items": {
- "$ref": "ThreatEntrySet"
- }
- },
- "responseType": {
- "enumDescriptions": [
- "Unknown.",
- "Partial updates are applied to the client's existing local database.",
- "Full updates replace the client's entire local database. This means\nthat either the client was seriously out-of-date or the client is\nbelieved to be corrupt."
- ],
- "enum": [
- "RESPONSE_TYPE_UNSPECIFIED",
- "PARTIAL_UPDATE",
- "FULL_UPDATE"
- ],
- "description": "The type of response. This may indicate that an action is required by the\nclient when the response is received.",
- "type": "string"
- },
- "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."
- },
- "threatType": {
- "enumDescriptions": [
- "Unknown.",
- "Malware threat type.",
- "Social engineering threat type.",
- "Unwanted software threat type.",
- "Potentially harmful application threat type.",
- "Social engineering threat type for internal use.",
- "API abuse threat type.",
- "Malicious binary threat type.",
- "Client side detection whitelist threat type.",
- "Client side download detection whitelist threat type.",
- "Client incident threat type.",
- "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
- "List used for offline APK checks in PAM.",
- "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
- ],
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION",
- "SOCIAL_ENGINEERING_INTERNAL",
- "API_ABUSE",
- "MALICIOUS_BINARY",
- "CSD_WHITELIST",
- "CSD_DOWNLOAD_WHITELIST",
- "CLIENT_INCIDENT",
- "CLIENT_INCIDENT_WHITELIST",
- "APK_MALWARE_OFFLINE",
- "SUBRESOURCE_FILTER"
- ],
- "description": "The 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"
- }
- },
"platformType": {
"description": "The platform type for which data is returned.",
"type": "string",
@@ -1127,70 +922,33 @@
],
"description": "The format of the threats.",
"type": "string"
- }
- },
- "id": "ListUpdateResponse"
- },
- "ThreatMatch": {
- "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
- "type": "object",
- "properties": {
- "platformType": {
- "enumDescriptions": [
- "Unknown platform.",
- "Threat posed to Windows.",
- "Threat posed to Linux.",
- "Threat posed to Android.",
- "Threat posed to OS X.",
- "Threat posed to iOS.",
- "Threat posed to at least one of the defined platforms.",
- "Threat posed to all defined platforms.",
- "Threat posed to Chrome."
- ],
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ],
- "description": "The platform type matching this threat.",
- "type": "string"
},
- "threatEntryType": {
- "description": "The threat entry type matching this threat.",
+ "additions": {
+ "description": "A set of entries to add to a local threat type's list. Repeated to allow\nfor a combination of compressed and raw data to be sent in a single\nresponse.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatEntrySet"
+ }
+ },
+ "checksum": {
+ "description": "The expected SHA256 hash of the client state; that is, of the sorted list\nof all hashes present in the database after applying the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later.",
+ "$ref": "Checksum"
+ },
+ "responseType": {
+ "description": "The type of response. This may indicate that an action is required by the\nclient when the response is received.",
"type": "string",
"enumDescriptions": [
- "Unspecified.",
- "A URL.",
- "An executable program.",
- "An IP range.",
- "Chrome extension.",
- "Filename.",
- "CERT"
+ "Unknown.",
+ "Partial updates are applied to the client's existing local database.",
+ "Full updates replace the client's entire local database. This means\nthat either the client was seriously out-of-date or the client is\nbelieved to be corrupt."
],
"enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE",
- "CHROME_EXTENSION",
- "FILENAME",
- "CERT"
+ "RESPONSE_TYPE_UNSPECIFIED",
+ "PARTIAL_UPDATE",
+ "FULL_UPDATE"
]
},
- "cacheDuration": {
- "description": "The cache lifetime for the returned match. Clients must not cache this\nresponse for more than this duration to avoid false positives.",
- "format": "google-duration",
- "type": "string"
- },
"threatType": {
- "description": "The threat type matching this threat.",
- "type": "string",
"enumDescriptions": [
"Unknown.",
"Malware threat type.",
@@ -1222,11 +980,121 @@
"CLIENT_INCIDENT_WHITELIST",
"APK_MALWARE_OFFLINE",
"SUBRESOURCE_FILTER"
+ ],
+ "description": "The threat type for which data is returned.",
+ "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"
+ },
+ "ThreatMatch": {
+ "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
+ "type": "object",
+ "properties": {
+ "platformType": {
+ "description": "The platform type matching this threat.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown platform.",
+ "Threat posed to Windows.",
+ "Threat posed to Linux.",
+ "Threat posed to Android.",
+ "Threat posed to OS X.",
+ "Threat posed to iOS.",
+ "Threat posed to at least one of the defined platforms.",
+ "Threat posed to all defined platforms.",
+ "Threat posed to Chrome."
+ ],
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
]
},
+ "threatEntryType": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "A URL.",
+ "An executable program.",
+ "An IP range.",
+ "Chrome extension.",
+ "Filename.",
+ "CERT"
+ ],
+ "enum": [
+ "THREAT_ENTRY_TYPE_UNSPECIFIED",
+ "URL",
+ "EXECUTABLE",
+ "IP_RANGE",
+ "CHROME_EXTENSION",
+ "FILENAME",
+ "CERT"
+ ],
+ "description": "The threat entry type matching this threat.",
+ "type": "string"
+ },
+ "cacheDuration": {
+ "description": "The cache lifetime for the returned match. Clients must not cache this\nresponse for more than this duration to avoid false positives.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "threatType": {
+ "enumDescriptions": [
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type.",
+ "Social engineering threat type for internal use.",
+ "API abuse threat type.",
+ "Malicious binary threat type.",
+ "Client side detection whitelist threat type.",
+ "Client side download detection whitelist threat type.",
+ "Client incident threat type.",
+ "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
+ "List used for offline APK checks in PAM.",
+ "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
+ ],
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "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"
+ },
"threatEntryMetadata": {
- "description": "Optional metadata associated with this threat.",
- "$ref": "ThreatEntryMetadata"
+ "$ref": "ThreatEntryMetadata",
+ "description": "Optional metadata associated with this threat."
},
"threat": {
"$ref": "ThreatEntry",
@@ -1260,13 +1128,13 @@
"description": "A single metadata entry.",
"type": "object",
"properties": {
- "value": {
- "description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
+ "key": {
+ "description": "The metadata entry key. For JSON requests, the key is base64-encoded.",
"format": "byte",
"type": "string"
},
- "key": {
- "description": "The metadata entry key. For JSON requests, the key is base64-encoded.",
+ "value": {
+ "description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
"format": "byte",
"type": "string"
}
@@ -1278,8 +1146,8 @@
"type": "object",
"properties": {
"client": {
- "description": "The client metadata.",
- "$ref": "ClientInfo"
+ "$ref": "ClientInfo",
+ "description": "The client metadata."
},
"threatInfo": {
"description": "The lists and entries to be checked for matches.",
@@ -1287,6 +1155,127 @@
}
},
"id": "FindThreatMatchesRequest"
+ },
+ "ThreatSource": {
+ "description": "A single resource related to a threat hit.",
+ "type": "object",
+ "properties": {
+ "referrer": {
+ "description": "Referrer of the resource. Only set if the referrer is available.",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unknown.",
+ "The URL that matched the threat list (for which GetFullHash returned a\nvalid hash).",
+ "The final top-level URL of the tab that the client was browsing when the\nmatch occurred.",
+ "A redirect URL that was fetched before hitting the final TAB_URL.",
+ "A resource loaded within the final TAB_URL."
+ ],
+ "enum": [
+ "THREAT_SOURCE_TYPE_UNSPECIFIED",
+ "MATCHING_URL",
+ "TAB_URL",
+ "TAB_REDIRECT",
+ "TAB_RESOURCE"
+ ],
+ "description": "The type of source reported.",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL of the resource.",
+ "type": "string"
+ },
+ "remoteIp": {
+ "description": "The remote IP of the resource in ASCII format. Either IPv4 or IPv6.",
+ "type": "string"
+ }
+ },
+ "id": "ThreatSource"
+ },
+ "RawIndices": {
+ "description": "A set of raw indices to remove from a local list.",
+ "type": "object",
+ "properties": {
+ "indices": {
+ "description": "The indices to remove from a lexicographically-sorted local list.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "id": "RawIndices"
+ },
+ "UserInfo": {
+ "description": "Details about the user that encountered the threat.",
+ "type": "object",
+ "properties": {
+ "userId": {
+ "description": "Unique user identifier defined by the client.",
+ "format": "byte",
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "The UN M.49 region code associated with the user's location.",
+ "type": "string"
+ }
+ },
+ "id": "UserInfo"
+ },
+ "FetchThreatListUpdatesResponse": {
+ "type": "object",
+ "properties": {
+ "listUpdateResponses": {
+ "description": "The list updates requested by the clients.",
+ "type": "array",
+ "items": {
+ "$ref": "ListUpdateResponse"
+ }
+ },
+ "minimumWaitDuration": {
+ "description": "The minimum duration the client must wait before issuing any update\nrequest. If this field is not set clients may update as soon as they want.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "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",
+ "items": {
+ "$ref": "ThreatMatch"
+ }
+ },
+ "negativeCacheDuration": {
+ "description": "For requested entities that did not match the threat list, how long to\ncache the response.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "FindFullHashesResponse"
}
},
"protocol": "rest",
@@ -1295,5 +1284,16 @@
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"version": "v4",
- "baseUrl": "https://safebrowsing.googleapis.com/"
+ "baseUrl": "https://safebrowsing.googleapis.com/",
+ "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",
+ "name": "safebrowsing",
+ "batchPath": "batch",
+ "revision": "20180123",
+ "id": "safebrowsing:v4",
+ "documentationLink": "https://developers.google.com/safe-browsing/"
}
diff --git a/script/v1/script-api.json b/script/v1/script-api.json
index 075364a..28bb545 100644
--- a/script/v1/script-api.json
+++ b/script/v1/script-api.json
@@ -1,247 +1,714 @@
{
- "schemas": {
- "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"
- },
- "GoogleAppsScriptTypeScopeSet": {
- "description": "A set of scopes. No duplicates are permitted.",
- "type": "object",
- "properties": {
- "values": {
- "description": "List of scope values in the set.",
- "type": "array",
- "items": {
- "$ref": "GoogleAppsScriptTypeScope"
- }
- }
- },
- "id": "GoogleAppsScriptTypeScopeSet"
- },
- "GoogleAppsScriptTypeScope": {
- "description": "Represents an authorization scope.",
- "type": "object",
- "properties": {
- "authorizer": {
- "enumDescriptions": [
- "Authorizer unspecified.",
- "Developer authorized scope.",
- "End user authorized scope."
+ "resources": {
+ "projects": {
+ "methods": {
+ "getContent": {
+ "response": {
+ "$ref": "Content"
+ },
+ "parameterOrder": [
+ "scriptId"
],
- "enum": [
- "SCOPE_AUTHORIZER_UNSPECIFIED",
- "AUTHORIZED_BY_DEVELOPER",
- "AUTHORIZED_BY_END_USER"
- ],
- "description": "Who authorized the scope.",
- "type": "string"
+ "httpMethod": "GET",
+ "parameters": {
+ "versionNumber": {
+ "description": "The version number of the project to retrieve. If not provided, the\nproject's HEAD version is returned.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "scriptId": {
+ "description": "The script project's Drive ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{scriptId}/content",
+ "path": "v1/projects/{scriptId}/content",
+ "id": "script.projects.getContent",
+ "description": "Gets the content of the script project, including the code source and\nmetadata for each script file."
},
- "name": {
- "description": "The scope's identifying string.",
- "type": "string"
+ "getMetrics": {
+ "flatPath": "v1/projects/{scriptId}/metrics",
+ "path": "v1/projects/{scriptId}/metrics",
+ "id": "script.projects.getMetrics",
+ "description": "Get metrics data for scripts, such as number of executions and\nactive users.",
+ "response": {
+ "$ref": "Metrics"
+ },
+ "parameterOrder": [
+ "scriptId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "metricsGranularity": {
+ "location": "query",
+ "enum": [
+ "UNSPECIFIED_GRANULARITY",
+ "WEEKLY",
+ "DAILY"
+ ],
+ "description": "Required field indicating what granularity of metrics are returned.",
+ "type": "string"
+ },
+ "metricsFilter.deploymentId": {
+ "description": "Optional field indicating a specific deployment to retrieve metrics from.",
+ "type": "string",
+ "location": "query"
+ },
+ "scriptId": {
+ "location": "path",
+ "description": "Required field indicating the script to get metrics for.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "get": {
+ "flatPath": "v1/projects/{scriptId}",
+ "id": "script.projects.get",
+ "path": "v1/projects/{scriptId}",
+ "description": "Gets a script project's metadata.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [
+ "scriptId"
+ ],
+ "parameters": {
+ "scriptId": {
+ "description": "The script project's Drive ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
+ },
+ "updateContent": {
+ "id": "script.projects.updateContent",
+ "path": "v1/projects/{scriptId}/content",
+ "request": {
+ "$ref": "Content"
+ },
+ "description": "Updates the content of the specified script project.\nThis content is stored as the HEAD version, and is used when the script is\nexecuted as a trigger, in the script editor, in add-on preview mode, or as\na web app or Apps Script API in development mode. This clears all the\nexisting files in the project.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "scriptId"
+ ],
+ "response": {
+ "$ref": "Content"
+ },
+ "parameters": {
+ "scriptId": {
+ "description": "The script project's Drive ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{scriptId}/content"
+ },
+ "create": {
+ "description": "Creates a new, empty script project with no script files and a base\nmanifest file.",
+ "request": {
+ "$ref": "CreateProjectRequest"
+ },
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v1/projects",
+ "path": "v1/projects",
+ "id": "script.projects.create"
}
},
- "id": "GoogleAppsScriptTypeScope"
- },
- "ListVersionsResponse": {
- "description": "Response with the list of the versions for the specified script project.",
- "type": "object",
- "properties": {
+ "resources": {
+ "deployments": {
+ "methods": {
+ "update": {
+ "response": {
+ "$ref": "Deployment"
+ },
+ "parameterOrder": [
+ "scriptId",
+ "deploymentId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "scriptId": {
+ "location": "path",
+ "description": "The script project's Drive ID.",
+ "required": true,
+ "type": "string"
+ },
+ "deploymentId": {
+ "location": "path",
+ "description": "The deployment ID for this deployment.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{scriptId}/deployments/{deploymentId}",
+ "path": "v1/projects/{scriptId}/deployments/{deploymentId}",
+ "id": "script.projects.deployments.update",
+ "request": {
+ "$ref": "UpdateDeploymentRequest"
+ },
+ "description": "Updates a deployment of an Apps Script project."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "scriptId"
+ ],
+ "response": {
+ "$ref": "Deployment"
+ },
+ "parameters": {
+ "scriptId": {
+ "location": "path",
+ "description": "The script project's Drive ID.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{scriptId}/deployments",
+ "id": "script.projects.deployments.create",
+ "path": "v1/projects/{scriptId}/deployments",
+ "request": {
+ "$ref": "DeploymentConfig"
+ },
+ "description": "Creates a deployment of an Apps Script project."
+ },
+ "delete": {
+ "description": "Deletes a deployment of an Apps Script project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "scriptId",
+ "deploymentId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "scriptId": {
+ "location": "path",
+ "description": "The script project's Drive ID.",
+ "required": true,
+ "type": "string"
+ },
+ "deploymentId": {
+ "location": "path",
+ "description": "The deployment ID to be undeployed.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{scriptId}/deployments/{deploymentId}",
+ "path": "v1/projects/{scriptId}/deployments/{deploymentId}",
+ "id": "script.projects.deployments.delete"
+ },
+ "get": {
+ "flatPath": "v1/projects/{scriptId}/deployments/{deploymentId}",
+ "path": "v1/projects/{scriptId}/deployments/{deploymentId}",
+ "id": "script.projects.deployments.get",
+ "description": "Gets a deployment of an Apps Script project.",
+ "response": {
+ "$ref": "Deployment"
+ },
+ "parameterOrder": [
+ "scriptId",
+ "deploymentId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "scriptId": {
+ "description": "The script project's Drive ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "deploymentId": {
+ "location": "path",
+ "description": "The deployment ID.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "list": {
+ "description": "Lists the deployments of an Apps Script project.",
+ "response": {
+ "$ref": "ListDeploymentsResponse"
+ },
+ "parameterOrder": [
+ "scriptId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The token for continuing a previous list request on the next page. This\nshould be set to the value of `nextPageToken` from a previous response.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of deployments on each returned page. Defaults to 50.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "scriptId": {
+ "description": "The script project's Drive ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{scriptId}/deployments",
+ "path": "v1/projects/{scriptId}/deployments",
+ "id": "script.projects.deployments.list"
+ }
+ }
+ },
"versions": {
- "description": "The list of versions.",
- "type": "array",
- "items": {
- "$ref": "Version"
- }
- },
- "nextPageToken": {
- "description": "The token use to fetch the next page of records. if not exist in the\nresponse, that means no more versions to list.",
- "type": "string"
- }
- },
- "id": "ListVersionsResponse"
- },
- "Metrics": {
- "description": "Resource containing usage stats for a given script, based on the supplied\nfilter and mask present in the request.",
- "type": "object",
- "properties": {
- "activeUsers": {
- "description": "Number of active users.",
- "type": "array",
- "items": {
- "$ref": "MetricsValue"
- }
- },
- "totalExecutions": {
- "description": "Number of total executions.",
- "type": "array",
- "items": {
- "$ref": "MetricsValue"
- }
- },
- "failedExecutions": {
- "description": "Number of failed executions.",
- "type": "array",
- "items": {
- "$ref": "MetricsValue"
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "Version"
+ },
+ "parameterOrder": [
+ "scriptId",
+ "versionNumber"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "versionNumber": {
+ "description": "The version number.",
+ "format": "int32",
+ "required": true,
+ "type": "integer",
+ "location": "path"
+ },
+ "scriptId": {
+ "description": "The script project's Drive ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{scriptId}/versions/{versionNumber}",
+ "path": "v1/projects/{scriptId}/versions/{versionNumber}",
+ "id": "script.projects.versions.get",
+ "description": "Gets a version of a script project."
+ },
+ "list": {
+ "description": "List the versions of a script project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "scriptId"
+ ],
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The token for continuing a previous list request on the next page. This\nshould be set to the value of `nextPageToken` from a previous response.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of versions on each returned page. Defaults to 50.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "scriptId": {
+ "location": "path",
+ "description": "The script project's Drive ID.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{scriptId}/versions",
+ "id": "script.projects.versions.list",
+ "path": "v1/projects/{scriptId}/versions"
+ },
+ "create": {
+ "response": {
+ "$ref": "Version"
+ },
+ "parameterOrder": [
+ "scriptId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "scriptId": {
+ "description": "The script project's Drive ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{scriptId}/versions",
+ "path": "v1/projects/{scriptId}/versions",
+ "id": "script.projects.versions.create",
+ "description": "Creates a new immutable version using the current code, with a unique\nversion number.",
+ "request": {
+ "$ref": "Version"
+ }
+ }
}
}
- },
- "id": "Metrics"
+ }
},
- "GoogleAppsScriptTypeFunctionSet": {
- "description": "A set of functions. No duplicates are permitted.",
- "type": "object",
- "properties": {
- "values": {
- "description": "A list of functions composing the set.",
- "type": "array",
- "items": {
- "$ref": "GoogleAppsScriptTypeFunction"
- }
- }
- },
- "id": "GoogleAppsScriptTypeFunctionSet"
- },
- "Content": {
- "description": "The Content resource.",
- "type": "object",
- "properties": {
- "files": {
- "description": "The list of script project files.\nOne of the files is a script manifest; it must be named \"appsscript\",\nmust have type of JSON, and include the manifest configurations for the\nproject.",
- "type": "array",
- "items": {
- "$ref": "File"
- }
+ "processes": {
+ "methods": {
+ "list": {
+ "description": "List information about processes made by or on behalf of a user,\nsuch as process type and current status.",
+ "response": {
+ "$ref": "ListUserProcessesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of returned processes per page of results. Defaults to\n50.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "userProcessFilter.startTime": {
+ "location": "query",
+ "description": "Optional field used to limit returned processes to those that were\nstarted on or after the given timestamp.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "userProcessFilter.projectName": {
+ "location": "query",
+ "description": "Optional field used to limit returned processes to those originating from\nprojects with a specific project name.",
+ "type": "string"
+ },
+ "userProcessFilter.userAccessLevels": {
+ "location": "query",
+ "enum": [
+ "USER_ACCESS_LEVEL_UNSPECIFIED",
+ "NONE",
+ "READ",
+ "WRITE",
+ "OWNER"
+ ],
+ "description": "Optional field used to limit returned processes to those having one of\nthe specified user access levels.",
+ "type": "string",
+ "repeated": true
+ },
+ "userProcessFilter.functionName": {
+ "description": "Optional field used to limit returned processes to those originating from\na script function with the given function name.",
+ "type": "string",
+ "location": "query"
+ },
+ "userProcessFilter.scriptId": {
+ "description": "Optional field used to limit returned processes to those originating from\nprojects with a specific script ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "userProcessFilter.types": {
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "PROCESS_TYPE_UNSPECIFIED",
+ "ADD_ON",
+ "EXECUTION_API",
+ "TIME_DRIVEN",
+ "TRIGGER",
+ "WEBAPP",
+ "EDITOR"
+ ],
+ "description": "Optional field used to limit returned processes to those having one of\nthe specified process types.",
+ "type": "string"
+ },
+ "userProcessFilter.statuses": {
+ "location": "query",
+ "enum": [
+ "PROCESS_STATUS_UNSPECIFIED",
+ "RUNNING",
+ "PAUSED",
+ "COMPLETED",
+ "CANCELED",
+ "FAILED",
+ "TIMED_OUT",
+ "UNKNOWN"
+ ],
+ "description": "Optional field used to limit returned processes to those having one of\nthe specified process statuses.",
+ "type": "string",
+ "repeated": true
+ },
+ "userProcessFilter.deploymentId": {
+ "location": "query",
+ "description": "Optional field used to limit returned processes to those originating from\nprojects with a specific deployment ID.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token for continuing a previous list request on the next page. This\nshould be set to the value of `nextPageToken` from a previous response.",
+ "type": "string",
+ "location": "query"
+ },
+ "userProcessFilter.endTime": {
+ "description": "Optional field used to limit returned processes to those that completed\non or before the given timestamp.",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/processes",
+ "path": "v1/processes",
+ "id": "script.processes.list"
},
- "scriptId": {
- "description": "The script project's Drive ID.",
- "type": "string"
+ "listScriptProcesses": {
+ "description": "List information about a script's executed processes, such as process type\nand current status.",
+ "response": {
+ "$ref": "ListScriptProcessesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "scriptProcessFilter.startTime": {
+ "location": "query",
+ "description": "Optional field used to limit returned processes to those that were\nstarted on or after the given timestamp.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "scriptProcessFilter.functionName": {
+ "location": "query",
+ "description": "Optional field used to limit returned processes to those originating from\na script function with the given function name.",
+ "type": "string"
+ },
+ "scriptProcessFilter.deploymentId": {
+ "location": "query",
+ "description": "Optional field used to limit returned processes to those originating from\nprojects with a specific deployment ID.",
+ "type": "string"
+ },
+ "scriptId": {
+ "description": "The script ID of the project whose processes are listed.",
+ "type": "string",
+ "location": "query"
+ },
+ "scriptProcessFilter.types": {
+ "description": "Optional field used to limit returned processes to those having one of\nthe specified process types.",
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "PROCESS_TYPE_UNSPECIFIED",
+ "ADD_ON",
+ "EXECUTION_API",
+ "TIME_DRIVEN",
+ "TRIGGER",
+ "WEBAPP",
+ "EDITOR"
+ ]
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The token for continuing a previous list request on the next page. This\nshould be set to the value of `nextPageToken` from a previous response.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of returned processes per page of results. Defaults to\n50.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "scriptProcessFilter.endTime": {
+ "location": "query",
+ "description": "Optional field used to limit returned processes to those that completed\non or before the given timestamp.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "scriptProcessFilter.userAccessLevels": {
+ "description": "Optional field used to limit returned processes to those having one of\nthe specified user access levels.",
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "USER_ACCESS_LEVEL_UNSPECIFIED",
+ "NONE",
+ "READ",
+ "WRITE",
+ "OWNER"
+ ]
+ },
+ "scriptProcessFilter.statuses": {
+ "location": "query",
+ "enum": [
+ "PROCESS_STATUS_UNSPECIFIED",
+ "RUNNING",
+ "PAUSED",
+ "COMPLETED",
+ "CANCELED",
+ "FAILED",
+ "TIMED_OUT",
+ "UNKNOWN"
+ ],
+ "description": "Optional field used to limit returned processes to those having one of\nthe specified process statuses.",
+ "type": "string",
+ "repeated": true
+ }
+ },
+ "flatPath": "v1/processes:listScriptProcesses",
+ "path": "v1/processes:listScriptProcesses",
+ "id": "script.processes.listScriptProcesses"
}
- },
- "id": "Content"
+ }
},
- "GoogleAppsScriptTypeWebAppEntryPoint": {
- "description": "A web application entry point.",
- "type": "object",
- "properties": {
- "url": {
- "description": "The URL for the web application.",
- "type": "string"
- },
- "entryPointConfig": {
- "$ref": "GoogleAppsScriptTypeWebAppConfig",
- "description": "The entry point's configuration."
+ "scripts": {
+ "methods": {
+ "run": {
+ "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": {
+ "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"
+ ]
}
- },
- "id": "GoogleAppsScriptTypeWebAppEntryPoint"
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
},
- "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"
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
},
- "UpdateDeploymentRequest": {
- "description": "Request with deployment information to update an existing deployment.",
- "type": "object",
- "properties": {
- "deploymentConfig": {
- "$ref": "DeploymentConfig",
- "description": "The deployment configuration."
- }
- },
- "id": "UpdateDeploymentRequest"
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
},
- "GoogleAppsScriptTypeExecutionApiEntryPoint": {
- "description": "An API executable entry point.",
- "type": "object",
- "properties": {
- "entryPointConfig": {
- "description": "The entry point's configuration.",
- "$ref": "GoogleAppsScriptTypeExecutionApiConfig"
- }
- },
- "id": "GoogleAppsScriptTypeExecutionApiEntryPoint"
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
},
- "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"
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
},
- "ListUserProcessesResponse": {
- "description": "Response with the list of\nProcess resources.",
- "type": "object",
- "properties": {
- "processes": {
- "description": "List of processes matching request parameters.",
- "type": "array",
- "items": {
- "$ref": "GoogleAppsScriptTypeProcess"
- }
- },
- "nextPageToken": {
- "description": "Token for the next page of results. If empty, there are no more pages\nremaining.",
- "type": "string"
- }
- },
- "id": "ListUserProcessesResponse"
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
- "GoogleAppsScriptTypeUser": {
- "description": "A simple user profile resource.",
- "type": "object",
- "properties": {
- "domain": {
- "description": "The user's domain.",
- "type": "string"
- },
- "photoUrl": {
- "description": "The user's photo.",
- "type": "string"
- },
- "email": {
- "description": "The user's identifying email address.",
- "type": "string"
- },
- "name": {
- "description": "The user's display name.",
- "type": "string"
- }
- },
- "id": "GoogleAppsScriptTypeUser"
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "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://script.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "An API for managing and executing Google Apps Script projects.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20180125",
+ "documentationLink": "https://developers.google.com/apps-script/api/",
+ "id": "script:v1",
+ "discoveryVersion": "v1",
+ "schemas": {
"ExecutionRequest": {
"description": "A request to run the function in a script. The script is identified by the\nspecified `script_id`. Executing a function on a script returns results\nbased on the implementation of the script.",
"type": "object",
"properties": {
- "sessionState": {
- "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"
@@ -256,6 +723,10 @@
"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"
}
},
"id": "ExecutionRequest"
@@ -264,7 +735,13 @@
"description": "A configuration that defines how a deployment is accessed externally.",
"type": "object",
"properties": {
+ "executionApi": {
+ "$ref": "GoogleAppsScriptTypeExecutionApiEntryPoint",
+ "description": "An entry point specification for Apps Script API execution calls."
+ },
"entryPointType": {
+ "description": "The type of the entry point.",
+ "type": "string",
"enumDescriptions": [
"An unspecified entry point.",
"A web application entry point.",
@@ -276,21 +753,15 @@
"WEB_APP",
"EXECUTION_API",
"ADD_ON"
- ],
- "description": "The type of the entry point.",
- "type": "string"
+ ]
},
"addOn": {
- "description": "Add-on properties.",
- "$ref": "GoogleAppsScriptTypeAddOnEntryPoint"
+ "$ref": "GoogleAppsScriptTypeAddOnEntryPoint",
+ "description": "Add-on properties."
},
"webApp": {
- "description": "An entry point specification for web apps.",
- "$ref": "GoogleAppsScriptTypeWebAppEntryPoint"
- },
- "executionApi": {
- "description": "An entry point specification for Apps Script API execution calls.",
- "$ref": "GoogleAppsScriptTypeExecutionApiEntryPoint"
+ "$ref": "GoogleAppsScriptTypeWebAppEntryPoint",
+ "description": "An entry point specification for web apps."
}
},
"id": "EntryPoint"
@@ -345,13 +816,35 @@
},
"id": "GoogleAppsScriptTypeExecutionApiConfig"
},
+ "DeploymentConfig": {
+ "properties": {
+ "description": {
+ "description": "The description for this deployment.",
+ "type": "string"
+ },
+ "versionNumber": {
+ "description": "The version number on which this deployment is based.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "scriptId": {
+ "description": "The script project's Drive ID.",
+ "type": "string"
+ },
+ "manifestFileName": {
+ "description": "The manifest file name for this deployment.",
+ "type": "string"
+ }
+ },
+ "id": "DeploymentConfig",
+ "description": "Metadata the defines how a deployment is configured.",
+ "type": "object"
+ },
"GoogleAppsScriptTypeProcess": {
"description": "Representation of a single script process execution that was started from\nthe script editor, a trigger, an application, or using the Apps Script API.\nThis is distinct from the `Operation`\nresource, which only represents exeuctions started via the Apps Script API.",
"type": "object",
"properties": {
"userAccessLevel": {
- "description": "The executing users access level to the script.",
- "type": "string",
"enumDescriptions": [
"User access level unspecified",
"The user has no access.",
@@ -365,7 +858,9 @@
"READ",
"WRITE",
"OWNER"
- ]
+ ],
+ "description": "The executing users access level to the script.",
+ "type": "string"
},
"processType": {
"enumDescriptions": [
@@ -438,30 +933,6 @@
},
"id": "GoogleAppsScriptTypeProcess"
},
- "DeploymentConfig": {
- "description": "Metadata the defines how a deployment is configured.",
- "type": "object",
- "properties": {
- "description": {
- "description": "The description for this deployment.",
- "type": "string"
- },
- "versionNumber": {
- "description": "The version number on which this deployment is based.",
- "format": "int32",
- "type": "integer"
- },
- "scriptId": {
- "description": "The script project's Drive ID.",
- "type": "string"
- },
- "manifestFileName": {
- "description": "The manifest file name for this deployment.",
- "type": "string"
- }
- },
- "id": "DeploymentConfig"
- },
"CreateProjectRequest": {
"description": "Request to create a script project.",
"type": "object",
@@ -478,77 +949,55 @@
"id": "CreateProjectRequest"
},
"Operation": {
- "description": "A representation of a execution of an Apps Script function that is started using run. The execution response does not arrive until the function finishes executing. The maximum execution runtime is listed in the [Apps Script quotas guide](/apps-script/guides/services/quotas#current_limitations). \u003cp\u003eAfter the execution is started, it can have one of four outcomes:\u003c/p\u003e \u003cul\u003e \u003cli\u003e If the script function returns successfully, the\n response field contains an\n ExecutionResponse object\n with the function's return value in the object's `result` field.\u003c/li\u003e\n\u003cli\u003e If the script function (or Apps Script itself) throws an exception, the\n error field contains a\n Status object. The `Status` object's `details`\n field contains an array with a single\n ExecutionError object that\n provides information about the nature of the error.\u003c/li\u003e\n\u003cli\u003e If the execution has not yet completed,\n the done field is `false` and\n the neither the `response` nor `error` fields are present.\u003c/li\u003e\n\u003cli\u003e If the `run` call itself fails (for example, because of a\n malformed request or an authorization error), the method returns an HTTP\n response code in the 4XX range with a different format for the response\n body. Client libraries automatically convert a 4XX response into an\n exception class.\u003c/li\u003e\n\u003c/ul\u003e",
- "type": "object",
"properties": {
- "error": {
- "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error.",
- "$ref": "Status"
- },
"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": {
+ "description": "If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.",
- "type": "object"
+ }
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error."
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "A representation of a execution of an Apps Script function that is started using run. The execution response does not arrive until the function finishes executing. The maximum execution runtime is listed in the [Apps Script quotas guide](/apps-script/guides/services/quotas#current_limitations). \u003cp\u003eAfter the execution is started, it can have one of four outcomes:\u003c/p\u003e \u003cul\u003e \u003cli\u003e If the script function returns successfully, the\n response field contains an\n ExecutionResponse object\n with the function's return value in the object's `result` field.\u003c/li\u003e\n\u003cli\u003e If the script function (or Apps Script itself) throws an exception, the\n error field contains a\n Status object. The `Status` object's `details`\n field contains an array with a single\n ExecutionError object that\n provides information about the nature of the error.\u003c/li\u003e\n\u003cli\u003e If the execution has not yet completed,\n the done field is `false` and\n the neither the `response` nor `error` fields are present.\u003c/li\u003e\n\u003cli\u003e If the `run` call itself fails (for example, because of a\n malformed request or an authorization error), the method returns an HTTP\n response code in the 4XX range with a different format for the response\n body. Client libraries automatically convert a 4XX response into an\n exception class.\u003c/li\u003e\n\u003c/ul\u003e",
+ "type": "object"
},
"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": {
- "type": "object",
"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"
- },
- "message": {
- "description": "A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the [google.rpc.Status.details](google.rpc.Status.details) field, or localized by the client.",
- "type": "string"
}
},
"id": "Status"
},
- "MetricsValue": {
- "description": "Metrics value that holds number of executions counted.",
- "type": "object",
- "properties": {
- "endTime": {
- "description": "Required field indicating the end time of the interval.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Required field indicating the start time of the interval.",
- "format": "google-datetime",
- "type": "string"
- },
- "value": {
- "description": "Indicates the number of executions counted.",
- "format": "uint64",
- "type": "string"
- }
- },
- "id": "MetricsValue"
- },
"GoogleAppsScriptTypeFunction": {
"description": "Represents a function in a script project.",
"type": "object",
@@ -560,10 +1009,36 @@
},
"id": "GoogleAppsScriptTypeFunction"
},
+ "MetricsValue": {
+ "description": "Metrics value that holds number of executions counted.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Indicates the number of executions counted.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Required field indicating the end time of the interval.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Required field indicating the start time of the interval.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "MetricsValue"
+ },
"Deployment": {
"description": "Representation of a single script deployment.",
"type": "object",
"properties": {
+ "deploymentId": {
+ "description": "The deployment ID for this deployment.",
+ "type": "string"
+ },
"entryPoints": {
"description": "The deployment's entry points.",
"type": "array",
@@ -575,6 +1050,11 @@
"$ref": "GoogleAppsScriptTypeScopeSet",
"description": "Set of scopes required by the deployment."
},
+ "updateTime": {
+ "description": "Last modified date time stamp.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"functionSet": {
"$ref": "GoogleAppsScriptTypeFunctionSet",
"description": "Script's defined set of functions."
@@ -582,23 +1062,20 @@
"deploymentConfig": {
"description": "The deployment configuration.",
"$ref": "DeploymentConfig"
- },
- "updateTime": {
- "description": "Last modified date time stamp.",
- "format": "google-datetime",
- "type": "string"
- },
- "deploymentId": {
- "description": "The deployment ID for this deployment.",
- "type": "string"
}
},
"id": "Deployment"
},
"GoogleAppsScriptTypeAddOnEntryPoint": {
- "description": "An add-on entry point.",
- "type": "object",
"properties": {
+ "title": {
+ "description": "The add-on's required title.",
+ "type": "string"
+ },
+ "reportIssueUrl": {
+ "description": "The add-on's optional report issue URL.",
+ "type": "string"
+ },
"description": {
"description": "The add-on's optional description.",
"type": "string"
@@ -624,30 +1101,24 @@
"helpUrl": {
"description": "The add-on's optional help URL.",
"type": "string"
- },
- "title": {
- "description": "The add-on's required title.",
- "type": "string"
- },
- "reportIssueUrl": {
- "description": "The add-on's optional report issue URL.",
- "type": "string"
}
},
- "id": "GoogleAppsScriptTypeAddOnEntryPoint"
+ "id": "GoogleAppsScriptTypeAddOnEntryPoint",
+ "description": "An add-on entry point.",
+ "type": "object"
},
"ScriptStackTraceElement": {
"description": "A stack trace through the script that shows where the execution failed.",
"type": "object",
"properties": {
+ "function": {
+ "description": "The name of the function that failed.",
+ "type": "string"
+ },
"lineNumber": {
"description": "The line number where the script failed.",
"format": "int32",
"type": "integer"
- },
- "function": {
- "description": "The name of the function that failed.",
- "type": "string"
}
},
"id": "ScriptStackTraceElement"
@@ -675,13 +1146,6 @@
"type": "object",
"properties": {
"access": {
- "enumDescriptions": [
- "Default value, should not be used.",
- "Only the user who deployed the web app or executable can access it.\nNote that this is not necessarily the owner of the script project.",
- "Only users in the same domain as the user who deployed the web app or\nexecutable can access it.",
- "Any logged in user can access the web app or executable.",
- "Any user, logged in or not, can access the web app or executable."
- ],
"enum": [
"UNKNOWN_ACCESS",
"MYSELF",
@@ -690,21 +1154,28 @@
"ANYONE_ANONYMOUS"
],
"description": "Who has permission to run the web app.",
- "type": "string"
- },
- "executeAs": {
+ "type": "string",
"enumDescriptions": [
"Default value, should not be used.",
- "The script runs as the user accessing the web app.",
- "The script runs as the user who deployed the web app. Note that this is\nnot necessarily the owner of the script project."
- ],
+ "Only the user who deployed the web app or executable can access it.\nNote that this is not necessarily the owner of the script project.",
+ "Only users in the same domain as the user who deployed the web app or\nexecutable can access it.",
+ "Any logged in user can access the web app or executable.",
+ "Any user, logged in or not, can access the web app or executable."
+ ]
+ },
+ "executeAs": {
"enum": [
"UNKNOWN_EXECUTE_AS",
"USER_ACCESSING",
"USER_DEPLOYING"
],
"description": "Who to execute the web app as.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, should not be used.",
+ "The script runs as the user accessing the web app.",
+ "The script runs as the user who deployed the web app. Note that this is\nnot necessarily the owner of the script project."
+ ]
}
},
"id": "GoogleAppsScriptTypeWebAppConfig"
@@ -713,9 +1184,17 @@
"description": "The script project resource.",
"type": "object",
"properties": {
+ "scriptId": {
+ "description": "The script project's Drive ID.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title for the project.",
+ "type": "string"
+ },
"lastModifyUser": {
- "description": "User who last modified the script.",
- "$ref": "GoogleAppsScriptTypeUser"
+ "$ref": "GoogleAppsScriptTypeUser",
+ "description": "User who last modified the script."
},
"parentId": {
"description": "The parent's Drive ID that the script will be attached to. This is usually\nthe ID of a Google Document or Google Sheet. This filed is optional, and\nif not set, a stand-alone script will be created.",
@@ -732,16 +1211,8 @@
"type": "string"
},
"creator": {
- "$ref": "GoogleAppsScriptTypeUser",
- "description": "User who originally created the script."
- },
- "scriptId": {
- "description": "The script project's Drive ID.",
- "type": "string"
- },
- "title": {
- "description": "The title for the project.",
- "type": "string"
+ "description": "User who originally created the script.",
+ "$ref": "GoogleAppsScriptTypeUser"
}
},
"id": "Project"
@@ -765,17 +1236,7 @@
"id": "ListDeploymentsResponse"
},
"File": {
- "description": "An individual file within a script project.\nA file is a third-party source code created by one or more\ndevelopers. It can be a server-side JS code, HTML, or a\nconfiguration file. Each script project can contain multiple files.",
- "type": "object",
"properties": {
- "source": {
- "description": "The file content.",
- "type": "string"
- },
- "lastModifyUser": {
- "description": "The user who modified the file most recently.\nThis read-only field is only visible to users who have WRITER\npermission for the script project.",
- "$ref": "GoogleAppsScriptTypeUser"
- },
"createTime": {
"description": "Creation date timestamp.\nThis read-only field is only visible to users who have WRITER\npermission for the script project.",
"format": "google-datetime",
@@ -795,6 +1256,8 @@
"type": "string"
},
"type": {
+ "description": "The type of the file.",
+ "type": "string",
"enumDescriptions": [
"Undetermined file type; never actually used.",
"An Apps Script server-side code file.",
@@ -806,12 +1269,254 @@
"SERVER_JS",
"HTML",
"JSON"
- ],
- "description": "The type of the file.",
+ ]
+ },
+ "lastModifyUser": {
+ "$ref": "GoogleAppsScriptTypeUser",
+ "description": "The user who modified the file most recently.\nThis read-only field is only visible to users who have WRITER\npermission for the script project."
+ },
+ "source": {
+ "description": "The file content.",
"type": "string"
}
},
- "id": "File"
+ "id": "File",
+ "description": "An individual file within a script project.\nA file is a third-party source code created by one or more\ndevelopers. It can be a server-side JS code, HTML, or a\nconfiguration file. Each script project can contain multiple files.",
+ "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"
+ },
+ "GoogleAppsScriptTypeScopeSet": {
+ "description": "A set of scopes. No duplicates are permitted.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "List of scope values in the set.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleAppsScriptTypeScope"
+ }
+ }
+ },
+ "id": "GoogleAppsScriptTypeScopeSet"
+ },
+ "GoogleAppsScriptTypeScope": {
+ "description": "Represents an authorization scope.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The scope's identifying string.",
+ "type": "string"
+ },
+ "authorizer": {
+ "enum": [
+ "SCOPE_AUTHORIZER_UNSPECIFIED",
+ "AUTHORIZED_BY_DEVELOPER",
+ "AUTHORIZED_BY_END_USER"
+ ],
+ "description": "Who authorized the scope.",
+ "type": "string",
+ "enumDescriptions": [
+ "Authorizer unspecified.",
+ "Developer authorized scope.",
+ "End user authorized scope."
+ ]
+ }
+ },
+ "id": "GoogleAppsScriptTypeScope"
+ },
+ "ListVersionsResponse": {
+ "description": "Response with the list of the versions for the specified script project.",
+ "type": "object",
+ "properties": {
+ "versions": {
+ "description": "The list of versions.",
+ "type": "array",
+ "items": {
+ "$ref": "Version"
+ }
+ },
+ "nextPageToken": {
+ "description": "The token use to fetch the next page of records. if not exist in the\nresponse, that means no more versions to list.",
+ "type": "string"
+ }
+ },
+ "id": "ListVersionsResponse"
+ },
+ "Metrics": {
+ "properties": {
+ "activeUsers": {
+ "description": "Number of active users.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricsValue"
+ }
+ },
+ "totalExecutions": {
+ "description": "Number of total executions.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricsValue"
+ }
+ },
+ "failedExecutions": {
+ "description": "Number of failed executions.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricsValue"
+ }
+ }
+ },
+ "id": "Metrics",
+ "description": "Resource containing usage stats for a given script, based on the supplied\nfilter and mask present in the request.",
+ "type": "object"
+ },
+ "GoogleAppsScriptTypeFunctionSet": {
+ "description": "A set of functions. No duplicates are permitted.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "A list of functions composing the set.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleAppsScriptTypeFunction"
+ }
+ }
+ },
+ "id": "GoogleAppsScriptTypeFunctionSet"
+ },
+ "Content": {
+ "description": "The Content resource.",
+ "type": "object",
+ "properties": {
+ "files": {
+ "description": "The list of script project files.\nOne of the files is a script manifest; it must be named \"appsscript\",\nmust have type of JSON, and include the manifest configurations for the\nproject.",
+ "type": "array",
+ "items": {
+ "$ref": "File"
+ }
+ },
+ "scriptId": {
+ "description": "The script project's Drive ID.",
+ "type": "string"
+ }
+ },
+ "id": "Content"
+ },
+ "GoogleAppsScriptTypeWebAppEntryPoint": {
+ "description": "A web application entry point.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "The URL for the web application.",
+ "type": "string"
+ },
+ "entryPointConfig": {
+ "$ref": "GoogleAppsScriptTypeWebAppConfig",
+ "description": "The entry point's configuration."
+ }
+ },
+ "id": "GoogleAppsScriptTypeWebAppEntryPoint"
+ },
+ "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"
+ },
+ "UpdateDeploymentRequest": {
+ "description": "Request with deployment information to update an existing deployment.",
+ "type": "object",
+ "properties": {
+ "deploymentConfig": {
+ "description": "The deployment configuration.",
+ "$ref": "DeploymentConfig"
+ }
+ },
+ "id": "UpdateDeploymentRequest"
+ },
+ "GoogleAppsScriptTypeExecutionApiEntryPoint": {
+ "properties": {
+ "entryPointConfig": {
+ "$ref": "GoogleAppsScriptTypeExecutionApiConfig",
+ "description": "The entry point's configuration."
+ }
+ },
+ "id": "GoogleAppsScriptTypeExecutionApiEntryPoint",
+ "description": "An API executable entry point.",
+ "type": "object"
+ },
+ "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"
+ },
+ "GoogleAppsScriptTypeUser": {
+ "description": "A simple user profile resource.",
+ "type": "object",
+ "properties": {
+ "domain": {
+ "description": "The user's domain.",
+ "type": "string"
+ },
+ "photoUrl": {
+ "description": "The user's photo.",
+ "type": "string"
+ },
+ "email": {
+ "description": "The user's identifying email address.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The user's display name.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleAppsScriptTypeUser"
+ },
+ "ListUserProcessesResponse": {
+ "description": "Response with the list of\nProcess resources.",
+ "type": "object",
+ "properties": {
+ "processes": {
+ "description": "List of processes matching request parameters.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleAppsScriptTypeProcess"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token for the next page of results. If empty, there are no more pages\nremaining.",
+ "type": "string"
+ }
+ },
+ "id": "ListUserProcessesResponse"
}
},
"icons": {
@@ -844,12 +1549,12 @@
"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"
},
@@ -865,710 +1570,5 @@
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Apps Script API",
- "ownerName": "Google",
- "resources": {
- "scripts": {
- "methods": {
- "run": {
- "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",
- "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"
- }
- }
- }
- },
- "projects": {
- "methods": {
- "get": {
- "description": "Gets a script project's metadata.",
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [
- "scriptId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "scriptId": {
- "description": "The script project's Drive ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{scriptId}",
- "path": "v1/projects/{scriptId}",
- "id": "script.projects.get"
- },
- "updateContent": {
- "request": {
- "$ref": "Content"
- },
- "description": "Updates the content of the specified script project.\nThis content is stored as the HEAD version, and is used when the script is\nexecuted as a trigger, in the script editor, in add-on preview mode, or as\na web app or Apps Script API in development mode. This clears all the\nexisting files in the project.",
- "response": {
- "$ref": "Content"
- },
- "parameterOrder": [
- "scriptId"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "scriptId": {
- "location": "path",
- "description": "The script project's Drive ID.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{scriptId}/content",
- "path": "v1/projects/{scriptId}/content",
- "id": "script.projects.updateContent"
- },
- "create": {
- "flatPath": "v1/projects",
- "path": "v1/projects",
- "id": "script.projects.create",
- "description": "Creates a new, empty script project with no script files and a base\nmanifest file.",
- "request": {
- "$ref": "CreateProjectRequest"
- },
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {}
- },
- "getContent": {
- "description": "Gets the content of the script project, including the code source and\nmetadata for each script file.",
- "response": {
- "$ref": "Content"
- },
- "parameterOrder": [
- "scriptId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "versionNumber": {
- "location": "query",
- "description": "The version number of the project to retrieve. If not provided, the\nproject's HEAD version is returned.",
- "format": "int32",
- "type": "integer"
- },
- "scriptId": {
- "location": "path",
- "description": "The script project's Drive ID.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{scriptId}/content",
- "path": "v1/projects/{scriptId}/content",
- "id": "script.projects.getContent"
- },
- "getMetrics": {
- "description": "Get metrics data for scripts, such as number of executions and\nactive users.",
- "httpMethod": "GET",
- "parameterOrder": [
- "scriptId"
- ],
- "response": {
- "$ref": "Metrics"
- },
- "parameters": {
- "metricsFilter.deploymentId": {
- "location": "query",
- "description": "Optional field indicating a specific deployment to retrieve metrics from.",
- "type": "string"
- },
- "scriptId": {
- "location": "path",
- "description": "Required field indicating the script to get metrics for.",
- "required": true,
- "type": "string"
- },
- "metricsGranularity": {
- "description": "Required field indicating what granularity of metrics are returned.",
- "type": "string",
- "location": "query",
- "enum": [
- "UNSPECIFIED_GRANULARITY",
- "WEEKLY",
- "DAILY"
- ]
- }
- },
- "flatPath": "v1/projects/{scriptId}/metrics",
- "id": "script.projects.getMetrics",
- "path": "v1/projects/{scriptId}/metrics"
- }
- },
- "resources": {
- "deployments": {
- "methods": {
- "delete": {
- "description": "Deletes a deployment of an Apps Script project.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "scriptId",
- "deploymentId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "scriptId": {
- "location": "path",
- "description": "The script project's Drive ID.",
- "required": true,
- "type": "string"
- },
- "deploymentId": {
- "description": "The deployment ID to be undeployed.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{scriptId}/deployments/{deploymentId}",
- "id": "script.projects.deployments.delete",
- "path": "v1/projects/{scriptId}/deployments/{deploymentId}"
- },
- "get": {
- "description": "Gets a deployment of an Apps Script project.",
- "response": {
- "$ref": "Deployment"
- },
- "parameterOrder": [
- "scriptId",
- "deploymentId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "deploymentId": {
- "location": "path",
- "description": "The deployment ID.",
- "required": true,
- "type": "string"
- },
- "scriptId": {
- "description": "The script project's Drive ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{scriptId}/deployments/{deploymentId}",
- "path": "v1/projects/{scriptId}/deployments/{deploymentId}",
- "id": "script.projects.deployments.get"
- },
- "list": {
- "description": "Lists the deployments of an Apps Script project.",
- "response": {
- "$ref": "ListDeploymentsResponse"
- },
- "parameterOrder": [
- "scriptId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "description": "The maximum number of deployments on each returned page. Defaults to 50.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "scriptId": {
- "location": "path",
- "description": "The script project's Drive ID.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The token for continuing a previous list request on the next page. This\nshould be set to the value of `nextPageToken` from a previous response.",
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{scriptId}/deployments",
- "path": "v1/projects/{scriptId}/deployments",
- "id": "script.projects.deployments.list"
- },
- "update": {
- "description": "Updates a deployment of an Apps Script project.",
- "request": {
- "$ref": "UpdateDeploymentRequest"
- },
- "response": {
- "$ref": "Deployment"
- },
- "parameterOrder": [
- "scriptId",
- "deploymentId"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "scriptId": {
- "location": "path",
- "description": "The script project's Drive ID.",
- "required": true,
- "type": "string"
- },
- "deploymentId": {
- "description": "The deployment ID for this deployment.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{scriptId}/deployments/{deploymentId}",
- "path": "v1/projects/{scriptId}/deployments/{deploymentId}",
- "id": "script.projects.deployments.update"
- },
- "create": {
- "request": {
- "$ref": "DeploymentConfig"
- },
- "description": "Creates a deployment of an Apps Script project.",
- "response": {
- "$ref": "Deployment"
- },
- "parameterOrder": [
- "scriptId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "scriptId": {
- "location": "path",
- "description": "The script project's Drive ID.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{scriptId}/deployments",
- "path": "v1/projects/{scriptId}/deployments",
- "id": "script.projects.deployments.create"
- }
- }
- },
- "versions": {
- "methods": {
- "get": {
- "flatPath": "v1/projects/{scriptId}/versions/{versionNumber}",
- "path": "v1/projects/{scriptId}/versions/{versionNumber}",
- "id": "script.projects.versions.get",
- "description": "Gets a version of a script project.",
- "response": {
- "$ref": "Version"
- },
- "parameterOrder": [
- "scriptId",
- "versionNumber"
- ],
- "httpMethod": "GET",
- "parameters": {
- "versionNumber": {
- "description": "The version number.",
- "format": "int32",
- "required": true,
- "type": "integer",
- "location": "path"
- },
- "scriptId": {
- "description": "The script project's Drive ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "list": {
- "flatPath": "v1/projects/{scriptId}/versions",
- "path": "v1/projects/{scriptId}/versions",
- "id": "script.projects.versions.list",
- "description": "List the versions of a script project.",
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "parameterOrder": [
- "scriptId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The token for continuing a previous list request on the next page. This\nshould be set to the value of `nextPageToken` from a previous response.",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of versions on each returned page. Defaults to 50.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "scriptId": {
- "location": "path",
- "description": "The script project's Drive ID.",
- "required": true,
- "type": "string"
- }
- }
- },
- "create": {
- "request": {
- "$ref": "Version"
- },
- "description": "Creates a new immutable version using the current code, with a unique\nversion number.",
- "httpMethod": "POST",
- "parameterOrder": [
- "scriptId"
- ],
- "response": {
- "$ref": "Version"
- },
- "parameters": {
- "scriptId": {
- "location": "path",
- "description": "The script project's Drive ID.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{scriptId}/versions",
- "id": "script.projects.versions.create",
- "path": "v1/projects/{scriptId}/versions"
- }
- }
- }
- }
- },
- "processes": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListUserProcessesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "userProcessFilter.deploymentId": {
- "location": "query",
- "description": "Optional field used to limit returned processes to those originating from\nprojects with a specific deployment ID.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The token for continuing a previous list request on the next page. This\nshould be set to the value of `nextPageToken` from a previous response.",
- "type": "string"
- },
- "userProcessFilter.endTime": {
- "location": "query",
- "description": "Optional field used to limit returned processes to those that completed\non or before the given timestamp.",
- "format": "google-datetime",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of returned processes per page of results. Defaults to\n50.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "userProcessFilter.startTime": {
- "description": "Optional field used to limit returned processes to those that were\nstarted on or after the given timestamp.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "userProcessFilter.projectName": {
- "location": "query",
- "description": "Optional field used to limit returned processes to those originating from\nprojects with a specific project name.",
- "type": "string"
- },
- "userProcessFilter.userAccessLevels": {
- "location": "query",
- "enum": [
- "USER_ACCESS_LEVEL_UNSPECIFIED",
- "NONE",
- "READ",
- "WRITE",
- "OWNER"
- ],
- "description": "Optional field used to limit returned processes to those having one of\nthe specified user access levels.",
- "type": "string",
- "repeated": true
- },
- "userProcessFilter.functionName": {
- "description": "Optional field used to limit returned processes to those originating from\na script function with the given function name.",
- "type": "string",
- "location": "query"
- },
- "userProcessFilter.scriptId": {
- "location": "query",
- "description": "Optional field used to limit returned processes to those originating from\nprojects with a specific script ID.",
- "type": "string"
- },
- "userProcessFilter.types": {
- "description": "Optional field used to limit returned processes to those having one of\nthe specified process types.",
- "type": "string",
- "repeated": true,
- "location": "query",
- "enum": [
- "PROCESS_TYPE_UNSPECIFIED",
- "ADD_ON",
- "EXECUTION_API",
- "TIME_DRIVEN",
- "TRIGGER",
- "WEBAPP",
- "EDITOR"
- ]
- },
- "userProcessFilter.statuses": {
- "location": "query",
- "enum": [
- "PROCESS_STATUS_UNSPECIFIED",
- "RUNNING",
- "PAUSED",
- "COMPLETED",
- "CANCELED",
- "FAILED",
- "TIMED_OUT",
- "UNKNOWN"
- ],
- "description": "Optional field used to limit returned processes to those having one of\nthe specified process statuses.",
- "type": "string",
- "repeated": true
- }
- },
- "flatPath": "v1/processes",
- "path": "v1/processes",
- "id": "script.processes.list",
- "description": "List information about processes made by or on behalf of a user,\nsuch as process type and current status."
- },
- "listScriptProcesses": {
- "response": {
- "$ref": "ListScriptProcessesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "The maximum number of returned processes per page of results. Defaults to\n50.",
- "format": "int32",
- "type": "integer"
- },
- "scriptProcessFilter.endTime": {
- "description": "Optional field used to limit returned processes to those that completed\non or before the given timestamp.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "scriptProcessFilter.userAccessLevels": {
- "description": "Optional field used to limit returned processes to those having one of\nthe specified user access levels.",
- "type": "string",
- "repeated": true,
- "location": "query",
- "enum": [
- "USER_ACCESS_LEVEL_UNSPECIFIED",
- "NONE",
- "READ",
- "WRITE",
- "OWNER"
- ]
- },
- "scriptProcessFilter.statuses": {
- "location": "query",
- "enum": [
- "PROCESS_STATUS_UNSPECIFIED",
- "RUNNING",
- "PAUSED",
- "COMPLETED",
- "CANCELED",
- "FAILED",
- "TIMED_OUT",
- "UNKNOWN"
- ],
- "description": "Optional field used to limit returned processes to those having one of\nthe specified process statuses.",
- "type": "string",
- "repeated": true
- },
- "scriptProcessFilter.startTime": {
- "location": "query",
- "description": "Optional field used to limit returned processes to those that were\nstarted on or after the given timestamp.",
- "format": "google-datetime",
- "type": "string"
- },
- "scriptProcessFilter.functionName": {
- "description": "Optional field used to limit returned processes to those originating from\na script function with the given function name.",
- "type": "string",
- "location": "query"
- },
- "scriptProcessFilter.deploymentId": {
- "description": "Optional field used to limit returned processes to those originating from\nprojects with a specific deployment ID.",
- "type": "string",
- "location": "query"
- },
- "scriptId": {
- "description": "The script ID of the project whose processes are listed.",
- "type": "string",
- "location": "query"
- },
- "scriptProcessFilter.types": {
- "description": "Optional field used to limit returned processes to those having one of\nthe specified process types.",
- "type": "string",
- "repeated": true,
- "location": "query",
- "enum": [
- "PROCESS_TYPE_UNSPECIFIED",
- "ADD_ON",
- "EXECUTION_API",
- "TIME_DRIVEN",
- "TRIGGER",
- "WEBAPP",
- "EDITOR"
- ]
- },
- "pageToken": {
- "location": "query",
- "description": "The token for continuing a previous list request on the next page. This\nshould be set to the value of `nextPageToken` from a previous response.",
- "type": "string"
- }
- },
- "flatPath": "v1/processes:listScriptProcesses",
- "path": "v1/processes:listScriptProcesses",
- "id": "script.processes.listScriptProcesses",
- "description": "List information about a script's executed processes, such as process type\nand current status."
- }
- }
- }
- },
- "parameters": {
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "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://script.googleapis.com/",
- "servicePath": "",
- "description": "An API for managing and executing Google Apps Script projects.",
- "kind": "discovery#restDescription",
- "basePath": "",
- "documentationLink": "https://developers.google.com/apps-script/api/",
- "revision": "20180125",
- "id": "script:v1",
- "discoveryVersion": "v1"
+ "ownerName": "Google"
}
diff --git a/searchconsole/v1/searchconsole-api.json b/searchconsole/v1/searchconsole-api.json
index 17147a5..c904860 100644
--- a/searchconsole/v1/searchconsole-api.json
+++ b/searchconsole/v1/searchconsole-api.json
@@ -1,4 +1,251 @@
{
+ "parameters": {
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "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": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "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": {
+ "ResourceIssue": {
+ "id": "ResourceIssue",
+ "description": "Information about a resource with issue.",
+ "type": "object",
+ "properties": {
+ "blockedResource": {
+ "description": "Describes a blocked resource issue.",
+ "$ref": "BlockedResource"
+ }
+ }
+ },
+ "BlockedResource": {
+ "id": "BlockedResource",
+ "description": "Blocked resource.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "URL of the blocked resource.",
+ "type": "string"
+ }
+ }
+ },
+ "TestStatus": {
+ "id": "TestStatus",
+ "description": "Final state of the test, including error details if necessary.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Status of the test.",
+ "type": "string",
+ "enumDescriptions": [
+ "Internal error when running this test. Please try running the test again.",
+ "Inspection has completed without errors.",
+ "Inspection terminated in an error state. This indicates a problem in\nGoogle's infrastructure, not a user error. Please try again later.",
+ "Google can not access the URL because of a user error such as a robots.txt\nblockage, a 403 or 500 code etc. Please make sure that the URL provided is\naccessible by Googlebot and is not password protected."
+ ],
+ "enum": [
+ "TEST_STATUS_UNSPECIFIED",
+ "COMPLETE",
+ "INTERNAL_ERROR",
+ "PAGE_UNREACHABLE"
+ ]
+ },
+ "details": {
+ "description": "Error details if applicable.",
+ "type": "string"
+ }
+ }
+ },
+ "RunMobileFriendlyTestRequest": {
+ "description": "Mobile-friendly test request.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "URL for inspection.",
+ "type": "string"
+ },
+ "requestScreenshot": {
+ "description": "Whether or not screenshot is requested. Default is false.",
+ "type": "boolean"
+ }
+ },
+ "id": "RunMobileFriendlyTestRequest"
+ },
+ "Image": {
+ "description": "Describe image data.",
+ "type": "object",
+ "properties": {
+ "mimeType": {
+ "description": "The mime-type of the image data.",
+ "type": "string"
+ },
+ "data": {
+ "description": "Image data in format determined by the mime type. Currently, the format\nwill always be \"image/png\", but this might change in the future.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "Image"
+ },
+ "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": {
+ "mobileFriendliness": {
+ "enumDescriptions": [
+ "Internal error when running this test. Please try running the test again.",
+ "The page is mobile friendly.",
+ "The page is not mobile friendly."
+ ],
+ "enum": [
+ "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED",
+ "MOBILE_FRIENDLY",
+ "NOT_MOBILE_FRIENDLY"
+ ],
+ "description": "Test verdict, whether the page is mobile friendly or not.",
+ "type": "string"
+ },
+ "mobileFriendlyIssues": {
+ "description": "List of mobile-usability issues.",
+ "type": "array",
+ "items": {
+ "$ref": "MobileFriendlyIssue"
+ }
+ },
+ "screenshot": {
+ "$ref": "Image",
+ "description": "Screenshot of the requested URL."
+ },
+ "testStatus": {
+ "$ref": "TestStatus",
+ "description": "Final state of the test, can be either complete or an error."
+ },
+ "resourceIssues": {
+ "description": "Information about embedded resources issues.",
+ "type": "array",
+ "items": {
+ "$ref": "ResourceIssue"
+ }
+ }
+ },
+ "id": "RunMobileFriendlyTestResponse"
+ }
+ },
+ "protocol": "rest",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
"version": "v1",
"baseUrl": "https://searchconsole.googleapis.com/",
"canonicalName": "Search Console",
@@ -23,270 +270,23 @@
"mobileFriendlyTest": {
"methods": {
"run": {
- "path": "v1/urlTestingTools/mobileFriendlyTest:run",
- "id": "searchconsole.urlTestingTools.mobileFriendlyTest.run",
- "request": {
- "$ref": "RunMobileFriendlyTestRequest"
- },
- "description": "Runs Mobile-Friendly Test for a given URL.",
"response": {
"$ref": "RunMobileFriendlyTestResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
"parameters": {},
- "flatPath": "v1/urlTestingTools/mobileFriendlyTest:run"
+ "flatPath": "v1/urlTestingTools/mobileFriendlyTest:run",
+ "path": "v1/urlTestingTools/mobileFriendlyTest:run",
+ "id": "searchconsole.urlTestingTools.mobileFriendlyTest.run",
+ "request": {
+ "$ref": "RunMobileFriendlyTestRequest"
+ },
+ "description": "Runs Mobile-Friendly Test for a given URL."
}
}
}
}
}
- },
- "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"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- }
- },
- "schemas": {
- "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"
- },
- "RunMobileFriendlyTestResponse": {
- "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."
- },
- "resourceIssues": {
- "description": "Information about embedded resources issues.",
- "type": "array",
- "items": {
- "$ref": "ResourceIssue"
- }
- },
- "mobileFriendliness": {
- "enumDescriptions": [
- "Internal error when running this test. Please try running the test again.",
- "The page is mobile friendly.",
- "The page is not mobile friendly."
- ],
- "enum": [
- "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED",
- "MOBILE_FRIENDLY",
- "NOT_MOBILE_FRIENDLY"
- ],
- "description": "Test verdict, whether the page is mobile friendly or not.",
- "type": "string"
- },
- "mobileFriendlyIssues": {
- "description": "List of mobile-usability issues.",
- "type": "array",
- "items": {
- "$ref": "MobileFriendlyIssue"
- }
- }
- },
- "id": "RunMobileFriendlyTestResponse",
- "description": "Mobile-friendly test response, including mobile-friendly issues and resource\nissues.",
- "type": "object"
- },
- "ResourceIssue": {
- "description": "Information about a resource with issue.",
- "type": "object",
- "properties": {
- "blockedResource": {
- "$ref": "BlockedResource",
- "description": "Describes a blocked resource issue."
- }
- },
- "id": "ResourceIssue"
- },
- "BlockedResource": {
- "properties": {
- "url": {
- "description": "URL of the blocked resource.",
- "type": "string"
- }
- },
- "id": "BlockedResource",
- "description": "Blocked resource.",
- "type": "object"
- },
- "TestStatus": {
- "properties": {
- "status": {
- "enum": [
- "TEST_STATUS_UNSPECIFIED",
- "COMPLETE",
- "INTERNAL_ERROR",
- "PAGE_UNREACHABLE"
- ],
- "description": "Status of the test.",
- "type": "string",
- "enumDescriptions": [
- "Internal error when running this test. Please try running the test again.",
- "Inspection has completed without errors.",
- "Inspection terminated in an error state. This indicates a problem in\nGoogle's infrastructure, not a user error. Please try again later.",
- "Google can not access the URL because of a user error such as a robots.txt\nblockage, a 403 or 500 code etc. Please make sure that the URL provided is\naccessible by Googlebot and is not password protected."
- ]
- },
- "details": {
- "description": "Error details if applicable.",
- "type": "string"
- }
- },
- "id": "TestStatus",
- "description": "Final state of the test, including error details if necessary.",
- "type": "object"
- },
- "RunMobileFriendlyTestRequest": {
- "properties": {
- "url": {
- "description": "URL for inspection.",
- "type": "string"
- },
- "requestScreenshot": {
- "description": "Whether or not screenshot is requested. Default is false.",
- "type": "boolean"
- }
- },
- "id": "RunMobileFriendlyTestRequest",
- "description": "Mobile-friendly test request.",
- "type": "object"
- },
- "Image": {
- "properties": {
- "mimeType": {
- "description": "The mime-type of the image data.",
- "type": "string"
- },
- "data": {
- "description": "Image data in format determined by the mime type. Currently, the format\nwill always be \"image/png\", but this might change in the future.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "Image",
- "description": "Describe image data.",
- "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"
}
}
diff --git a/serviceconsumermanagement/v1/serviceconsumermanagement-api.json b/serviceconsumermanagement/v1/serviceconsumermanagement-api.json
index 82e0d9d..fe1f44f 100644
--- a/serviceconsumermanagement/v1/serviceconsumermanagement-api.json
+++ b/serviceconsumermanagement/v1/serviceconsumermanagement-api.json
@@ -1,10 +1,9 @@
{
- "title": "Service Consumer Management API",
- "ownerName": "Google",
"resources": {
"services": {
"methods": {
"search": {
+ "description": "Search tenancy units for a service.",
"response": {
"$ref": "SearchTenancyUnitsResponse"
},
@@ -12,15 +11,7 @@
"parent"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.\n\nOptional."
- },
"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.",
@@ -33,42 +24,53 @@
"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/[^/]+$"
+ "pattern": "^services/[^/]+$",
+ "location": "path"
+ },
+ "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"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/services/{servicesId}:search",
"path": "v1/{+parent}:search",
- "id": "serviceconsumermanagement.services.search",
- "description": "Search tenancy units for a service."
+ "id": "serviceconsumermanagement.services.search"
}
},
"resources": {
"tenancyUnits": {
"methods": {
"list": {
- "httpMethod": "GET",
+ "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits",
+ "path": "v1/{+parent}/tenancyUnits",
+ "id": "serviceconsumermanagement.services.tenancyUnits.list",
+ "description": "Find tenancy unit for a service and consumer.\nThis method should not be used in producers' runtime path, e.g. finding\nthe tenant project number when creating VMs. Producers should persist\nthe tenant project information after the project is created.",
"response": {
"$ref": "ListTenancyUnitsResponse"
},
"parameterOrder": [
"parent"
],
+ "httpMethod": "GET",
"parameters": {
"parent": {
+ "description": "Service and consumer. Required.\nservices/{service}/{collection id}/{resource id}\n{collection id} is the cloud resource collection type representing the\nservice consumer, for example 'projects', or 'organizations'.\n{resource id} is the consumer numeric id, such as project number: '123456'.\n{service} the name of a service, for example 'service.googleapis.com'.",
"required": true,
"type": "string",
"pattern": "^services/[^/]+/[^/]+/[^/]+$",
- "location": "path",
- "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'."
+ "location": "path"
},
"filter": {
+ "description": "Filter expression over tenancy resources field. Optional.",
"type": "string",
- "location": "query",
- "description": "Filter expression over tenancy resources field. Optional."
+ "location": "query"
},
"pageToken": {
"location": "query",
@@ -76,60 +78,52 @@
"type": "string"
},
"pageSize": {
- "location": "query",
"description": "The maximum number of results returned by this request.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits",
- "id": "serviceconsumermanagement.services.tenancyUnits.list",
- "path": "v1/{+parent}/tenancyUnits",
- "description": "Find tenancy unit for a service and consumer.\nThis method should not be used in producers' runtime path, e.g. finding\nthe tenant project number when creating VMs. Producers should persist\nthe tenant project information after the project is created."
+ ]
},
"create": {
"description": "Creates a tenancy unit with no tenant resources.",
"request": {
"$ref": "CreateTenancyUnitRequest"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
"response": {
"$ref": "TenancyUnit"
},
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
+ "description": "services/{service}/{collection id}/{resource id}\n{collection id} is the cloud resource collection type representing the\nservice consumer, for example 'projects', or 'organizations'.\n{resource id} is the consumer numeric id, such as project number: '123456'.\n{service} the name of a service, for example 'service.googleapis.com'.\nEnabled service binding using the new tenancy unit.",
"required": true,
"type": "string",
"pattern": "^services/[^/]+/[^/]+/[^/]+$",
- "location": "path",
- "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."
+ "location": "path"
}
},
"flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits",
- "id": "serviceconsumermanagement.services.tenancyUnits.create",
- "path": "v1/{+parent}/tenancyUnits"
+ "path": "v1/{+parent}/tenancyUnits",
+ "id": "serviceconsumermanagement.services.tenancyUnits.create"
},
"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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -143,33 +137,37 @@
}
},
"flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject",
+ "path": "v1/{+name}:removeProject",
"id": "serviceconsumermanagement.services.tenancyUnits.removeProject",
- "path": "v1/{+name}: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"
+ }
},
"delete": {
"description": "Delete tenancy unit. Before the tenancy unit is deleted, there should be\nno tenant resource in it.\nOperation\u003cresponse: Empty\u003e.",
+ "httpMethod": "DELETE",
"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."
+ "description": "Name of the tenancy unit to be deleted.",
+ "required": true,
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}",
- "path": "v1/{+name}",
- "id": "serviceconsumermanagement.services.tenancyUnits.delete"
+ "id": "serviceconsumermanagement.services.tenancyUnits.delete",
+ "path": "v1/{+name}"
},
"addProject": {
"request": {
@@ -185,11 +183,11 @@
},
"parameters": {
"parent": {
- "location": "path",
"description": "Name of the tenancy unit.",
"required": true,
"type": "string",
- "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$"
+ "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -206,49 +204,49 @@
"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"
},
+ "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/.+$"
+ "pattern": "^operations/.+$",
+ "location": "path"
}
},
"flatPath": "v1/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
"id": "serviceconsumermanagement.operations.cancel",
- "path": "v1/{+name}:cancel"
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ }
},
"delete": {
"httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"name"
],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"name": {
+ "description": "The name of the operation resource to be deleted.",
"required": true,
"type": "string",
"pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted."
+ "location": "path"
}
},
"scopes": [
@@ -261,10 +259,6 @@
"description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
},
"list": {
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "serviceconsumermanagement.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"response": {
"$ref": "ListOperationsResponse"
},
@@ -272,45 +266,49 @@
"name"
],
"httpMethod": "GET",
+ "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": {
+ "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",
"https://www.googleapis.com/auth/service.management"
],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations$"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The standard list page token."
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "The standard list filter."
- }
- }
+ "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"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
@@ -325,23 +323,44 @@
}
},
"flatPath": "v1/operations/{operationsId}",
- "id": "serviceconsumermanagement.operations.get",
- "path": "v1/{+name}"
+ "path": "v1/{+name}",
+ "id": "serviceconsumermanagement.operations.get"
}
}
}
},
"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"
+ },
+ "pp": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
- "type": "boolean",
- "default": "true",
"location": "query",
- "description": "Returns response with indentations and line breaks."
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
},
"uploadType": {
"location": "query",
@@ -349,17 +368,11 @@
"type": "string"
},
"fields": {
- "type": "string",
"location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"$.xgafv": {
- "location": "query",
"enum": [
"1",
"2"
@@ -369,10 +382,15 @@
"enumDescriptions": [
"v1 error format",
"v2 error format"
- ]
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
- "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
@@ -385,81 +403,620 @@
"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": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Pretty-print response."
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
}
},
"version": "v1",
"baseUrl": "https://serviceconsumermanagement.googleapis.com/",
"servicePath": "",
- "description": "Provides management methods for configuring service producer resources on Google Cloud.",
"kind": "discovery#restDescription",
+ "description": "Provides management methods for configuring service producer resources on Google Cloud.",
"basePath": "",
- "revision": "20180125",
- "documentationLink": "https://cloud.google.com/service-consumer-management/docs/overview",
"id": "serviceconsumermanagement:v1",
+ "documentationLink": "https://cloud.google.com/service-consumer-management/docs/overview",
+ "revision": "20180125",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "Enum": {
+ "properties": {
+ "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"
+ }
+ },
+ "options": {
+ "description": "Protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ }
+ },
+ "id": "Enum",
+ "description": "Enum type definition.",
+ "type": "object"
+ },
+ "LabelDescriptor": {
+ "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",
+ "description": "A description of a label.",
+ "type": "object"
+ },
+ "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"
+ }
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax.",
+ "type": "string"
+ },
+ "sourceContext": {
+ "description": "The source context.",
+ "$ref": "SourceContext"
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "DocumentationRule": {
+ "description": "A documentation rule provides information about individual API elements.",
+ "type": "object",
+ "properties": {
+ "deprecationDescription": {
+ "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the selected API(s).",
+ "type": "string"
+ }
+ },
+ "id": "DocumentationRule"
+ },
+ "ServiceAccountConfig": {
+ "description": "Describes service account configuration for the tenant project.",
+ "type": "object",
+ "properties": {
+ "tenantProjectRoles": {
+ "description": "Roles for the service account above on tenant project.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "accountId": {
+ "description": "ID of the IAM service account to be created in tenant project.\nThe email format of the service account will be\n\"\u003caccount-id\u003e@\u003ctenant-project-id\u003e.iam.gserviceaccount.com\".\nThis account id has to be unique within tenant project and producers\nhave to guarantee it.",
+ "type": "string"
+ }
+ },
+ "id": "ServiceAccountConfig"
+ },
+ "AuthorizationConfig": {
+ "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
+ "type": "string"
+ }
+ },
+ "id": "AuthorizationConfig"
+ },
+ "ContextRule": {
+ "description": "A context rule provides information about the context for an individual API\nelement.",
+ "type": "object",
+ "properties": {
+ "provided": {
+ "description": "A list of full type names of provided contexts.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "ContextRule"
+ },
+ "Billing": {
+ "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count",
+ "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"
+ }
+ }
+ },
+ "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"
+ },
+ "type": {
+ "description": "The metric type, including its DNS name prefix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"",
+ "type": "string"
+ },
+ "valueType": {
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
+ "The value is a `Distribution`.",
+ "The value is money."
+ ],
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ],
+ "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
+ "type": "string"
+ },
+ "metricKind": {
+ "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "An instantaneous measurement of a value.",
+ "The change in a value during a time interval.",
+ "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
+ ],
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ]
+ },
+ "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"
+ }
+ },
+ "id": "MetricDescriptor"
+ },
+ "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"
+ },
+ "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"
+ },
+ "SearchTenancyUnitsResponse": {
+ "description": "Response for the search query.",
+ "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": "SearchTenancyUnitsResponse"
+ },
+ "Endpoint": {
+ "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
+ "type": "object",
+ "properties": {
+ "aliases": {
+ "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intended\naliases.\n\nAdditional names that this endpoint will be hosted on.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "features": {
+ "description": "The list of features enabled on this endpoint.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "allowCors": {
+ "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "The canonical name of this endpoint.",
+ "type": "string"
+ },
+ "target": {
+ "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
+ "type": "string"
+ }
+ },
+ "id": "Endpoint"
+ },
+ "OAuthRequirements": {
+ "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
+ "type": "object",
+ "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": {
+ "producerNotificationChannel": {
+ "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "UsageRule"
+ }
+ },
+ "requirements": {
+ "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "Usage"
+ },
+ "Context": {
+ "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "ContextRule"
+ }
+ }
+ },
+ "id": "Context"
+ },
+ "LogDescriptor": {
+ "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
+ },
+ "name": {
+ "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "LogDescriptor"
+ },
+ "MonitoredResourceDescriptor": {
+ "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
+ }
+ },
+ "id": "MonitoredResourceDescriptor"
+ },
+ "CustomErrorRule": {
+ "properties": {
+ "isErrorType": {
+ "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
+ "type": "boolean"
+ },
+ "selector": {
+ "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "id": "CustomErrorRule",
+ "description": "A custom error rule.",
+ "type": "object"
+ },
+ "MediaDownload": {
+ "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
+ "type": "object",
+ "properties": {
+ "useDirectDownload": {
+ "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
+ "type": "boolean"
+ },
+ "enabled": {
+ "description": "Whether download is enabled.",
+ "type": "boolean"
+ },
+ "downloadService": {
+ "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
+ "type": "string"
+ },
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.",
+ "type": "boolean"
+ },
+ "maxDirectDownloadSize": {
+ "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dropzone": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
+ }
+ },
+ "id": "MediaDownload"
+ },
+ "CustomAuthRequirements": {
+ "description": "Configuration for a custom authentication provider.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
+ "type": "string"
+ }
+ },
+ "id": "CustomAuthRequirements"
+ },
"AuthorizationRule": {
"description": "Authorization rule for API services.\n\nIt specifies the permission(s) required for an API element for the overall\nAPI request to succeed. It is typically used to mark request message fields\nthat contain the name of the resource and indicates the permissions that\nwill be checked on that resource.\n\nFor example:\n\n package google.storage.v1;\n\n message CopyObjectRequest {\n string source = 1 [\n (google.api.authz).permissions = \"storage.objects.get\"];\n\n string destination = 2 [\n (google.api.authz).permissions =\n \"storage.objects.create,storage.objects.update\"];\n }",
"type": "object",
"properties": {
- "selector": {
- "description": "Selects the API elements to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
"permissions": {
"description": "The required permissions. The acceptable values vary depend on the\nauthorization system used. For Google APIs, it should be a comma-separated\nGoogle IAM permission values. When multiple permissions are listed, the\nsemantics is not defined by the system. Additional documentation must\nbe provided manually.",
"type": "string"
+ },
+ "selector": {
+ "description": "Selects the API elements to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
}
},
"id": "AuthorizationRule"
},
"MediaUpload": {
+ "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
"type": "object",
"properties": {
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
+ "type": "boolean"
+ },
+ "progressNotification": {
+ "description": "Whether to receive a notification for progress changes of media upload.",
+ "type": "boolean"
+ },
+ "enabled": {
+ "description": "Whether upload is enabled.",
+ "type": "boolean"
+ },
"dropzone": {
- "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.",
@@ -467,27 +1024,14 @@
"type": "string"
},
"mimeTypes": {
+ "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns."
- },
- "completeNotification": {
- "type": "boolean",
- "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota."
- },
- "progressNotification": {
- "description": "Whether to receive a notification for progress changes of media upload.",
- "type": "boolean"
- },
- "enabled": {
- "type": "boolean",
- "description": "Whether upload is enabled."
+ }
}
},
- "id": "MediaUpload",
- "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods."
+ "id": "MediaUpload"
},
"CreateTenancyUnitRequest": {
"description": "Request to create a tenancy unit for a consumer of a service.",
@@ -500,82 +1044,78 @@
},
"id": "CreateTenancyUnitRequest"
},
- "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": {
- "type": "string",
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section."
- },
"metrics": {
"description": "Names of the metrics to report to this billing destination.\nEach name must be defined in Service.metrics section.",
"type": "array",
"items": {
"type": "string"
}
+ },
+ "monitoredResource": {
+ "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
+ "type": "string"
}
},
"id": "BillingDestination"
},
- "UsageRule": {
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "UsageRule": {
"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": {
"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": {
- "type": "boolean",
- "description": "If true, the selected method allows unregistered calls, e.g. calls\nthat don't identify any user or application."
+ "description": "If true, the selected method allows unregistered calls, e.g. calls\nthat don't identify any user or application.",
+ "type": "boolean"
}
},
"id": "UsageRule",
- "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true"
+ "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": {
- "type": "object",
"properties": {
- "audiences": {
- "type": "string",
- "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com"
- },
"providerId": {
- "type": "string",
- "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth"
+ "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
+ "type": "string"
+ },
+ "audiences": {
+ "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
+ "type": "string"
}
},
"id": "AuthRequirement",
- "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)."
+ "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": {
- "summary": {
- "type": "string",
- "description": "A short summary of what the service does. Can only be provided by\nplain text."
- },
"documentationRootUrl": {
"description": "The URL to the root of documentation.",
"type": "string"
},
"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.",
@@ -587,48 +1127,48 @@
"items": {
"$ref": "Page"
}
+ },
+ "summary": {
+ "description": "A short summary of what the service does. Can only be provided by\nplain text.",
+ "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."
+ "description": "The requirements for OAuth credentials.",
+ "$ref": "OAuthRequirements"
},
"customAuth": {
- "$ref": "CustomAuthRequirements",
- "description": "Configuration for custom authentication."
+ "description": "Configuration for custom authentication.",
+ "$ref": "CustomAuthRequirements"
},
"requirements": {
+ "description": "Requirements for additional authentication providers.",
"type": "array",
"items": {
"$ref": "AuthRequirement"
- },
- "description": "Requirements for additional authentication providers."
+ }
},
"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"
}
},
- "id": "AuthenticationRule",
- "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored."
+ "id": "AuthenticationRule"
},
"BackendRule": {
+ "description": "A backend rule provides configuration for an individual API element.",
"type": "object",
"properties": {
- "deadline": {
- "type": "number",
- "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.",
- "format": "double"
- },
"minDeadline": {
"description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
"format": "double",
@@ -641,48 +1181,19 @@
"selector": {
"description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
"type": "string"
+ },
+ "deadline": {
+ "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.",
+ "format": "double",
+ "type": "number"
}
},
- "id": "BackendRule",
- "description": "A backend rule provides configuration for an individual API element."
+ "id": "BackendRule"
},
"Api": {
+ "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.",
"type": "object",
"properties": {
- "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": {
- "type": "string",
- "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n"
- },
- "mixins": {
- "description": "Included interfaces. See Mixin.",
- "type": "array",
- "items": {
- "$ref": "Mixin"
- }
- },
- "options": {
- "type": "array",
- "items": {
- "$ref": "Option"
- },
- "description": "Any metadata attached to the interface."
- },
"methods": {
"description": "The methods of this interface, in unspecified order.",
"type": "array",
@@ -693,35 +1204,68 @@
"name": {
"description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.",
"type": "string"
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of the service.",
+ "type": "string"
+ },
+ "sourceContext": {
+ "description": "Source context for the protocol buffer service represented by this\nmessage.",
+ "$ref": "SourceContext"
+ },
+ "version": {
+ "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n",
+ "type": "string"
+ },
+ "mixins": {
+ "description": "Included interfaces. See Mixin.",
+ "type": "array",
+ "items": {
+ "$ref": "Mixin"
+ }
+ },
+ "options": {
+ "description": "Any metadata attached to the interface.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
}
},
- "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.",
"type": "object",
"properties": {
"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"
},
"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."
+ }
}
},
"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",
@@ -749,11 +1293,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"
@@ -762,6 +1306,10 @@
"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.",
@@ -776,30 +1324,23 @@
},
"response": {
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
},
"name": {
- "type": "string",
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`."
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
}
},
"id": "Operation"
},
"Page": {
+ "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
"type": "object",
"properties": {
- "content": {
- "type": "string",
- "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file."
- },
"subpages": {
"description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
"type": "array",
@@ -808,41 +1349,45 @@
}
},
"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`."
+ "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",
- "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",
"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"
- },
- "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"
},
"AddTenantProjectRequest": {
+ "description": "Request to add a newly created and configured tenant project to tenancy\nunit.",
"type": "object",
"properties": {
"projectConfig": {
@@ -850,27 +1395,27 @@
"description": "Configuration of the new tenant project that will be added to tenancy unit\nresources."
},
"tag": {
- "type": "string",
- "description": "Tag of the added project. Must be less than 128 characters. Required."
+ "description": "Tag of the added project. Must be less than 128 characters. Required.",
+ "type": "string"
}
},
- "id": "AddTenantProjectRequest",
- "description": "Request to add a newly created and configured tenant project to tenancy\nunit."
+ "id": "AddTenantProjectRequest"
},
"AuthProvider": {
+ "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
"type": "object",
"properties": {
"audiences": {
- "type": "string",
- "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com"
+ "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
+ "type": "string"
},
"id": {
- "type": "string",
- "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\"."
+ "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".",
+ "type": "string"
},
"issuer": {
- "type": "string",
- "description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com"
+ "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.",
@@ -881,37 +1426,89 @@
"type": "string"
}
},
- "id": "AuthProvider",
- "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32)."
+ "id": "AuthProvider"
+ },
+ "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"
},
"Service": {
- "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
- "type": "object",
"properties": {
+ "customError": {
+ "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."
- },
- "systemParameters": {
- "$ref": "SystemParameters",
- "description": "System parameter configuration."
+ "description": "HTTP configuration.",
+ "$ref": "Http"
},
"backend": {
- "$ref": "Backend",
- "description": "API backend configuration."
+ "description": "API backend configuration.",
+ "$ref": "Backend"
+ },
+ "systemParameters": {
+ "description": "System parameter configuration.",
+ "$ref": "SystemParameters"
},
"documentation": {
"$ref": "Documentation",
"description": "Additional API documentation."
},
- "logging": {
- "$ref": "Logging",
- "description": "Logging configuration."
- },
"monitoredResources": {
"description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
"type": "array",
@@ -919,12 +1516,16 @@
"$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"
- },
- "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",
@@ -963,99 +1564,43 @@
"type": "integer"
},
"monitoring": {
- "$ref": "Monitoring",
- "description": "Monitoring configuration."
+ "description": "Monitoring configuration.",
+ "$ref": "Monitoring"
+ },
+ "systemTypes": {
+ "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.",
+ "type": "array",
+ "items": {
+ "$ref": "Type"
+ }
},
"producerProjectId": {
"description": "The Google project that owns this service.",
"type": "string"
},
- "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."
- },
"visibility": {
- "$ref": "Visibility",
- "description": "API visibility configuration."
+ "description": "API visibility configuration.",
+ "$ref": "Visibility"
},
"quota": {
"$ref": "Quota",
"description": "Quota configuration."
},
"name": {
- "type": "string",
- "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`."
+ "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": {
- "type": "string",
- "description": "The product title for this service."
- },
- "endpoints": {
- "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.",
- "type": "array",
- "items": {
- "$ref": "Endpoint"
- }
- },
- "logs": {
- "description": "Defines the logs used by this service.",
- "type": "array",
- "items": {
- "$ref": "LogDescriptor"
- }
- },
- "apis": {
- "type": "array",
- "items": {
- "$ref": "Api"
- },
- "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files."
- },
- "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": "Billing configuration.",
+ "$ref": "Billing"
}
},
- "id": "Service"
- },
- "EnumValue": {
- "description": "Enum value definition.",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Enum value name."
- },
- "options": {
- "description": "Protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "number": {
- "type": "integer",
- "description": "Enum value number.",
- "format": "int32"
- }
- },
- "id": "EnumValue"
+ "id": "Service",
+ "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
+ "type": "object"
},
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -1063,30 +1608,29 @@
"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."
+ }
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations."
+ "id": "ListOperationsResponse"
},
"CustomHttpPattern": {
- "description": "A custom pattern is used for defining custom HTTP verb.",
- "type": "object",
"properties": {
- "path": {
- "description": "The path matched by this custom verb.",
- "type": "string"
- },
"kind": {
"description": "The name of this custom HTTP verb.",
"type": "string"
+ },
+ "path": {
+ "description": "The path matched by this custom verb.",
+ "type": "string"
}
},
- "id": "CustomHttpPattern"
+ "id": "CustomHttpPattern",
+ "description": "A custom pattern is used for defining custom HTTP verb.",
+ "type": "object"
},
"SystemParameterRule": {
"description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
@@ -1107,24 +1651,32 @@
"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"
+ "id": "BillingConfig",
+ "description": "Describes billing configuration for new a Tenant Project",
+ "type": "object"
},
"TenantResource": {
+ "description": "Resource constituting the TenancyUnit.",
"type": "object",
"properties": {
"resource": {
- "type": "string",
- "description": "@OutputOnly Identifier of the tenant resource.\nFor cloud projects it is in the form 'projects/{number}'.\nFor example 'projects/123456'."
+ "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",
@@ -1133,33 +1685,25 @@
"FAILED"
],
"description": "Status of tenant resource.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified status is the default unset value.",
- "Creation of the tenant resource is ongoing.",
- "Active resource.",
- "Deletion of the resource is ongoing.",
- "Tenant resource creation or deletion has failed."
- ]
+ "type": "string"
},
"tag": {
- "type": "string",
- "description": "Unique per single tenancy unit."
+ "description": "Unique per single tenancy unit.",
+ "type": "string"
}
},
- "id": "TenantResource",
- "description": "Resource constituting the TenancyUnit."
+ "id": "TenantResource"
},
"RemoveTenantProjectRequest": {
- "type": "object",
"properties": {
"tag": {
- "type": "string",
- "description": "Tag of the resource within the tenancy unit."
+ "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."
+ "description": "Request message to remove tenant project resource from the tenancy unit.",
+ "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.",
@@ -1177,16 +1721,16 @@
}
},
"restCollection": {
- "type": "string",
- "description": "DO NOT USE. This is an experimental field.\n\nOptional. The REST collection name is by default derived from the URL\npattern. If specified, this field overrides the default collection name.\nExample:\n\n rpc AddressesAggregatedList(AddressesAggregatedListRequest)\n returns (AddressesAggregatedListResponse) {\n option (google.api.http) = {\n get: \"/v1/projects/{project_id}/aggregated/addresses\"\n rest_collection: \"projects.addresses\"\n };\n }\n\nThis method has the automatically derived collection name\n\"projects.aggregated\". Because, semantically, this rpc is actually an\noperation on the \"projects.addresses\" collection, the `rest_collection`\nfield is configured to override the derived collection name."
+ "description": "DO NOT USE. This is an experimental field.\n\nOptional. The REST collection name is by default derived from the URL\npattern. If specified, this field overrides the default collection name.\nExample:\n\n rpc AddressesAggregatedList(AddressesAggregatedListRequest)\n returns (AddressesAggregatedListResponse) {\n option (google.api.http) = {\n get: \"/v1/projects/{project_id}/aggregated/addresses\"\n rest_collection: \"projects.addresses\"\n };\n }\n\nThis method has the automatically derived collection name\n\"projects.aggregated\". Because, semantically, this rpc is actually an\noperation on the \"projects.addresses\" collection, the `rest_collection`\nfield is configured to override the derived collection name.",
+ "type": "string"
},
"mediaUpload": {
"$ref": "MediaUpload",
"description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods."
},
"selector": {
- "type": "string",
- "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details."
+ "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
},
"custom": {
"$ref": "CustomHttpPattern",
@@ -1197,12 +1741,12 @@
"type": "string"
},
"patch": {
- "type": "string",
- "description": "Used for updating a resource."
+ "description": "Used for updating a resource.",
+ "type": "string"
},
"put": {
- "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.",
@@ -1212,16 +1756,16 @@
}
},
"delete": {
- "type": "string",
- "description": "Used for deleting a resource."
+ "description": "Used for deleting a resource.",
+ "type": "string"
},
"body": {
- "type": "string",
- "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."
+ "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.",
@@ -1231,6 +1775,7 @@
"id": "HttpRule"
},
"VisibilityRule": {
+ "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
"type": "object",
"properties": {
"restriction": {
@@ -1238,27 +1783,26 @@
"type": "string"
},
"selector": {
- "type": "string",
- "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details."
+ "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."
+ "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"
}
- },
- "monitoredResource": {
- "type": "string",
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section."
}
},
"id": "MonitoringDestination"
@@ -1267,18 +1811,9 @@
"description": "Representation of a tenancy unit.",
"type": "object",
"properties": {
- "consumer": {
- "type": "string",
- "description": "@OutputOnly Cloud resource One Platform Name of the consumer of this\nservice. For example 'projects/123456'."
- },
- "createTime": {
- "type": "string",
- "description": "@OutputOnly The time this tenancy unit was created.",
- "format": "google-datetime"
- },
"service": {
- "type": "string",
- "description": "@OutputOnly Google Cloud API name of the service owning this tenancy unit.\nFor example 'serviceconsumermanagement.googleapis.com'."
+ "description": "@OutputOnly Google Cloud API name of the service owning this tenancy unit.\nFor example 'serviceconsumermanagement.googleapis.com'.",
+ "type": "string"
},
"name": {
"description": "Globally unique identifier of this tenancy unit\n\"services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}\"",
@@ -1290,34 +1825,43 @@
"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"
},
"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"
- },
- "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
+ }
}
},
- "id": "Visibility",
- "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate."
+ "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"
- },
- "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
+ }
}
},
"id": "SystemParameters"
@@ -1326,19 +1870,19 @@
"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"
}
+ },
+ "limits": {
+ "description": "List of `QuotaLimit` definitions for the service.",
+ "type": "array",
+ "items": {
+ "$ref": "QuotaLimit"
+ }
}
},
"id": "Quota"
@@ -1347,6 +1891,21 @@
"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": {
+ "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."
@@ -1359,46 +1918,32 @@
}
},
"billingConfig": {
- "$ref": "BillingConfig",
- "description": "Billing account properties.\nIt may be specified explicitly, or created from the specified group\nduring provisioning"
- },
- "tenantProjectPolicy": {
- "$ref": "TenantProjectPolicy",
- "description": "Describes ownership and policies for the new tenant project. Required."
- },
- "folder": {
- "description": "Folder where project in this tenancy unit must be located\nThis folder must have been previously created with proper\npermissions for the caller to create and configure a project in it.\nValid folder resource names have the format `folders/{folder_number}`\n(for example, `folders/123456`).",
- "type": "string"
- },
- "labels": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels that will be applied to this project."
+ "description": "Billing account properties.\nIt may be specified explicitly, or created from the specified group\nduring provisioning",
+ "$ref": "BillingConfig"
}
},
"id": "TenantProjectConfig"
},
"PolicyBinding": {
- "description": "Translates to IAM Policy bindings (without auditing at this level)",
- "type": "object",
"properties": {
"members": {
+ "description": "Uses the same format as in IAM policy.\n`member` must include both prefix and id. E.g., `user:{emailId}`,\n`serviceAccount:{emailId}`, `group:{emailId}`.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "Uses the same format as in IAM policy.\n`member` must include both prefix and id. E.g., `user:{emailId}`,\n`serviceAccount:{emailId}`, `group:{emailId}`."
+ }
},
"role": {
- "type": "string",
- "description": "Role. (https://cloud.google.com/iam/docs/understanding-roles)\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`."
+ "description": "Role. (https://cloud.google.com/iam/docs/understanding-roles)\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
+ "type": "string"
}
},
- "id": "PolicyBinding"
+ "id": "PolicyBinding",
+ "description": "Translates to IAM Policy bindings (without auditing at this level)",
+ "type": "object"
},
"LoggingDestination": {
+ "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
"type": "object",
"properties": {
"logs": {
@@ -1413,79 +1958,52 @@
"type": "string"
}
},
- "id": "LoggingDestination",
- "description": "Configuration of a specific logging destination (the producer project\nor the consumer project)."
+ "id": "LoggingDestination"
},
"Option": {
+ "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
"type": "object",
"properties": {
+ "value": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.",
+ "type": "object"
+ },
"name": {
"description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
"type": "string"
- },
- "value": {
- "type": "object",
- "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."
}
},
- "id": "Option",
- "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc."
+ "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": {
- "producerDestinations": {
- "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
- "type": "array",
- "items": {
- "$ref": "LoggingDestination"
- }
- },
"consumerDestinations": {
"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"
}
- }
- },
- "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": {
- "requestStreaming": {
- "type": "boolean",
- "description": "If true, the request is streamed."
},
- "syntax": {
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax of this method.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ]
- },
- "responseTypeUrl": {
- "type": "string",
- "description": "The URL of the output message type."
- },
- "options": {
- "description": "Any metadata attached to the method.",
+ "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": "Option"
+ "$ref": "LoggingDestination"
}
- },
+ }
+ },
+ "id": "Logging"
+ },
+ "Method": {
+ "description": "Method represents a method of an API interface.",
+ "type": "object",
+ "properties": {
"responseStreaming": {
"description": "If true, the response is streamed.",
"type": "boolean"
@@ -1495,20 +2013,43 @@
"type": "string"
},
"requestTypeUrl": {
- "type": "string",
- "description": "A URL of the input message type."
- }
- },
- "id": "Method",
- "description": "Method represents a method of an API interface."
- },
- "QuotaLimit": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the quota limit.\n\nThe name must be provided, and it must be unique within the service. The\nname can only include alphanumeric characters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.",
+ "description": "A URL of the input message type.",
"type": "string"
},
+ "requestStreaming": {
+ "description": "If true, the request is streamed.",
+ "type": "boolean"
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of this method.",
+ "type": "string"
+ },
+ "responseTypeUrl": {
+ "description": "The URL of the output message type.",
+ "type": "string"
+ },
+ "options": {
+ "description": "Any metadata attached to the method.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ }
+ },
+ "id": "Method"
+ },
+ "QuotaLimit": {
+ "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"
@@ -1524,181 +2065,149 @@
"type": "string"
},
"description": {
- "type": "string",
- "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`)."
+ "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": {
- "type": "string",
- "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config."
+ "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": {
- "type": "object",
"additionalProperties": {
- "type": "string",
- "format": "int64"
+ "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."
+ "description": "Tiered limit values. You must specify this as a key:value pair, with an\ninteger value that is the maximum number of requests allowed for the\nspecified unit. Currently only STANDARD is supported.",
+ "type": "object"
},
"unit": {
"description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.",
"type": "string"
},
"maxLimit": {
- "type": "string",
"description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
- "format": "int64"
+ "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`."
+ "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": {
"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"
},
"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"
}
},
"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": {
- "rules": {
- "type": "array",
- "items": {
- "$ref": "CustomErrorRule"
- },
- "description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
- },
"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"
+ "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"
},
"SourceInfo": {
+ "description": "Source information used to create a Service Config",
"type": "object",
"properties": {
"sourceFiles": {
"description": "All files used during config generation.",
"type": "array",
"items": {
- "type": "object",
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- }
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
}
}
},
- "id": "SourceInfo",
- "description": "Source information used to create a Service Config"
+ "id": "SourceInfo"
},
"Control": {
- "type": "object",
"properties": {
"environment": {
- "type": "string",
- "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled."
+ "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.",
+ "type": "string"
}
},
"id": "Control",
- "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc."
+ "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": {
- "type": "object",
"properties": {
- "urlQueryParameter": {
- "type": "string",
- "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive."
- },
"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": {
"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",
- "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."
- },
- "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": {
- "type": "array",
- "items": {
- "$ref": "MonitoringDestination"
- },
- "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination."
- },
- "producerDestinations": {
- "type": "array",
- "items": {
- "$ref": "MonitoringDestination"
- },
- "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination."
- }
- },
- "id": "Monitoring"
+ "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
+ "type": "object"
},
"Field": {
- "type": "object",
"properties": {
- "defaultValue": {
- "type": "string",
- "description": "The string value of the default value of this field. Proto2 syntax only."
- },
- "name": {
- "description": "The field name.",
+ "jsonName": {
+ "description": "The field JSON 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": {
- "type": "integer",
- "description": "The field number.",
- "format": "int32"
- },
"kind": {
"enum": [
"TYPE_UNKNOWN",
@@ -1745,27 +2254,25 @@
"Field type sint64."
]
},
- "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": {
"description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
"format": "int32",
"type": "integer"
},
- "packed": {
- "description": "Whether to use alternative packed wire representation.",
- "type": "boolean"
- },
"cardinality": {
+ "enumDescriptions": [
+ "For fields with unknown cardinality.",
+ "For optional fields.",
+ "For required fields. Proto2 syntax only.",
+ "For repeated fields."
+ ],
"enum": [
"CARDINALITY_UNKNOWN",
"CARDINALITY_OPTIONAL",
@@ -1773,579 +2280,70 @@
"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."
- ]
+ "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",
- "description": "A single field of a message type."
+ "description": "A single field of a message type.",
+ "type": "object"
},
- "Enum": {
- "description": "Enum type definition.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Enum type name.",
- "type": "string"
- },
- "enumvalue": {
- "type": "array",
- "items": {
- "$ref": "EnumValue"
- },
- "description": "Enum value definitions."
- },
- "options": {
- "type": "array",
- "items": {
- "$ref": "Option"
- },
- "description": "Protocol buffer options."
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
- "syntax": {
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax."
- }
- },
- "id": "Enum"
- },
- "LabelDescriptor": {
- "description": "A description of a label.",
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "The label key."
- },
- "description": {
- "type": "string",
- "description": "A human-readable description for the label."
- },
- "valueType": {
- "type": "string",
- "enumDescriptions": [
- "A variable-length string. This is the default.",
- "Boolean; true or false.",
- "A 64-bit signed integer."
- ],
- "enum": [
- "STRING",
- "BOOL",
- "INT64"
- ],
- "description": "The type of data that can be assigned to the label."
- }
- },
- "id": "LabelDescriptor"
- },
- "Type": {
- "type": "object",
- "properties": {
- "options": {
- "type": "array",
- "items": {
- "$ref": "Option"
- },
- "description": "The protocol buffer options."
- },
- "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": {
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ]
- }
- },
- "id": "Type",
- "description": "A protocol buffer message 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"
- },
- "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"
- },
- "AuthorizationConfig": {
- "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com",
- "type": "object",
- "properties": {
- "provider": {
- "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
- "type": "string"
- }
- },
- "id": "AuthorizationConfig"
- },
- "ServiceAccountConfig": {
- "description": "Describes service account configuration for the tenant project.",
- "type": "object",
- "properties": {
- "tenantProjectRoles": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Roles for the service account above on tenant project."
- },
- "accountId": {
- "description": "ID of the IAM service account to be created in tenant project.\nThe email format of the service account will be\n\"\u003caccount-id\u003e@\u003ctenant-project-id\u003e.iam.gserviceaccount.com\".\nThis account id has to be unique within tenant project and producers\nhave to guarantee it.",
- "type": "string"
- }
- },
- "id": "ServiceAccountConfig"
- },
- "DocumentationRule": {
- "type": "object",
- "properties": {
- "deprecationDescription": {
- "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
- "type": "string"
- },
- "selector": {
- "description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.",
- "type": "string"
- },
- "description": {
- "description": "Description of the selected API(s).",
- "type": "string"
- }
- },
- "id": "DocumentationRule",
- "description": "A documentation rule provides information about individual API elements."
- },
- "ContextRule": {
- "description": "A context rule provides information about the context for an individual API\nelement.",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "provided": {
- "description": "A list of full type names of provided contexts.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "requested": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "A list of full type names of requested contexts."
- }
- },
- "id": "ContextRule"
- },
- "Billing": {
- "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count",
- "type": "object",
+ "Monitoring": {
"properties": {
"consumerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
"type": "array",
"items": {
- "$ref": "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"
- },
- "MetricDescriptor": {
- "type": "object",
- "properties": {
- "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\""
- },
- "valueType": {
- "enum": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "MONEY"
- ],
- "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
- "type": "string",
- "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": {
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "An instantaneous measurement of a value.",
- "The change in a value during a time interval.",
- "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
- ],
- "enum": [
- "METRIC_KIND_UNSPECIFIED",
- "GAUGE",
- "DELTA",
- "CUMULATIVE"
- ],
- "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported."
- },
- "displayName": {
- "type": "string",
- "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".\nThis field is optional but it is recommended to be set for any metrics\nassociated with user-visible concepts, such as Quota."
- },
- "description": {
- "description": "A detailed description of the metric, which can be used in documentation.",
- "type": "string"
- },
- "unit": {
- "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
- "type": "string"
- },
- "labels": {
- "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": {
- "type": "string",
- "description": "The resource name of the metric descriptor."
- }
- },
- "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": {
- "type": "string",
- "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`."
- }
- },
- "id": "SourceContext"
- },
- "SearchTenancyUnitsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token for large results."
- },
- "tenancyUnits": {
- "type": "array",
- "items": {
- "$ref": "TenancyUnit"
- },
- "description": "Tenancy Units matching the request."
- }
- },
- "id": "SearchTenancyUnitsResponse",
- "description": "Response for the search query."
- },
- "ListTenancyUnitsResponse": {
- "description": "Response for the list request.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token for large results."
- },
- "tenancyUnits": {
- "type": "array",
- "items": {
- "$ref": "TenancyUnit"
- },
- "description": "Tenancy Units matching the request."
- }
- },
- "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": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intended\naliases.\n\nAdditional names that this endpoint will be hosted on."
- },
- "features": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The list of features enabled on this endpoint."
- },
- "allowCors": {
- "type": "boolean",
- "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed."
- },
- "name": {
- "type": "string",
- "description": "The canonical name of this endpoint."
- },
- "target": {
- "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
- "type": "string"
- }
- },
- "id": "Endpoint"
- },
- "OAuthRequirements": {
- "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",
- "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."
- },
- "Usage": {
- "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"
+ "$ref": "MonitoringDestination"
}
},
- "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": {
+ "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": "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."
- }
- },
- "id": "Usage",
- "description": "Configuration controlling usage of a service."
- },
- "Context": {
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "ContextRule"
+ "$ref": "MonitoringDestination"
}
}
},
- "id": "Context",
- "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`."
- },
- "LogDescriptor": {
- "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details."
- },
- "displayName": {
- "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
- "type": "string"
- },
- "labels": {
- "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- }
- },
- "id": "LogDescriptor"
- },
- "CustomErrorRule": {
- "description": "A custom error rule.",
- "type": "object",
- "properties": {
- "isErrorType": {
- "type": "boolean",
- "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload."
- },
- "selector": {
- "type": "string",
- "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details."
- }
- },
- "id": "CustomErrorRule"
- },
- "MonitoredResourceDescriptor": {
- "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters."
- },
- "labels": {
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`."
- },
- "name": {
- "type": "string",
- "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}\"`."
- },
- "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": {
- "type": "string",
- "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation."
- }
- },
- "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)."
- }
- },
- "id": "CustomAuthRequirements"
- },
- "MediaDownload": {
- "type": "object",
- "properties": {
- "dropzone": {
- "type": "string",
- "description": "Name of the Scotty dropzone to use for the current API."
- },
- "maxDirectDownloadSize": {
- "type": "string",
- "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
- "format": "int64"
- },
- "useDirectDownload": {
- "type": "boolean",
- "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media."
- },
- "enabled": {
- "description": "Whether download is enabled.",
- "type": "boolean"
- },
- "downloadService": {
- "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
- "type": "string"
- },
- "completeNotification": {
- "type": "boolean",
- "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend."
- }
- },
- "id": "MediaDownload",
- "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods."
+ "id": "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"
}
},
- "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": "Service Consumer Management",
"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"
}
}
}
@@ -2354,5 +2352,7 @@
"ownerDomain": "google.com",
"name": "serviceconsumermanagement",
"batchPath": "batch",
- "fullyEncodeReservedExpansion": true
+ "fullyEncodeReservedExpansion": true,
+ "title": "Service Consumer Management API",
+ "ownerName": "Google"
}
diff --git a/servicecontrol/v1/servicecontrol-api.json b/servicecontrol/v1/servicecontrol-api.json
index b8a8b80..c9cbfd9 100644
--- a/servicecontrol/v1/servicecontrol-api.json
+++ b/servicecontrol/v1/servicecontrol-api.json
@@ -1,216 +1,9 @@
{
- "id": "servicecontrol:v1",
- "documentationLink": "https://cloud.google.com/service-control/",
- "revision": "20180120",
- "discoveryVersion": "v1",
- "version_module": true,
"schemas": {
- "LogEntry": {
- "description": "An individual log entry.",
- "type": "object",
- "properties": {
- "labels": {
- "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "severity": {
- "type": "string",
- "enumDescriptions": [
- "(0) The log entry has no assigned severity level.",
- "(100) Debug or trace information.",
- "(200) Routine information, such as ongoing status or performance.",
- "(300) Normal but significant events, such as start up, shut down, or\na configuration change.",
- "(400) Warning events might cause problems.",
- "(500) Error events are likely to cause problems.",
- "(600) Critical events cause more severe problems or outages.",
- "(700) A person must take an action immediately.",
- "(800) One or more systems are unusable."
- ],
- "enum": [
- "DEFAULT",
- "DEBUG",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
- ],
- "description": "The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`."
- },
- "name": {
- "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.",
- "type": "string"
- },
- "insertId": {
- "description": "A unique ID for the log entry used for deduplication. If omitted,\nthe implementation will generate one based on operation_id.",
- "type": "string"
- },
- "structPayload": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The log entry payload, represented as a structure that\nis expressed as a JSON object."
- },
- "textPayload": {
- "description": "The log entry payload, represented as a Unicode string (UTF-8).",
- "type": "string"
- },
- "protoPayload": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "The log entry payload, represented as a protocol buffer that is\nexpressed as a JSON object. The only accepted type currently is\nAuditLog.",
- "type": "object"
- },
- "timestamp": {
- "description": "The time the event described by the log entry occurred. If\nomitted, defaults to operation start time.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "LogEntry"
- },
- "AuditLog": {
- "description": "Common audit log format for Google Cloud Platform API operations.\n\n",
- "type": "object",
- "properties": {
- "serviceName": {
- "description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.",
- "type": "string"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The operation response. This may not include all response elements,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
- "type": "object"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Other service-specific data about the request, response, and other\ninformation associated with the current audited event.",
- "type": "object"
- },
- "methodName": {
- "type": "string",
- "description": "The name of the service method or operation.\nFor API calls, this should be the name of the API method.\nFor example,\n\n \"google.datastore.v1.Datastore.RunQuery\"\n \"google.logging.v1.LoggingService.DeleteLog\""
- },
- "resourceName": {
- "description": "The resource or collection that is the target of the operation.\nThe name is a scheme-less URI, not including the API service name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/books/BOOK_ID\"",
- "type": "string"
- },
- "serviceData": {
- "description": "Deprecated, use `metadata` field instead.\nOther service-specific data about the request, response, and other\nactivities.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "numResponseItems": {
- "description": "The number of items returned from a List or Query API method,\nif applicable.",
- "format": "int64",
- "type": "string"
- },
- "authorizationInfo": {
- "description": "Authorization information. If there are multiple\nresources or permissions involved, then there is\none AuthorizationInfo element for each {resource, permission} tuple.",
- "type": "array",
- "items": {
- "$ref": "AuthorizationInfo"
- }
- },
- "request": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The operation request. This may not include all request parameters,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
- "type": "object"
- },
- "requestMetadata": {
- "description": "Metadata about the operation.",
- "$ref": "RequestMetadata"
- },
- "status": {
- "description": "The status of the overall operation.",
- "$ref": "Status"
- },
- "authenticationInfo": {
- "description": "Authentication information.",
- "$ref": "AuthenticationInfo"
- }
- },
- "id": "AuditLog"
- },
- "MetricValue": {
- "description": "Represents a single metric value.",
- "type": "object",
- "properties": {
- "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",
- "type": "number"
- },
- "int64Value": {
- "type": "string",
- "description": "A signed 64-bit integer value.",
- "format": "int64"
- },
- "distributionValue": {
- "description": "A distribution value.",
- "$ref": "Distribution"
- },
- "boolValue": {
- "description": "A boolean value.",
- "type": "boolean"
- },
- "endTime": {
- "type": "string",
- "description": "The end of the time period over which this metric value's measurement\napplies.",
- "format": "google-datetime"
- },
- "startTime": {
- "description": "The start of the time period over which this metric value's measurement\napplies. The time period has different semantics for different metric\ntypes (cumulative, delta, and gauge). See the metric definition\ndocumentation in the service configuration for details.",
- "format": "google-datetime",
- "type": "string"
- },
- "moneyValue": {
- "$ref": "Money",
- "description": "A money value."
- }
- },
- "id": "MetricValue"
- },
"EndReconciliationResponse": {
"description": "Response message for QuotaController.EndReconciliation.",
"type": "object",
"properties": {
- "serviceConfigId": {
- "description": "ID of the actual config used to process the request.",
- "type": "string"
- },
"quotaMetrics": {
"description": "Metric values as tracked by One Platform before the adjustment was made.\nThe following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3. Delta value of the usage after the reconciliation for limits associated\nwith the metrics will be specified using the following metric:\n \"serviceruntime.googleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' use only. Since this metric is not\ndefined in the monitoring backend, reporting on this metric will result in\nan error.",
"type": "array",
@@ -228,19 +21,19 @@
"items": {
"$ref": "QuotaError"
}
+ },
+ "serviceConfigId": {
+ "description": "ID of the actual config used to process the request.",
+ "type": "string"
}
},
"id": "EndReconciliationResponse"
},
"Money": {
+ "id": "Money",
"description": "Represents an amount of money with its currency type.",
"type": "object",
"properties": {
- "nanos": {
- "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "format": "int32",
- "type": "integer"
- },
"units": {
"description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
"format": "int64",
@@ -249,25 +42,51 @@
"currencyCode": {
"description": "The 3-letter currency code defined in ISO 4217.",
"type": "string"
+ },
+ "nanos": {
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "format": "int32",
+ "type": "integer"
}
- },
- "id": "Money"
+ }
},
"Distribution": {
- "id": "Distribution",
"description": "Distribution represents a frequency distribution of double-valued sample\npoints. It contains the size of the population of sample points plus\nadditional optional information:\n\n - the arithmetic mean of the samples\n - the minimum and maximum of the samples\n - the sum-squared-deviation of the samples, used to compute variance\n - a histogram of the values of the sample points",
"type": "object",
"properties": {
- "count": {
- "description": "The total number of samples in the distribution. Must be \u003e= 0.",
- "format": "int64",
- "type": "string"
+ "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."
+ },
+ "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."
},
"mean": {
"description": "The arithmetic mean of the samples in the distribution. If `count` is\nzero then this field must be zero.",
"format": "double",
"type": "number"
},
+ "count": {
+ "description": "The total number of samples in the distribution. Must be \u003e= 0.",
+ "format": "int64",
+ "type": "string"
+ },
"bucketCounts": {
"description": "The number of samples in each histogram bucket. `bucket_counts` are\noptional. If present, they must sum to the `count` value.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`bucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples\nin each of the finite buckets. And `bucket_counts[N] is the number\nof samples in the overflow bucket. See the comments of `bucket_option`\nbelow for more details.\n\nAny suffix of trailing zeros may be omitted.",
"type": "array",
@@ -279,31 +98,9 @@
"explicitBuckets": {
"$ref": "ExplicitBuckets",
"description": "Buckets with arbitrary user-provided width."
- },
- "maximum": {
- "type": "number",
- "description": "The maximum of the population of values. Ignored if `count` is zero.",
- "format": "double"
- },
- "sumOfSquaredDeviation": {
- "type": "number",
- "description": "The sum of squared deviations from the mean:\n Sum[i=1..count]((x_i - mean)^2)\nwhere each x_i is a sample values. If `count` is zero then this field\nmust be zero, otherwise validation of the request fails.",
- "format": "double"
- },
- "exponentialBuckets": {
- "description": "Buckets with exponentially growing width.",
- "$ref": "ExponentialBuckets"
- },
- "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."
}
- }
+ },
+ "id": "Distribution"
},
"ExplicitBuckets": {
"description": "Describing buckets with arbitrary user-provided width.",
@@ -313,14 +110,16 @@
"description": "'bound' is a list of strictly increasing boundaries between\nbuckets. Note that a list of length N-1 defines N buckets because\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th finite bucket covers the interval\n [bound[i-1], bound[i])\nwhere i ranges from 1 to bound_size() - 1. Note that there are no\nfinite buckets at all if 'bound' only contains a single element; in\nthat special case the single bound defines the boundary between the\nunderflow and overflow buckets.\n\nbucket number lower bound upper bound\n i == 0 (underflow) -inf bound[i]\n 0 \u003c i \u003c bound_size() bound[i-1] bound[i]\n i == bound_size() (overflow) bound[i-1] +inf",
"type": "array",
"items": {
- "type": "number",
- "format": "double"
+ "format": "double",
+ "type": "number"
}
}
},
"id": "ExplicitBuckets"
},
"ExponentialBuckets": {
+ "description": "Describing buckets with exponentially growing width.",
+ "type": "object",
"properties": {
"numFiniteBuckets": {
"description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.",
@@ -338,30 +137,29 @@
"type": "number"
}
},
- "id": "ExponentialBuckets",
- "description": "Describing buckets with exponentially growing width.",
- "type": "object"
+ "id": "ExponentialBuckets"
},
"AuthorizationInfo": {
+ "id": "AuthorizationInfo",
"description": "Authorization information for the operation.",
"type": "object",
"properties": {
- "permission": {
- "type": "string",
- "description": "The required IAM permission."
- },
"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": {
- "type": "boolean",
- "description": "Whether or not authorization for `resource` and `permission`\nwas granted."
+ "description": "Whether or not authorization for `resource` and `permission`\nwas granted.",
+ "type": "boolean"
+ },
+ "permission": {
+ "description": "The required IAM permission.",
+ "type": "string"
}
- },
- "id": "AuthorizationInfo"
+ }
},
"ResourceInfo": {
+ "id": "ResourceInfo",
"description": "Describes a resource associated with this operation.",
"type": "object",
"properties": {
@@ -373,11 +171,9 @@
"description": "The identifier of the parent of this resource instance.\nMust be in one of the following formats:\n - “projects/\u003cproject-id or project-number\u003e”\n - “folders/\u003cfolder-id\u003e”\n - “organizations/\u003corganization-id\u003e”",
"type": "string"
}
- },
- "id": "ResourceInfo"
+ }
},
"StartReconciliationResponse": {
- "id": "StartReconciliationResponse",
"description": "Response message for QuotaController.StartReconciliation.",
"type": "object",
"properties": {
@@ -389,33 +185,28 @@
}
},
"operationId": {
- "type": "string",
- "description": "The same operation_id value used in the StartReconciliationRequest. Used\nfor logging and diagnostics purposes."
+ "description": "The same operation_id value used in the StartReconciliationRequest. Used\nfor logging and diagnostics purposes.",
+ "type": "string"
},
"reconciliationErrors": {
+ "description": "Indicates the decision of the reconciliation start.",
"type": "array",
"items": {
"$ref": "QuotaError"
- },
- "description": "Indicates the decision of the reconciliation start."
+ }
},
"serviceConfigId": {
"description": "ID of the actual config used to process the request.",
"type": "string"
}
- }
+ },
+ "id": "StartReconciliationResponse"
},
"QuotaProperties": {
"description": "Represents the properties needed for quota operations.",
"type": "object",
"properties": {
"quotaMode": {
- "enum": [
- "ACQUIRE",
- "ACQUIRE_BEST_EFFORT",
- "CHECK",
- "RELEASE"
- ],
"description": "Quota mode for this operation.",
"type": "string",
"enumDescriptions": [
@@ -423,20 +214,22 @@
"Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation does not fail and\navailable quota goes down to zero but it returns error.",
"Does not change any available quota. Only checks if there is enough\nquota.\nNo lock is placed on the checked tokens neither.",
"Increases available quota by the operation cost specified for the\noperation."
+ ],
+ "enum": [
+ "ACQUIRE",
+ "ACQUIRE_BEST_EFFORT",
+ "CHECK",
+ "RELEASE"
]
}
},
"id": "QuotaProperties"
},
"LinearBuckets": {
+ "id": "LinearBuckets",
"description": "Describing buckets with constant width.",
"type": "object",
"properties": {
- "offset": {
- "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.",
- "format": "double",
- "type": "number"
- },
"numFiniteBuckets": {
"description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.",
"format": "int32",
@@ -446,11 +239,16 @@
"description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.\nMust be strictly positive.",
"format": "double",
"type": "number"
+ },
+ "offset": {
+ "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.",
+ "format": "double",
+ "type": "number"
}
- },
- "id": "LinearBuckets"
+ }
},
"AuthenticationInfo": {
+ "id": "AuthenticationInfo",
"description": "Authentication information for the operation.",
"type": "object",
"properties": {
@@ -459,31 +257,34 @@
"type": "string"
},
"authoritySelector": {
- "type": "string",
- "description": "The authority selector specified by the requestor, if any.\nIt is not guaranteed that the principal was allowed to use this authority."
+ "description": "The authority selector specified by the requestor, if any.\nIt is not guaranteed that the principal was allowed to use this authority.",
+ "type": "string"
},
"thirdPartyPrincipal": {
- "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."
+ "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": {
+ "operationId": {
+ "description": "The same operation_id value used in the AllocateQuotaRequest. Used for\nlogging and diagnostics purposes.",
+ "type": "string"
+ },
"serviceConfigId": {
"description": "ID of the actual config used to process the request.",
"type": "string"
},
"allocateInfo": {
- "description": "WARNING: DO NOT use this field until this warning message is removed.",
- "$ref": "AllocateInfo"
+ "$ref": "AllocateInfo",
+ "description": "WARNING: DO NOT use this field until this warning message is removed."
},
"allocateErrors": {
"description": "Indicates the decision of the allocate.",
@@ -498,15 +299,12 @@
"items": {
"$ref": "MetricValueSet"
}
- },
- "operationId": {
- "description": "The same operation_id value used in the AllocateQuotaRequest. Used for\nlogging and diagnostics purposes.",
- "type": "string"
}
},
"id": "AllocateQuotaResponse"
},
"ReleaseQuotaRequest": {
+ "id": "ReleaseQuotaRequest",
"description": "Request message for the ReleaseQuota method.",
"type": "object",
"properties": {
@@ -518,10 +316,29 @@
"$ref": "QuotaOperation",
"description": "Operation that describes the quota release."
}
- },
- "id": "ReleaseQuotaRequest"
+ }
+ },
+ "RequestMetadata": {
+ "id": "RequestMetadata",
+ "description": "Metadata about the request.",
+ "type": "object",
+ "properties": {
+ "callerSuppliedUserAgent": {
+ "description": "The user agent of the caller.\nThis information is not authenticated and should be treated accordingly.\nFor example:\n\n+ `google-api-python-client/1.4.0`:\n The request was made by the Google API client for Python.\n+ `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`:\n The request was made by the Google Cloud SDK CLI (gcloud).\n+ `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:\n The request was made from the `my-project` App Engine app.\nNOLINT",
+ "type": "string"
+ },
+ "callerNetwork": {
+ "description": "The network of the caller.\nSet only if the network host project is part of the same GCP organization\n(or project) as the accessed resource.\nSee https://cloud.google.com/compute/docs/vpc/ for more information.\nThis is a scheme-less URI full resource name. For example:\n\n \"//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID\"",
+ "type": "string"
+ },
+ "callerIp": {
+ "description": "The IP address of the caller.\nFor caller from internet, this will be public IPv4 or IPv6 address.\nFor caller from a Compute Engine VM with external IP address, this\nwill be the VM's external IP address. For caller from a Compute\nEngine VM without external IP address, if the VM is in the same\norganization (or project) as the accessed resource, `caller_ip` will\nbe the VM's internal IPv4 address, otherwise the `caller_ip` will be\nredacted to \"gce-internal-ip\".\nSee https://cloud.google.com/compute/docs/vpc/ for more information.",
+ "type": "string"
+ }
+ }
},
"QuotaError": {
+ "id": "QuotaError",
"description": "Represents error information for QuotaOperation.",
"type": "object",
"properties": {
@@ -534,22 +351,6 @@
"type": "string"
},
"code": {
- "enum": [
- "UNSPECIFIED",
- "RESOURCE_EXHAUSTED",
- "OUT_OF_RANGE",
- "BILLING_NOT_ACTIVE",
- "PROJECT_DELETED",
- "API_KEY_INVALID",
- "API_KEY_EXPIRED",
- "SPATULA_HEADER_INVALID",
- "LOAS_ROLE_INVALID",
- "NO_LOAS_PROJECT",
- "PROJECT_STATUS_UNAVAILABLE",
- "SERVICE_STATUS_UNAVAILABLE",
- "BILLING_STATUS_UNAVAILABLE",
- "QUOTA_SYSTEM_UNAVAILABLE"
- ],
"description": "Error code.",
"type": "string",
"enumDescriptions": [
@@ -567,29 +368,25 @@
"The backend server for checking service status is unavailable.",
"The backend server for checking billing status is unavailable.",
"The backend server for checking quota limits is unavailable."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "RESOURCE_EXHAUSTED",
+ "OUT_OF_RANGE",
+ "BILLING_NOT_ACTIVE",
+ "PROJECT_DELETED",
+ "API_KEY_INVALID",
+ "API_KEY_EXPIRED",
+ "SPATULA_HEADER_INVALID",
+ "LOAS_ROLE_INVALID",
+ "NO_LOAS_PROJECT",
+ "PROJECT_STATUS_UNAVAILABLE",
+ "SERVICE_STATUS_UNAVAILABLE",
+ "BILLING_STATUS_UNAVAILABLE",
+ "QUOTA_SYSTEM_UNAVAILABLE"
]
}
- },
- "id": "QuotaError"
- },
- "RequestMetadata": {
- "description": "Metadata about the request.",
- "type": "object",
- "properties": {
- "callerNetwork": {
- "description": "The network of the caller.\nSet only if the network host project is part of the same GCP organization\n(or project) as the accessed resource.\nSee https://cloud.google.com/compute/docs/vpc/ for more information.\nThis is a scheme-less URI full resource name. For example:\n\n \"//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID\"",
- "type": "string"
- },
- "callerIp": {
- "description": "The IP address of the caller.\nFor caller from internet, this will be public IPv4 or IPv6 address.\nFor caller from a Compute Engine VM with external IP address, this\nwill be the VM's external IP address. For caller from a Compute\nEngine VM without external IP address, if the VM is in the same\norganization (or project) as the accessed resource, `caller_ip` will\nbe the VM's internal IPv4 address, otherwise the `caller_ip` will be\nredacted to \"gce-internal-ip\".\nSee https://cloud.google.com/compute/docs/vpc/ for more information.",
- "type": "string"
- },
- "callerSuppliedUserAgent": {
- "description": "The user agent of the caller.\nThis information is not authenticated and should be treated accordingly.\nFor example:\n\n+ `google-api-python-client/1.4.0`:\n The request was made by the Google API client for Python.\n+ `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`:\n The request was made by the Google Cloud SDK CLI (gcloud).\n+ `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:\n The request was made from the `my-project` App Engine app.\nNOLINT",
- "type": "string"
- }
- },
- "id": "RequestMetadata"
+ }
},
"CheckInfo": {
"description": "Contains additional information about the check operation.",
@@ -609,29 +406,16 @@
},
"id": "CheckInfo"
},
- "AllocateQuotaRequest": {
- "description": "Request message for the AllocateQuota method.",
+ "ReleaseQuotaResponse": {
+ "description": "Response message for the ReleaseQuota method.",
"type": "object",
"properties": {
- "allocateOperation": {
- "description": "Operation that describes the quota allocation.",
- "$ref": "QuotaOperation"
- },
- "serviceConfigId": {
- "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
- "type": "string"
- }
- },
- "id": "AllocateQuotaRequest"
- },
- "ReleaseQuotaResponse": {
- "properties": {
"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"
- },
- "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\""
+ }
},
"operationId": {
"description": "The same operation_id value used in the ReleaseQuotaRequest. Used for\nlogging and diagnostics purposes.",
@@ -649,11 +433,25 @@
}
}
},
- "id": "ReleaseQuotaResponse",
- "description": "Response message for the ReleaseQuota method.",
- "type": "object"
+ "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."
+ }
+ },
+ "id": "AllocateQuotaRequest"
},
"MetricValueSet": {
+ "id": "MetricValueSet",
"description": "Represents a set of metric values in the same metric.\nEach metric value in the set should have a unique combination of start time,\nend time, and label values.",
"type": "object",
"properties": {
@@ -668,38 +466,81 @@
"$ref": "MetricValue"
}
}
- },
- "id": "MetricValueSet"
+ }
},
"ReportError": {
+ "id": "ReportError",
+ "description": "Represents the processing error of one Operation in the request.",
"type": "object",
"properties": {
"status": {
- "description": "Details of the error when processing the Operation.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "Details of the error when processing the Operation."
},
"operationId": {
"description": "The Operation.operation_id value from the request.",
"type": "string"
}
+ }
+ },
+ "StartReconciliationRequest": {
+ "description": "Request message for QuotaController.StartReconciliation.",
+ "type": "object",
+ "properties": {
+ "serviceConfigId": {
+ "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
+ "type": "string"
+ },
+ "reconciliationOperation": {
+ "$ref": "QuotaOperation",
+ "description": "Operation that describes the quota reconciliation."
+ }
},
- "id": "ReportError",
- "description": "Represents the processing error of one Operation in the request."
+ "id": "StartReconciliationRequest"
},
"CheckError": {
- "id": "CheckError",
"description": "Defines the errors to be returned in\ngoogle.api.servicecontrol.v1.CheckResponse.check_errors.",
"type": "object",
"properties": {
- "detail": {
- "description": "Free-form text providing details on the error cause of the error.",
- "type": "string"
- },
"subject": {
"description": "Subject to whom this error applies. See the specific code enum for more\ndetails on this field. For example:\n - “project:\u003cproject-id or project-number\u003e”\n - “folder:\u003cfolder-id\u003e”\n - “organization:\u003corganization-id\u003e”",
"type": "string"
},
"code": {
+ "enumDescriptions": [
+ "This is never used in `CheckResponse`.",
+ "The consumer's project id, network container, or resource container was\nnot found. Same as google.rpc.Code.NOT_FOUND.",
+ "The consumer doesn't have access to the specified resource.\nSame as google.rpc.Code.PERMISSION_DENIED.",
+ "Quota check failed. Same as google.rpc.Code.RESOURCE_EXHAUSTED.",
+ "Budget check failed.",
+ "The consumer's request has been flagged as a DoS attack.",
+ "The consumer's request should be rejected in order to protect the service\nfrom being overloaded.",
+ "The consumer has been flagged as an abuser.",
+ "The consumer hasn't activated the service.",
+ "The consumer cannot access the service due to visibility configuration.",
+ "The consumer cannot access the service because billing is disabled.",
+ "The consumer's project has been marked as deleted (soft deletion).",
+ "The consumer's project number or id does not represent a valid project.",
+ "The IP address of the consumer is invalid for the specific consumer\nproject.",
+ "The referer address of the consumer request is invalid for the specific\nconsumer project.",
+ "The client application of the consumer request is invalid for the\nspecific consumer project.",
+ "The API targeted by this request is invalid for the specified consumer\nproject.",
+ "The consumer's API key is invalid.",
+ "The consumer's API Key has expired.",
+ "The consumer's API Key was not found in config record.",
+ "The consumer's spatula header is invalid.",
+ "The consumer's LOAS role is invalid.",
+ "The consumer's LOAS role has no associated project.",
+ "The consumer's LOAS project is not `ACTIVE` in LoquatV2.",
+ "Request is not allowed as per security policies defined in Org Policy.",
+ "The backend server for looking up project id/number is unavailable.",
+ "The backend server for checking service status is unavailable.",
+ "The backend server for checking billing status is unavailable.",
+ "The backend server for checking quota limits is unavailable.",
+ "The Spanner for looking up LOAS project is unavailable.",
+ "Cloud Resource Manager backend server is unavailable.",
+ "Backend server for evaluating security policy is unavailable."
+ ],
"enum": [
"ERROR_CODE_UNSPECIFIED",
"NOT_FOUND",
@@ -735,60 +576,19 @@
"SECURITY_POLICY_BACKEND_UNAVAILABLE"
],
"description": "The error code.",
- "type": "string",
- "enumDescriptions": [
- "This is never used in `CheckResponse`.",
- "The consumer's project id, network container, or resource container was\nnot found. Same as google.rpc.Code.NOT_FOUND.",
- "The consumer doesn't have access to the specified resource.\nSame as google.rpc.Code.PERMISSION_DENIED.",
- "Quota check failed. Same as google.rpc.Code.RESOURCE_EXHAUSTED.",
- "Budget check failed.",
- "The consumer's request has been flagged as a DoS attack.",
- "The consumer's request should be rejected in order to protect the service\nfrom being overloaded.",
- "The consumer has been flagged as an abuser.",
- "The consumer hasn't activated the service.",
- "The consumer cannot access the service due to visibility configuration.",
- "The consumer cannot access the service because billing is disabled.",
- "The consumer's project has been marked as deleted (soft deletion).",
- "The consumer's project number or id does not represent a valid project.",
- "The IP address of the consumer is invalid for the specific consumer\nproject.",
- "The referer address of the consumer request is invalid for the specific\nconsumer project.",
- "The client application of the consumer request is invalid for the\nspecific consumer project.",
- "The API targeted by this request is invalid for the specified consumer\nproject.",
- "The consumer's API key is invalid.",
- "The consumer's API Key has expired.",
- "The consumer's API Key was not found in config record.",
- "The consumer's spatula header is invalid.",
- "The consumer's LOAS role is invalid.",
- "The consumer's LOAS role has no associated project.",
- "The consumer's LOAS project is not `ACTIVE` in LoquatV2.",
- "Request is not allowed as per security policies defined in Org Policy.",
- "The backend server for looking up project id/number is unavailable.",
- "The backend server for checking service status is unavailable.",
- "The backend server for checking billing status is unavailable.",
- "The backend server for checking quota limits is unavailable.",
- "The Spanner for looking up LOAS project is unavailable.",
- "Cloud Resource Manager backend server is unavailable.",
- "Backend server for evaluating security policy is unavailable."
- ]
- }
- }
- },
- "StartReconciliationRequest": {
- "description": "Request message for QuotaController.StartReconciliation.",
- "type": "object",
- "properties": {
- "serviceConfigId": {
- "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
"type": "string"
},
- "reconciliationOperation": {
- "$ref": "QuotaOperation",
- "description": "Operation that describes the quota reconciliation."
+ "detail": {
+ "description": "Free-form text providing details on the error cause of the error.",
+ "type": "string"
}
},
- "id": "StartReconciliationRequest"
+ "id": "CheckError"
},
"QuotaInfo": {
+ "id": "QuotaInfo",
+ "description": "Contains the quota information for a quota check response.",
+ "type": "object",
"properties": {
"quotaConsumed": {
"additionalProperties": {
@@ -799,11 +599,11 @@
"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\"",
"type": "array",
"items": {
"$ref": "MetricValueSet"
- },
- "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\""
+ }
},
"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.",
@@ -812,12 +612,10 @@
"type": "string"
}
}
- },
- "id": "QuotaInfo",
- "description": "Contains the quota information for a quota check response.",
- "type": "object"
+ }
},
"ConsumerInfo": {
+ "id": "ConsumerInfo",
"description": "`ConsumerInfo` provides information about the consumer project.",
"type": "object",
"properties": {
@@ -826,17 +624,12 @@
"format": "int64",
"type": "string"
}
- },
- "id": "ConsumerInfo"
+ }
},
"CheckRequest": {
"description": "Request message for the Check method.",
"type": "object",
"properties": {
- "skipActivationCheck": {
- "description": "Indicates if service activation check should be skipped for this request.\nDefault behavior is to perform the check and apply relevant quota.",
- "type": "boolean"
- },
"operation": {
"description": "The operation to be checked.",
"$ref": "Operation"
@@ -848,14 +641,26 @@
"serviceConfigId": {
"description": "Specifies which version of service configuration should be used to process\nthe request.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.",
"type": "string"
+ },
+ "skipActivationCheck": {
+ "description": "Indicates if service activation check should be skipped for this request.\nDefault behavior is to perform the check and apply relevant quota.",
+ "type": "boolean"
}
},
"id": "CheckRequest"
},
"QuotaOperation": {
+ "id": "QuotaOperation",
"description": "Represents information regarding a quota operation.",
"type": "object",
"properties": {
+ "quotaMetrics": {
+ "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.\n\nThis field is mutually exclusive with method_name.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricValueSet"
+ }
+ },
"labels": {
"additionalProperties": {
"type": "string"
@@ -871,11 +676,13 @@
"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"
},
- "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"
- },
"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",
@@ -883,40 +690,31 @@
"CHECK_ONLY"
],
"description": "Quota mode for this operation.",
- "type": "string",
- "enumDescriptions": [
- "Guard against implicit default. Must not be used.",
- "For AllocateQuota request, allocates quota for the amount specified in\nthe service configuration or specified using the quota metrics. If the\namount is higher than the available quota, allocation error will be\nreturned and no quota will be allocated.",
- "The operation allocates quota for the amount specified in the service\nconfiguration or specified using the quota metrics. If the amount is\nhigher than the available quota, request does not fail but all available\nquota will be allocated.",
- "For AllocateQuota request, only checks if there is enough quota\navailable and does not change the available quota. No lock is placed on\nthe available quota either."
- ]
- },
- "quotaMetrics": {
- "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.\n\nThis field is mutually exclusive with method_name.",
- "type": "array",
- "items": {
- "$ref": "MetricValueSet"
- }
- }
- },
- "id": "QuotaOperation"
- },
- "EndReconciliationRequest": {
- "id": "EndReconciliationRequest",
- "description": "Request message for QuotaController.EndReconciliation.",
- "type": "object",
- "properties": {
- "serviceConfigId": {
- "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
"type": "string"
},
- "reconciliationOperation": {
- "$ref": "QuotaOperation",
- "description": "Operation that describes the quota reconciliation."
+ "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"
}
}
},
+ "EndReconciliationRequest": {
+ "description": "Request message for QuotaController.EndReconciliation.",
+ "type": "object",
+ "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"
+ },
"ReportInfo": {
+ "id": "ReportInfo",
"description": "Contains additional info about the report operation.",
"type": "object",
"properties": {
@@ -928,16 +726,41 @@
"description": "Quota usage info when processing the `Operation`.",
"$ref": "QuotaInfo"
}
+ }
+ },
+ "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": "ReportInfo"
+ "id": "ReportResponse"
},
"Operation": {
+ "id": "Operation",
"description": "Represents information regarding an operation.",
"type": "object",
"properties": {
"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."
+ "description": "Represents the properties needed for quota check. Applicable only if this\noperation is for a quota check request. If this is not specified, no quota\ncheck will be performed.",
+ "$ref": "QuotaProperties"
},
"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.",
@@ -947,15 +770,15 @@
"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"
},
+ "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",
@@ -980,11 +803,11 @@
"type": "string"
},
"labels": {
+ "description": "Labels describing the operation. Only the following labels are allowed:\n\n- Labels describing monitored resources as defined in\n the service configuration.\n- Default labels of metric values. When specified, labels defined in the\n metric value override these default.\n- The following labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/location` describing the location where the\n operation happened,\n - `servicecontrol.googleapis.com/user_agent` describing the user agent\n of the API request,\n - `servicecontrol.googleapis.com/service_agent` describing the service\n used to handle the API request (e.g. ESP),\n - `servicecontrol.googleapis.com/platform` describing the platform\n where the API is served (e.g. GAE, GCE, GKE).",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "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.",
@@ -1001,11 +824,11 @@
}
},
"userLabels": {
+ "description": "User defined labels for the resource that this operation is associated\nwith. Only a combination of 1000 user labels per consumer project are\nallowed.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "User defined labels for the resource that this operation is associated\nwith. Only a combination of 1000 user labels per consumer project are\nallowed.",
- "type": "object"
+ }
},
"metricValueSets": {
"description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.",
@@ -1014,39 +837,16 @@
"$ref": "MetricValueSet"
}
}
- },
- "id": "Operation"
- },
- "ReportResponse": {
- "description": "Response message for the Report method.",
- "type": "object",
- "properties": {
- "reportErrors": {
- "description": "Partial failures, one for each `Operation` in the request that failed\nprocessing. There are three possible combinations of the RPC status:\n\n1. The combination of a successful RPC status and an empty `report_errors`\n list indicates a complete success where all `Operations` in the\n request are processed successfully.\n2. The combination of a successful RPC status and a non-empty\n `report_errors` list indicates a partial success where some\n `Operations` in the request succeeded. Each\n `Operation` that failed processing has a corresponding item\n in this list.\n3. A failed RPC status indicates a general non-deterministic failure.\n When this happens, it's impossible to know which of the\n 'Operations' in the request succeeded or failed.",
- "type": "array",
- "items": {
- "$ref": "ReportError"
- }
- },
- "reportInfos": {
- "type": "array",
- "items": {
- "$ref": "ReportInfo"
- },
- "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"
- },
- "serviceConfigId": {
- "description": "The actual config id used to process the request.",
- "type": "string"
- }
- },
- "id": "ReportResponse"
+ }
},
"CheckResponse": {
+ "id": "CheckResponse",
+ "description": "Response message for the Check method.",
+ "type": "object",
"properties": {
"operationId": {
- "type": "string",
- "description": "The same operation_id value used in the CheckRequest.\nUsed for logging and diagnostics purposes."
+ "description": "The same operation_id value used in the CheckRequest.\nUsed for logging and diagnostics purposes.",
+ "type": "string"
},
"checkErrors": {
"description": "Indicate the decision of the check.\n\nIf no check errors are present, the service should process the operation.\nOtherwise the service should use the list of errors to determine the\nappropriate action.",
@@ -1067,23 +867,34 @@
"description": "The actual config id used to process the request.",
"type": "string"
}
- },
- "id": "CheckResponse",
- "description": "Response message for the Check method.",
- "type": "object"
+ }
},
- "AllocateInfo": {
+ "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": {
- "unusedArguments": {
+ "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": "string"
- },
- "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."
+ "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": "AllocateInfo"
+ }
},
"ReportRequest": {
"description": "Request message for the Report method.",
@@ -1103,32 +914,216 @@
},
"id": "ReportRequest"
},
- "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.",
+ "AllocateInfo": {
"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.",
+ "unusedArguments": {
+ "description": "A list of label keys that were unused by the server in processing the\nrequest. Thus, for similar requests repeated in a certain future time\nwindow, the caller can choose to ignore these labels in the requests\nto achieve better client-side cache hits and quota aggregation.",
"type": "array",
"items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
+ "type": "string"
+ }
+ }
+ },
+ "id": "AllocateInfo"
+ },
+ "LogEntry": {
+ "id": "LogEntry",
+ "description": "An individual log entry.",
+ "type": "object",
+ "properties": {
+ "protoPayload": {
+ "description": "The log entry payload, represented as a protocol buffer that is\nexpressed as a JSON object. The only accepted type currently is\nAuditLog.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
}
},
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
+ "timestamp": {
+ "description": "The time the event described by the log entry occurred. If\nomitted, defaults to operation start time.",
+ "format": "google-datetime",
+ "type": "string"
},
- "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.",
+ "labels": {
+ "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "severity": {
+ "enumDescriptions": [
+ "(0) The log entry has no assigned severity level.",
+ "(100) Debug or trace information.",
+ "(200) Routine information, such as ongoing status or performance.",
+ "(300) Normal but significant events, such as start up, shut down, or\na configuration change.",
+ "(400) Warning events might cause problems.",
+ "(500) Error events are likely to cause problems.",
+ "(600) Critical events cause more severe problems or outages.",
+ "(700) A person must take an action immediately.",
+ "(800) One or more systems are unusable."
+ ],
+ "enum": [
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
+ ],
+ "description": "The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`.",
+ "type": "string"
+ },
+ "insertId": {
+ "description": "A unique ID for the log entry used for deduplication. If omitted,\nthe implementation will generate one based on operation_id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.",
+ "type": "string"
+ },
+ "structPayload": {
+ "description": "The log entry payload, represented as a structure that\nis expressed as a JSON object.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
+ "textPayload": {
+ "description": "The log entry payload, represented as a Unicode string (UTF-8).",
+ "type": "string"
+ }
+ }
+ },
+ "AuditLog": {
+ "description": "Common audit log format for Google Cloud Platform API operations.\n\n",
+ "type": "object",
+ "properties": {
+ "resourceName": {
+ "description": "The resource or collection that is the target of the operation.\nThe name is a scheme-less URI, not including the API service name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/books/BOOK_ID\"",
+ "type": "string"
+ },
+ "serviceData": {
+ "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"
+ }
+ },
+ "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"
+ }
+ },
+ "requestMetadata": {
+ "description": "Metadata about the operation.",
+ "$ref": "RequestMetadata"
+ },
+ "status": {
+ "description": "The status of the overall operation.",
+ "$ref": "Status"
+ },
+ "authenticationInfo": {
+ "description": "Authentication information.",
+ "$ref": "AuthenticationInfo"
+ },
+ "serviceName": {
+ "description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.",
+ "type": "string"
+ },
+ "response": {
+ "description": "The operation response. This may not include all response elements,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Other service-specific data about the request, response, and other\ninformation associated with the current audited event.",
+ "type": "object"
+ },
+ "methodName": {
+ "description": "The name of the service method or operation.\nFor API calls, this should be the name of the API method.\nFor example,\n\n \"google.datastore.v1.Datastore.RunQuery\"\n \"google.logging.v1.LoggingService.DeleteLog\"",
"type": "string"
}
},
- "id": "Status"
+ "id": "AuditLog"
+ },
+ "MetricValue": {
+ "id": "MetricValue",
+ "description": "Represents a single metric value.",
+ "type": "object",
+ "properties": {
+ "stringValue": {
+ "description": "A text string value.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding relationship.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "doubleValue": {
+ "description": "A double precision floating point value.",
+ "format": "double",
+ "type": "number"
+ },
+ "int64Value": {
+ "description": "A signed 64-bit integer value.",
+ "format": "int64",
+ "type": "string"
+ },
+ "distributionValue": {
+ "description": "A distribution value.",
+ "$ref": "Distribution"
+ },
+ "boolValue": {
+ "description": "A boolean value.",
+ "type": "boolean"
+ },
+ "endTime": {
+ "description": "The end of the time period over which this metric value's measurement\napplies.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The start of the time period over which this metric value's measurement\napplies. The time period has different semantics for different metric\ntypes (cumulative, delta, and gauge). See the metric definition\ndocumentation in the service configuration for details.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "moneyValue": {
+ "description": "A money value.",
+ "$ref": "Money"
+ }
+ }
}
},
"protocol": "rest",
@@ -1159,34 +1154,6 @@
"resources": {
"services": {
"methods": {
- "allocateQuota": {
- "flatPath": "v1/services/{serviceName}:allocateQuota",
- "path": "v1/services/{serviceName}:allocateQuota",
- "id": "servicecontrol.services.allocateQuota",
- "request": {
- "$ref": "AllocateQuotaRequest"
- },
- "description": "Attempts to allocate quota for the specified consumer. It should be called\nbefore the operation is executed.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality.",
- "response": {
- "$ref": "AllocateQuotaResponse"
- },
- "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"
- ]
- },
"startReconciliation": {
"response": {
"$ref": "StartReconciliationResponse"
@@ -1195,27 +1162,29 @@
"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"
],
+ "parameters": {
+ "serviceName": {
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
"flatPath": "v1/services/{serviceName}:startReconciliation",
"path": "v1/services/{serviceName}:startReconciliation",
"id": "servicecontrol.services.startReconciliation",
+ "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in future for each\n metric that needs to be reconciled. The timestamp being in future allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tracking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconciliation is\n called.\n3. At or after the time specified in the StartReconciliation, service\n sends EndReconciliation with the usage that needs to be reconciled to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocation or release between StartReconciliation and EndReconciliation.\n\nSignals the quota controller that the service wants to perform a usage\nreconciliation as specified in the request.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
"request": {
"$ref": "StartReconciliationRequest"
- },
- "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": {
+ "path": "v1/services/{serviceName}:check",
+ "id": "servicecontrol.services.check",
"description": "Checks an operation with Google Service Control to decide whether\nthe given operation should proceed. It should be called before the\noperation is executed.\n\nIf feasible, the client should cache the check results and reuse them for\n60 seconds. In case of server errors, the client can rely on the cached\nresults for longer time.\n\nNOTE: the CheckRequest has the size limit of 64KB.\n\nThis method requires the `servicemanagement.services.check` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
"request": {
"$ref": "CheckRequest"
@@ -1239,22 +1208,37 @@
"location": "path"
}
},
- "flatPath": "v1/services/{serviceName}:check",
- "path": "v1/services/{serviceName}:check",
- "id": "servicecontrol.services.check"
+ "flatPath": "v1/services/{serviceName}:check"
},
"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",
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "flatPath": "v1/services/{serviceName}:releaseQuota",
+ "path": "v1/services/{serviceName}:releaseQuota",
+ "id": "servicecontrol.services.releaseQuota",
+ "request": {
+ "$ref": "ReleaseQuotaRequest"
+ },
+ "description": "Releases previously allocated quota done through AllocateQuota method.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality."
+ },
+ "endReconciliation": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/servicecontrol"
@@ -1267,37 +1251,20 @@
"type": "string"
}
},
- "flatPath": "v1/services/{serviceName}:releaseQuota",
- "id": "servicecontrol.services.releaseQuota",
- "path": "v1/services/{serviceName}:releaseQuota"
- },
- "endReconciliation": {
"flatPath": "v1/services/{serviceName}:endReconciliation",
- "id": "servicecontrol.services.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"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
"response": {
"$ref": "EndReconciliationResponse"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
+ "parameterOrder": [
+ "serviceName"
],
- "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"
- }
- }
+ "httpMethod": "POST"
},
"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).",
@@ -1317,57 +1284,56 @@
],
"parameters": {
"serviceName": {
+ "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee\n[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)\nfor the definition of a service name.",
"required": true,
"type": "string",
- "location": "path",
- "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."
+ "location": "path"
}
},
"flatPath": "v1/services/{serviceName}:report",
"path": "v1/services/{serviceName}:report",
"id": "servicecontrol.services.report"
+ },
+ "allocateQuota": {
+ "response": {
+ "$ref": "AllocateQuotaResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "serviceName": {
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "flatPath": "v1/services/{serviceName}:allocateQuota",
+ "path": "v1/services/{serviceName}:allocateQuota",
+ "id": "servicecontrol.services.allocateQuota",
+ "request": {
+ "$ref": "AllocateQuotaRequest"
+ },
+ "description": "Attempts to allocate quota for the specified consumer. It should be called\nbefore the operation is executed.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality."
}
}
}
},
"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": {
+ "callback": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "description": "JSONP",
"type": "string"
},
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1376,9 +1342,7 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
},
"alt": {
"type": "string",
@@ -1396,32 +1360,68 @@
"proto"
]
},
- "access_token": {
+ "key": {
"location": "query",
- "description": "OAuth access token.",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "access_token": {
+ "description": "OAuth access token.",
"type": "string",
"location": "query"
},
"quotaUser": {
- "type": "string",
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
},
"pp": {
"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": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
}
},
"version": "v1",
"baseUrl": "https://servicecontrol.googleapis.com/",
- "description": "Google Service Control provides control plane functionality to managed services, such as logging, monitoring, and status checks.",
"kind": "discovery#restDescription",
+ "description": "Google Service Control provides control plane functionality to managed services, such as logging, monitoring, and status checks.",
"servicePath": "",
- "basePath": ""
+ "basePath": "",
+ "id": "servicecontrol:v1",
+ "documentationLink": "https://cloud.google.com/service-control/",
+ "revision": "20180120",
+ "discoveryVersion": "v1",
+ "version_module": true
}
diff --git a/servicemanagement/v1/servicemanagement-api.json b/servicemanagement/v1/servicemanagement-api.json
index 05c787e..aa1f955 100644
--- a/servicemanagement/v1/servicemanagement-api.json
+++ b/servicemanagement/v1/servicemanagement-api.json
@@ -1,1062 +1,7 @@
{
- "ownerName": "Google",
- "resources": {
- "operations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Not used.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "A string for filtering Operations.\n The following filter fields are supported:\n\n * serviceName: Required. Only `=` operator is allowed.\n * startTime: The time this job was started, in ISO 8601 format.\n Allowed operators are `\u003e=`, `\u003e`, `\u003c=`, and `\u003c`.\n * status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjunction (OR)\n logical operators. However, the serviceName restriction must be at the\n top-level and can only be combined with other restrictions via the AND\n logical operator.\n\n Examples:\n\n * `serviceName={some-service}.googleapis.com`\n * `serviceName={some-service}.googleapis.com AND startTime\u003e=\"2017-02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `serviceName={some-service}.googleapis.com AND (status=done OR startTime\u003e=\"2017-02-01\")`",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/operations",
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "name": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "servicemanagement.operations.get"
- }
- }
- },
- "services": {
- "methods": {
- "list": {
- "path": "v1/services",
- "id": "servicemanagement.services.list",
- "description": "Lists managed services.\n\nReturns all public services. For authenticated users, also returns all\nservices the calling user has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the caller specifies the `consumer_id`, it returns only the\nservices enabled on the consumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\".",
- "response": {
- "$ref": "ListServicesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "consumerId": {
- "description": "Include services consumed by the specified consumer.\n\nThe Google Service Management implementation accepts the following\nforms:\n- project:\u003cproject_id\u003e",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "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"
- },
- "producerProjectId": {
- "location": "query",
- "description": "Include services produced by the specified project.",
- "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"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "get": {
- "parameters": {
- "serviceName": {
- "description": "The name of the service. See the `ServiceManager` overview for naming\nrequirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "flatPath": "v1/services/{serviceName}",
- "path": "v1/services/{serviceName}",
- "id": "servicemanagement.services.get",
- "description": "Gets a managed service. Authentication is required unless the service is\npublic.",
- "response": {
- "$ref": "ManagedService"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "GET"
- },
- "testIamPermissions": {
- "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",
- "id": "servicemanagement.services.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- }
- },
- "getConfig": {
- "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": {
- "configId": {
- "description": "The id of the service configuration resource.",
- "type": "string",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
- "type": "string"
- },
- "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}/config",
- "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"
- },
- "enable": {
- "path": "v1/services/{serviceName}:enable",
- "id": "servicemanagement.services.enable",
- "request": {
- "$ref": "EnableServiceRequest"
- },
- "description": "Enables a service for a project, so it can be used\nfor the project. See\n[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: EnableServiceResponse\u003e",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "serviceName": {
- "description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{serviceName}:enable"
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "serviceName": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/services/{serviceName}",
- "path": "v1/services/{serviceName}",
- "id": "servicemanagement.services.delete",
- "description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 days, the service will be permanently deleted.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e"
- },
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{servicesId}:setIamPolicy",
- "id": "servicemanagement.services.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
- },
- "disable": {
- "path": "v1/services/{serviceName}:disable",
- "id": "servicemanagement.services.disable",
- "description": "Disables a service for a project, so it can no longer be\nbe used for the project. It prevents accidental usage that may cause\nunexpected billing charges or security leaks.\n\nOperation\u003cresponse: DisableServiceResponse\u003e",
- "request": {
- "$ref": "DisableServiceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "Name of the service to disable. Specifying an unknown service name\nwill cause the request to fail.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/services/{serviceName}:disable"
- },
- "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/[^/]+$",
- "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}:getIamPolicy",
- "id": "servicemanagement.services.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
- },
- "undelete": {
- "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}: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": {
- "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": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/services/{serviceName}/configs"
- },
- "submit": {
- "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": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token of the page to retrieve.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "The max number of items to include in the response list.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1/services/{serviceName}/configs",
- "path": "v1/services/{serviceName}/configs",
- "id": "servicemanagement.services.configs.list",
- "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"
- },
- "get": {
- "path": "v1/services/{serviceName}/configs/{configId}",
- "id": "servicemanagement.services.configs.get",
- "description": "Gets a service configuration (version) for a managed service.",
- "response": {
- "$ref": "Service"
- },
- "parameterOrder": [
- "serviceName",
- "configId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "configId": {
- "description": "The id of the service configuration resource.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
- "type": "string"
- },
- "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/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}"
- }
- }
- },
- "consumers": {
- "methods": {
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "pattern": "^services/[^/]+/consumers/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy",
- "id": "servicemanagement.services.consumers.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
- },
- "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"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+/consumers/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions"
- },
- "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": {
- "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",
- "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"
- }
- }
- }
- },
- "rollouts": {
- "methods": {
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "description": "Use `filter` to return subset of rollouts.\nThe following filters are supported:\n -- To limit the results to only those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',\n use filter='status=SUCCESS'\n -- To limit the results to those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'\n or 'FAILED', use filter='status=CANCELLED OR status=FAILED'",
- "type": "string"
- },
- "serviceName": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token of the page to retrieve.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "The max number of items to include in the response list.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/services/{serviceName}/rollouts",
- "path": "v1/services/{serviceName}/rollouts",
- "id": "servicemanagement.services.rollouts.list",
- "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.",
- "response": {
- "$ref": "ListServiceRolloutsResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "GET"
- },
- "get": {
- "path": "v1/services/{serviceName}/rollouts/{rolloutId}",
- "id": "servicemanagement.services.rollouts.get",
- "description": "Gets a service configuration rollout.",
- "response": {
- "$ref": "Rollout"
- },
- "parameterOrder": [
- "serviceName",
- "rolloutId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string"
- },
- "rolloutId": {
- "description": "The id of the rollout resource.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/services/{serviceName}/rollouts/{rolloutId}"
- },
- "create": {
- "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}/rollouts",
- "path": "v1/services/{serviceName}/rollouts",
- "id": "servicemanagement.services.rollouts.create",
- "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the service configurations to\ndifferent backend services. For example, the logging configuration will be\npushed to Google Cloud Logging.\n\nPlease note that any previous pending and running Rollouts and associated\nOperations will be automatically cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts.\n\nOperation\u003cresponse: Rollout\u003e",
- "request": {
- "$ref": "Rollout"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "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"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- }
- },
- "version": "v1",
- "baseUrl": "https://servicemanagement.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.",
- "servicePath": "",
- "basePath": "",
- "revision": "20180123",
- "documentationLink": "https://cloud.google.com/service-management/",
- "id": "servicemanagement:v1",
"discoveryVersion": "v1",
"schemas": {
- "DisableServiceRequest": {
- "id": "DisableServiceRequest",
- "description": "Request message for DisableService method.",
- "type": "object",
- "properties": {
- "consumerId": {
- "description": "The identity of consumer resource which service disablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
- "type": "string"
- }
- }
- },
- "SubmitConfigSourceResponse": {
- "id": "SubmitConfigSourceResponse",
- "description": "Response message for SubmitConfigSource method.",
- "type": "object",
- "properties": {
- "serviceConfig": {
- "description": "The generated service configuration.",
- "$ref": "Service"
- }
- }
- },
- "MediaUpload": {
- "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
- "type": "object",
- "properties": {
- "completeNotification": {
- "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
- "type": "boolean"
- },
- "progressNotification": {
- "description": "Whether to receive a notification for progress changes of media upload.",
- "type": "boolean"
- },
- "enabled": {
- "description": "Whether upload is enabled.",
- "type": "boolean"
- },
- "dropzone": {
- "description": "Name of the Scotty dropzone to use for the current API.",
- "type": "string"
- },
- "startNotification": {
- "description": "Whether to receive a notification on the start of media upload.",
- "type": "boolean"
- },
- "uploadService": {
- "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
- "type": "string"
- },
- "mimeTypes": {
- "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "maxSize": {
- "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "MediaUpload"
- },
- "BillingDestination": {
- "description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project).",
- "type": "object",
- "properties": {
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
- "type": "string"
- },
- "metrics": {
- "description": "Names of the metrics to report to this billing destination.\nEach name must be defined in Service.metrics section.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "BillingDestination"
- },
- "Advice": {
- "description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Useful description for why this advice was applied and what actions should\nbe taken to mitigate any implied risks.",
- "type": "string"
- }
- },
- "id": "Advice"
- },
- "ManagedService": {
- "id": "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"
- }
- }
- },
- "UsageRule": {
- "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "skipServiceControl": {
- "description": "If true, the selected method should skip service control and the control\nplane features, such as quota and billing, will not be available.\nThis flag is used by Google Cloud Endpoints to bypass checks for internal\nmethods, such as service health check methods.",
- "type": "boolean"
- },
- "allowUnregisteredCalls": {
- "description": "If true, the selected method allows unregistered calls, e.g. calls\nthat don't identify any user or application.",
- "type": "boolean"
- }
- },
- "id": "UsageRule"
- },
- "AuthRequirement": {
- "id": "AuthRequirement",
- "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
- "type": "object",
- "properties": {
- "providerId": {
- "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
- "type": "string"
- },
- "audiences": {
- "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
- "type": "string"
- }
- }
- },
- "TrafficPercentStrategy": {
- "description": "Strategy that specifies how clients of Google Service Controller want to\nsend traffic to use different config versions. This is generally\nused by API proxy to split traffic based on your configured precentage for\neach config version.\n\nOne example of how to gradually rollout a new service configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160206\"\n traffic_percent_strategy {\n percentages: {\n \"example.googleapis.com/20160201\": 70.00\n \"example.googleapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160207\"\n traffic_percent_strategy: {\n percentages: {\n \"example.googleapis.com/20160206\": 100.00\n }\n }\n }",
- "type": "object",
- "properties": {
- "percentages": {
- "description": "Maps service configuration IDs to their corresponding traffic percentage.\nKey is the service configuration ID, Value is the traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 100.0.",
- "type": "object",
- "additionalProperties": {
- "format": "double",
- "type": "number"
- }
- }
- },
- "id": "TrafficPercentStrategy"
- },
- "Documentation": {
- "id": "Documentation",
- "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
- "type": "object",
- "properties": {
- "summary": {
- "description": "A short summary of what the service does. Can only be provided by\nplain text.",
- "type": "string"
- },
- "documentationRootUrl": {
- "description": "The URL to the root of documentation.",
- "type": "string"
- },
- "rules": {
- "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "DocumentationRule"
- }
- },
- "overview": {
- "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.",
- "type": "string"
- },
- "pages": {
- "description": "The top level pages for the documentation set.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- }
- }
- },
"ConfigSource": {
- "id": "ConfigSource",
- "description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.",
"type": "object",
"properties": {
"id": {
@@ -1070,52 +15,42 @@
"$ref": "ConfigFile"
}
}
- }
+ },
+ "id": "ConfigSource",
+ "description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`."
},
"AuthenticationRule": {
- "id": "AuthenticationRule",
"description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
"type": "object",
"properties": {
"requirements": {
- "description": "Requirements for additional authentication providers.",
"type": "array",
"items": {
"$ref": "AuthRequirement"
- }
+ },
+ "description": "Requirements for additional authentication providers."
},
"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"
+ "type": "boolean",
+ "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject."
},
"oauth": {
"$ref": "OAuthRequirements",
"description": "The requirements for OAuth credentials."
},
"customAuth": {
- "description": "Configuration for custom authentication.",
- "$ref": "CustomAuthRequirements"
+ "$ref": "CustomAuthRequirements",
+ "description": "Configuration for custom authentication."
}
- }
+ },
+ "id": "AuthenticationRule"
},
"BackendRule": {
- "id": "BackendRule",
- "description": "A backend rule provides configuration for an individual API element.",
- "type": "object",
"properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "deadline": {
- "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.",
- "format": "double",
- "type": "number"
- },
"minDeadline": {
"description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
"format": "double",
@@ -1124,8 +59,20 @@
"address": {
"description": "The address of the API backend.",
"type": "string"
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "deadline": {
+ "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.",
+ "format": "double",
+ "type": "number"
}
- }
+ },
+ "id": "BackendRule",
+ "description": "A backend rule provides configuration for an individual API element.",
+ "type": "object"
},
"Policy": {
"id": "Policy",
@@ -1156,8 +103,8 @@
"type": "object",
"properties": {
"service": {
- "description": "Revived service resource.",
- "$ref": "ManagedService"
+ "$ref": "ManagedService",
+ "description": "Revived service resource."
}
},
"id": "UndeleteServiceResponse"
@@ -1177,13 +124,7 @@
"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": {
- "description": "The source syntax of the service.",
- "type": "string",
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`."
@@ -1191,7 +132,13 @@
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
- ]
+ ],
+ "description": "The source syntax of the service.",
+ "type": "string"
+ },
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "Source context for the protocol buffer service represented by this\nmessage."
},
"version": {
"description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n",
@@ -1215,7 +162,6 @@
"id": "Api"
},
"MetricRule": {
- "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.",
"type": "object",
"properties": {
"selector": {
@@ -1223,57 +169,40 @@
"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"
+ "id": "MetricRule",
+ "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call."
},
"Authentication": {
- "id": "Authentication",
- "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
"type": "object",
"properties": {
"rules": {
- "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"type": "array",
"items": {
"$ref": "AuthenticationRule"
- }
+ },
+ "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"
- }
+ },
+ "description": "Defines a set of authentication providers that a service supports."
}
- }
+ },
+ "id": "Authentication",
+ "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth"
},
"Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
"properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
@@ -1285,12 +214,29 @@
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "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`."
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
},
"Page": {
- "id": "Page",
"description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
"type": "object",
"properties": {
@@ -1309,18 +255,12 @@
"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": {
- "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"
@@ -1329,22 +269,29 @@
"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"
}
- }
+ },
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons."
},
"Binding": {
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
"condition": {
- "$ref": "Expr",
- "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 only visible as GOOGLE_INTERNAL or CONDITION_TRUSTED_TESTER."
+ "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 only visible as GOOGLE_INTERNAL or CONDITION_TRUSTED_TESTER.",
+ "$ref": "Expr"
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
@@ -1364,6 +311,14 @@
"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"
@@ -1375,65 +330,65 @@
"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": {
- "id": "EnumValue",
- "description": "Enum value definition.",
- "type": "object",
- "properties": {
- "number": {
- "description": "Enum value number.",
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "description": "Enum value name.",
- "type": "string"
- },
- "options": {
- "description": "Protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- }
- }
- },
"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",
"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."
+ },
+ "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."
},
"billing": {
- "description": "Billing configuration.",
- "$ref": "Billing"
+ "$ref": "Billing",
+ "description": "Billing configuration."
},
"name": {
"description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
"type": "string"
},
"customError": {
- "description": "Custom error configuration.",
- "$ref": "CustomError"
+ "$ref": "CustomError",
+ "description": "Custom error configuration."
},
"title": {
"description": "The product title for this service.",
@@ -1472,12 +427,12 @@
"$ref": "SourceInfo"
},
"http": {
- "description": "HTTP configuration.",
- "$ref": "Http"
+ "$ref": "Http",
+ "description": "HTTP configuration."
},
"systemParameters": {
- "$ref": "SystemParameters",
- "description": "System parameter configuration."
+ "description": "System parameter configuration.",
+ "$ref": "SystemParameters"
},
"backend": {
"$ref": "Backend",
@@ -1492,30 +447,30 @@
"description": "Logging configuration."
},
"monitoredResources": {
- "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
"type": "array",
"items": {
"$ref": "MonitoredResourceDescriptor"
- }
+ },
+ "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations."
},
"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"
},
"id": {
"description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
"type": "string"
},
"usage": {
- "$ref": "Usage",
- "description": "Configuration controlling usage of this service."
+ "description": "Configuration controlling usage of this service.",
+ "$ref": "Usage"
},
"metrics": {
"description": "Defines the metrics used by this service.",
@@ -1523,44 +478,34 @@
"items": {
"$ref": "MetricDescriptor"
}
+ }
+ },
+ "id": "Service"
+ },
+ "EnumValue": {
+ "description": "Enum value definition.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Enum value name."
},
- "authentication": {
- "description": "Auth configuration.",
- "$ref": "Authentication"
- },
- "experimental": {
- "description": "Experimental configuration.",
- "$ref": "Experimental"
- },
- "control": {
- "$ref": "Control",
- "description": "Configuration for the service control plane."
- },
- "configVersion": {
- "description": "The semantic version of the service configuration. The config version\naffects the interpretation of the service configuration. For example,\ncertain features are enabled by default for certain config versions.\nThe latest config version is `3`.",
- "format": "uint32",
- "type": "integer"
- },
- "monitoring": {
- "$ref": "Monitoring",
- "description": "Monitoring configuration."
- },
- "systemTypes": {
- "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.",
+ "options": {
+ "description": "Protocol buffer options.",
"type": "array",
"items": {
- "$ref": "Type"
+ "$ref": "Option"
}
},
- "producerProjectId": {
- "description": "The Google project that owns this service.",
- "type": "string"
+ "number": {
+ "description": "Enum value number.",
+ "format": "int32",
+ "type": "integer"
}
- }
+ },
+ "id": "EnumValue"
},
"ListOperationsResponse": {
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -1574,10 +519,11 @@
"$ref": "Operation"
}
}
- }
+ },
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations."
},
"CustomHttpPattern": {
- "id": "CustomHttpPattern",
"description": "A custom pattern is used for defining custom HTTP verb.",
"type": "object",
"properties": {
@@ -1589,10 +535,10 @@
"description": "The name of this custom HTTP verb.",
"type": "string"
}
- }
+ },
+ "id": "CustomHttpPattern"
},
"OperationMetadata": {
- "id": "OperationMetadata",
"description": "The metadata associated with a long running operation resource.",
"type": "object",
"properties": {
@@ -1616,57 +562,43 @@
}
},
"progressPercentage": {
+ "type": "integer",
"description": "Percentage of completion of this operation, ranging from 0 to 100.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
}
- }
+ },
+ "id": "OperationMetadata"
},
"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": {
"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": "SystemParameterRule",
+ "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
+ "type": "object"
},
"HttpRule": {
"description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.",
"type": "object",
"properties": {
- "put": {
- "description": "Used for updating 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"
- }
- },
- "delete": {
- "description": "Used for deleting a resource.",
- "type": "string"
+ "mediaUpload": {
+ "$ref": "MediaUpload",
+ "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods."
},
"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"
},
- "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"
@@ -1680,15 +612,30 @@
"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."
},
"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"
+ "$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."
+ },
+ "get": {
+ "description": "Used for listing and getting information about resources.",
+ "type": "string"
},
"patch": {
"description": "Used for updating a resource.",
"type": "string"
},
- "get": {
- "description": "Used for listing and getting information about resources.",
+ "put": {
+ "description": "Used for updating 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"
+ }
+ },
+ "delete": {
+ "description": "Used for deleting a resource.",
"type": "string"
}
},
@@ -1742,7 +689,6 @@
"id": "Visibility"
},
"SystemParameters": {
- "id": "SystemParameters",
"description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.",
"type": "object",
"properties": {
@@ -1753,10 +699,10 @@
"$ref": "SystemParameterRule"
}
}
- }
+ },
+ "id": "SystemParameters"
},
"ConfigChange": {
- "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",
"properties": {
@@ -1765,12 +711,6 @@
"type": "string"
},
"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",
@@ -1778,7 +718,13 @@
"MODIFIED"
],
"description": "The type for this change, either ADDED, REMOVED, or MODIFIED.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "No value was provided.",
+ "The changed object exists in the 'new' service configuration, but not\nin the 'old' service configuration.",
+ "The changed object exists in the 'old' service configuration, but not\nin the 'new' service configuration.",
+ "The changed object exists in both service configurations, but its value\nis different."
+ ]
},
"element": {
"description": "Object hierarchy path to the change, with levels separated by a '.'\ncharacter. For repeated fields, an applicable unique identifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric index\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.CreateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs[key==\"reads\"].value\n- logging.producer_destinations[0]",
@@ -1795,28 +741,29 @@
"$ref": "Advice"
}
}
- }
+ },
+ "id": "ConfigChange"
},
"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"
- }
+ },
+ "description": "List of `QuotaLimit` definitions for the service."
},
"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"
+ "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.",
@@ -1827,8 +774,8 @@
"type": "string"
},
"deleteServiceStrategy": {
- "$ref": "DeleteServiceStrategy",
- "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly."
+ "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly.",
+ "$ref": "DeleteServiceStrategy"
},
"createTime": {
"description": "Creation time of the rollout. Readonly.",
@@ -1861,13 +808,13 @@
"description": "The name of the service associated with this Rollout.",
"type": "string"
},
- "createdBy": {
- "description": "The user who created the Rollout. Readonly.",
- "type": "string"
- },
"trafficPercentStrategy": {
- "$ref": "TrafficPercentStrategy",
- "description": "Google Service Control selects service configurations based on\ntraffic percentage."
+ "description": "Google Service Control selects service configurations based on\ntraffic percentage.",
+ "$ref": "TrafficPercentStrategy"
+ },
+ "createdBy": {
+ "type": "string",
+ "description": "The user who created the Rollout. Readonly."
}
},
"id": "Rollout"
@@ -1899,28 +846,31 @@
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
- "policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
- },
"updateMask": {
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
"format": "google-fieldmask",
"type": "string"
+ },
+ "policy": {
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "Policy"
}
},
"id": "SetIamPolicyRequest"
},
- "Step": {
- "description": "Represents the status of one operation step.",
+ "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": {
"properties": {
"description": {
"description": "The short description of the step.",
"type": "string"
},
"status": {
- "description": "The status code.",
"type": "string",
"enumDescriptions": [
"Unspecifed code.",
@@ -1937,37 +887,33 @@
"IN_PROGRESS",
"FAILED",
"CANCELLED"
- ]
+ ],
+ "description": "The status code."
}
},
- "id": "Step"
- },
- "DeleteServiceStrategy": {
- "id": "DeleteServiceStrategy",
- "description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.",
- "type": "object",
- "properties": {}
+ "id": "Step",
+ "description": "Represents the status of one operation step.",
+ "type": "object"
},
"LoggingDestination": {
- "id": "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"
}
+ },
+ "monitoredResource": {
+ "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.",
+ "type": "string"
}
- }
+ },
+ "id": "LoggingDestination",
+ "description": "Configuration of a specific logging destination (the producer project\nor the consumer project)."
},
"Option": {
- "id": "Option",
"description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
"type": "object",
"properties": {
@@ -1983,7 +929,8 @@
"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",
@@ -2006,57 +953,24 @@
},
"id": "Logging"
},
- "Method": {
- "description": "Method represents a method of an API interface.",
- "type": "object",
- "properties": {
- "responseStreaming": {
- "description": "If true, the response is streamed.",
- "type": "boolean"
- },
- "name": {
- "description": "The simple name of this method.",
- "type": "string"
- },
- "requestTypeUrl": {
- "description": "A URL of the input message type.",
- "type": "string"
- },
- "requestStreaming": {
- "description": "If true, the request is streamed.",
- "type": "boolean"
- },
- "syntax": {
- "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"
- },
"QuotaLimit": {
- "id": "QuotaLimit",
"description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
"type": "object",
"properties": {
+ "duration": {
+ "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.",
+ "type": "string"
+ },
+ "freeTier": {
+ "type": "string",
+ "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
+ "format": "int64"
+ },
+ "defaultLimit": {
+ "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.",
+ "format": "int64",
+ "type": "string"
+ },
"description": {
"description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).",
"type": "string"
@@ -2082,43 +996,64 @@
"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",
- "type": "string"
+ "format": "int64"
},
"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"
},
- "ConfigRef": {
- "id": "ConfigRef",
- "description": "Represents a service configuration with its name and id.",
+ "Method": {
+ "description": "Method represents a method of an API interface.",
"type": "object",
"properties": {
+ "responseStreaming": {
+ "description": "If true, the response is streamed.",
+ "type": "boolean"
+ },
"name": {
- "description": "Resource name of a service config. It must have the following\nformat: \"services/{service name}/configs/{config id}\".",
+ "description": "The simple name of this method.",
"type": "string"
+ },
+ "requestTypeUrl": {
+ "description": "A URL of the input message type.",
+ "type": "string"
+ },
+ "requestStreaming": {
+ "description": "If true, the request is streamed.",
+ "type": "boolean"
+ },
+ "syntax": {
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of this method.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ]
+ },
+ "responseTypeUrl": {
+ "description": "The URL of the output message type.",
+ "type": "string"
+ },
+ "options": {
+ "description": "Any metadata attached to the method.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
}
- }
+ },
+ "id": "Method"
},
"ListServiceRolloutsResponse": {
- "description": "Response message for ListServiceRollouts method.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -2133,75 +1068,65 @@
}
}
},
- "id": "ListServiceRolloutsResponse"
+ "id": "ListServiceRolloutsResponse",
+ "description": "Response message for ListServiceRollouts method."
},
- "Mixin": {
- "description": "Declares an API Interface to be included in this interface. The including\ninterface must redeclare all the methods from the included interface, but\ndocumentation and options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including interface plus the root path if\n specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }",
+ "ConfigRef": {
+ "id": "ConfigRef",
+ "description": "Represents a service configuration with its name and id.",
"type": "object",
"properties": {
"name": {
- "description": "The fully qualified name of the interface which is included.",
+ "description": "Resource name of a service config. It must have the following\nformat: \"services/{service name}/configs/{config id}\".",
"type": "string"
- },
+ }
+ }
+ },
+ "Mixin": {
+ "properties": {
"root": {
"description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.",
"type": "string"
+ },
+ "name": {
+ "description": "The fully qualified name of the interface which is included.",
+ "type": "string"
}
},
- "id": "Mixin"
+ "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"
},
"FlowOperationMetadata": {
- "id": "FlowOperationMetadata",
- "description": "The metadata associated with a long running operation resource.",
- "type": "object",
"properties": {
- "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": {
+ "type": "integer",
"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"
+ "format": "int32"
},
"startTime": {
+ "type": "string",
"description": "The start time of the operation.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"surface": {
+ "enum": [
+ "UNSPECIFIED_OP_SERVICE",
+ "SERVICE_MANAGEMENT",
+ "SERVICE_USAGE",
+ "SERVICE_CONSUMER_MANAGEMENT"
+ ],
"type": "string",
"enumDescriptions": [
"",
"",
"",
"TenancyUnit, ServiceNetworking fall under this"
- ],
- "enum": [
- "UNSPECIFIED_OP_SERVICE",
- "SERVICE_MANAGEMENT",
- "SERVICE_USAGE",
- "SERVICE_CONSUMER_MANAGEMENT"
]
},
"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"
+ "type": "string",
+ "description": "The name of the top-level flow corresponding to this operation.\nMust be equal to the \"name\" field for a FlowName enum."
},
"resourceNames": {
"description": "The full name of the resources that this flow is directly associated with.",
@@ -2209,8 +1134,30 @@
"items": {
"type": "string"
}
+ },
+ "cancelState": {
+ "enum": [
+ "RUNNING",
+ "UNCANCELLABLE",
+ "CANCELLED"
+ ],
+ "description": "The state of the operation with respect to cancellation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default state, cancellable but not cancelled.",
+ "The operation has proceeded past the point of no return and cannot\nbe cancelled.",
+ "The operation has been cancelled, work should cease\nand any needed rollback steps executed."
+ ]
+ },
+ "deadline": {
+ "description": "Deadline for the flow to complete, to prevent orphaned Operations.\n\nIf the flow has not completed by this time, it may be terminated by\nthe engine, or force-failed by Operation lookup.\n\nNote that this is not a hard deadline after which the Flow will\ndefinitely be failed, rather it is a deadline after which it is reasonable\nto suspect a problem and other parts of the system may kill operation\nto ensure we don't have orphans.\nsee also: go/prevent-orphaned-operations",
+ "format": "google-datetime",
+ "type": "string"
}
- }
+ },
+ "id": "FlowOperationMetadata",
+ "description": "The metadata associated with a long running operation resource.",
+ "type": "object"
},
"CustomError": {
"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",
@@ -2237,22 +1184,21 @@
"description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
"type": "object",
"properties": {
- "rules": {
- "description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "HttpRule"
- }
- },
"fullyDecodeReservedExpansion": {
"description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
"type": "boolean"
+ },
+ "rules": {
+ "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"
},
"SourceInfo": {
- "description": "Source information used to create a Service Config",
"type": "object",
"properties": {
"sourceFiles": {
@@ -2267,7 +1213,8 @@
}
}
},
- "id": "SourceInfo"
+ "id": "SourceInfo",
+ "description": "Source information used to create a Service Config"
},
"Control": {
"description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
@@ -2281,8 +1228,6 @@
"id": "Control"
},
"SystemParameter": {
- "id": "SystemParameter",
- "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
"type": "object",
"properties": {
"urlQueryParameter": {
@@ -2297,22 +1242,24 @@
"description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
"type": "string"
}
- }
+ },
+ "id": "SystemParameter",
+ "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent."
},
"Monitoring": {
"id": "Monitoring",
"description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
"type": "object",
"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.",
+ "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"
}
},
- "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.",
+ "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"
@@ -2324,10 +1271,14 @@
"description": "A single field of a message type.",
"type": "object",
"properties": {
- "name": {
- "description": "The field name.",
+ "defaultValue": {
+ "description": "The string value of the default value of this field. Proto2 syntax only.",
"type": "string"
},
+ "name": {
+ "type": "string",
+ "description": "The field name."
+ },
"typeUrl": {
"description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
"type": "string"
@@ -2388,11 +1339,11 @@
"type": "string"
},
"options": {
- "description": "The protocol buffer options.",
"type": "array",
"items": {
"$ref": "Option"
- }
+ },
+ "description": "The protocol buffer options."
},
"oneofIndex": {
"description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
@@ -2400,12 +1351,6 @@
"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",
@@ -2413,22 +1358,22 @@
"CARDINALITY_REPEATED"
],
"description": "The field cardinality.",
- "type": "string"
+ "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"
}
},
"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).",
@@ -2438,13 +1383,31 @@
}
}
},
- "id": "TestIamPermissionsRequest"
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object"
},
"Enum": {
"id": "Enum",
"description": "Enum type definition.",
"type": "object",
"properties": {
+ "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"
@@ -2462,35 +1425,37 @@
"items": {
"$ref": "Option"
}
- },
- "sourceContext": {
- "description": "The source context.",
- "$ref": "SourceContext"
- },
- "syntax": {
- "description": "The source syntax.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ]
}
}
},
- "EnableServiceRequest": {
- "description": "Request message for EnableService method.",
+ "LabelDescriptor": {
+ "description": "A description of a label.",
"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.",
+ "key": {
+ "description": "The label key.",
"type": "string"
+ },
+ "description": {
+ "description": "A human-readable description for the label.",
+ "type": "string"
+ },
+ "valueType": {
+ "description": "The type of data that can be assigned to the label.",
+ "type": "string",
+ "enumDescriptions": [
+ "A variable-length string. This is the default.",
+ "Boolean; true or false.",
+ "A 64-bit signed integer."
+ ],
+ "enum": [
+ "STRING",
+ "BOOL",
+ "INT64"
+ ]
}
},
- "id": "EnableServiceRequest"
+ "id": "LabelDescriptor"
},
"Diagnostic": {
"description": "Represents a diagnostic message (error or warning)",
@@ -2519,39 +1484,28 @@
},
"id": "Diagnostic"
},
- "LabelDescriptor": {
- "id": "LabelDescriptor",
- "description": "A description of a label.",
+ "EnableServiceRequest": {
+ "description": "Request message for EnableService method.",
"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.",
+ "consumerId": {
+ "description": "The identity of consumer resource which service enablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
"type": "string"
}
- }
+ },
+ "id": "EnableServiceRequest"
},
"Type": {
"description": "A protocol buffer message type.",
"type": "object",
"properties": {
+ "fields": {
+ "type": "array",
+ "items": {
+ "$ref": "Field"
+ },
+ "description": "The list of fields."
+ },
"name": {
"description": "The fully qualified message name.",
"type": "string"
@@ -2564,8 +1518,8 @@
}
},
"sourceContext": {
- "description": "The source context.",
- "$ref": "SourceContext"
+ "$ref": "SourceContext",
+ "description": "The source context."
},
"syntax": {
"description": "The source syntax.",
@@ -2585,25 +1539,12 @@
"items": {
"$ref": "Option"
}
- },
- "fields": {
- "description": "The list of fields.",
- "type": "array",
- "items": {
- "$ref": "Field"
- }
}
},
"id": "Type"
},
"GenerateConfigReportResponse": {
- "description": "Response message for GenerateConfigReport method.",
- "type": "object",
"properties": {
- "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",
@@ -2616,34 +1557,41 @@
"type": "string"
},
"changeReports": {
- "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
"type": "array",
"items": {
"$ref": "ChangeReport"
- }
+ },
+ "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations."
+ },
+ "id": {
+ "description": "ID of the service configuration this report belongs to.",
+ "type": "string"
}
},
- "id": "GenerateConfigReportResponse"
+ "id": "GenerateConfigReportResponse",
+ "description": "Response message for GenerateConfigReport method.",
+ "type": "object"
},
"ListServiceConfigsResponse": {
"id": "ListServiceConfigsResponse",
"description": "Response message for ListServiceConfigs method.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The token of the next page of results.",
+ "type": "string"
+ },
"serviceConfigs": {
"description": "The list of service configuration resources.",
"type": "array",
"items": {
"$ref": "Service"
}
- },
- "nextPageToken": {
- "description": "The token of the next page of results.",
- "type": "string"
}
}
},
"Experimental": {
+ "id": "Experimental",
"description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
"type": "object",
"properties": {
@@ -2651,13 +1599,9 @@
"$ref": "AuthorizationConfig",
"description": "Authorization configuration."
}
- },
- "id": "Experimental"
+ }
},
"Backend": {
- "id": "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.",
@@ -2666,7 +1610,10 @@
"$ref": "BackendRule"
}
}
- }
+ },
+ "id": "Backend",
+ "description": "`Backend` defines the backend configuration for a service.",
+ "type": "object"
},
"SubmitConfigSourceRequest": {
"description": "Request message for SubmitConfigSource method.",
@@ -2684,7 +1631,6 @@
"id": "SubmitConfigSourceRequest"
},
"DocumentationRule": {
- "id": "DocumentationRule",
"description": "A documentation rule provides information about individual API elements.",
"type": "object",
"properties": {
@@ -2700,10 +1646,10 @@
"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"
},
"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": {
@@ -2711,20 +1657,14 @@
"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"
},
"ContextRule": {
"id": "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"
@@ -2735,27 +1675,35 @@
"items": {
"type": "string"
}
+ },
+ "requested": {
+ "description": "A list of full type names of requested contexts.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
}
},
- "SourceContext": {
- "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
+ "Billing": {
"type": "object",
"properties": {
- "fileName": {
- "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
- "type": "string"
+ "consumerDestinations": {
+ "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "BillingDestination"
+ }
}
},
- "id": "SourceContext"
+ "id": "Billing",
+ "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"
},
"MetricDescriptor": {
- "id": "MetricDescriptor",
"description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
"type": "object",
"properties": {
"metricKind": {
- "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.",
@@ -2768,16 +1716,17 @@
"GAUGE",
"DELTA",
"CUMULATIVE"
- ]
- },
- "displayName": {
- "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".\nThis field is optional but it is recommended to be set for any metrics\nassociated with user-visible concepts, such as Quota.",
- "type": "string"
+ ],
+ "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported."
},
"description": {
"description": "A detailed description of the metric, which can be used in documentation.",
"type": "string"
},
+ "displayName": {
+ "description": "A concise name for the metric, which can be displayed in user interfaces.\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"
@@ -2819,27 +1768,32 @@
"description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
"type": "string"
}
- }
+ },
+ "id": "MetricDescriptor"
},
- "Billing": {
- "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": {
- "consumerDestinations": {
- "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination.",
- "type": "array",
- "items": {
- "$ref": "BillingDestination"
- }
+ "fileName": {
+ "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
+ "type": "string"
}
- }
+ },
+ "id": "SourceContext"
},
"Expr": {
- "id": "Expr",
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression."
+ },
+ "location": {
+ "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
+ "type": "string"
+ },
"description": {
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
"type": "string"
@@ -2847,19 +1801,11 @@
"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"
},
"ListServicesResponse": {
- "id": "ListServicesResponse",
"description": "Response message for `ListServices` method.",
"type": "object",
"properties": {
@@ -2874,12 +1820,10 @@
"description": "Token that can be passed to `ListServices` to resume a paginated query.",
"type": "string"
}
- }
+ },
+ "id": "ListServicesResponse"
},
"Endpoint": {
- "id": "Endpoint",
- "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
- "type": "object",
"properties": {
"aliases": {
"description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intended\naliases.\n\nAdditional names that this endpoint will be hosted on.",
@@ -2889,11 +1833,11 @@
}
},
"features": {
- "description": "The list of features enabled on this endpoint.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "The list of features enabled on this endpoint."
},
"allowCors": {
"description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
@@ -2907,7 +1851,10 @@
"description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
"type": "string"
}
- }
+ },
+ "id": "Endpoint",
+ "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
+ "type": "object"
},
"OAuthRequirements": {
"description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
@@ -2920,7 +1867,28 @@
},
"id": "OAuthRequirements"
},
+ "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"
+ },
"Usage": {
+ "id": "Usage",
"description": "Configuration controlling usage of a service.",
"type": "object",
"properties": {
@@ -2942,33 +1910,9 @@
"type": "string"
}
}
- },
- "id": "Usage"
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
- },
- "TestIamPermissionsResponse": {
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
}
},
"Context": {
- "id": "Context",
- "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
- "type": "object",
"properties": {
"rules": {
"description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
@@ -2977,10 +1921,12 @@
"$ref": "ContextRule"
}
}
- }
+ },
+ "id": "Context",
+ "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
+ "type": "object"
},
"LogDescriptor": {
- "id": "LogDescriptor",
"description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
"type": "object",
"properties": {
@@ -3003,17 +1949,11 @@
"$ref": "LabelDescriptor"
}
}
- }
+ },
+ "id": "LogDescriptor"
},
"ConfigFile": {
- "id": "ConfigFile",
- "description": "Generic specification of a source configuration file",
- "type": "object",
"properties": {
- "filePath": {
- "description": "The file name of the configuration file (full or relative path).",
- "type": "string"
- },
"fileType": {
"enumDescriptions": [
"Unknown file type.",
@@ -3038,23 +1978,15 @@
"description": "The bytes that constitute the file.",
"format": "byte",
"type": "string"
- }
- }
- },
- "CustomErrorRule": {
- "id": "CustomErrorRule",
- "description": "A custom error rule.",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
},
- "isErrorType": {
- "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
- "type": "boolean"
+ "filePath": {
+ "description": "The file name of the configuration file (full or relative path).",
+ "type": "string"
}
- }
+ },
+ "id": "ConfigFile",
+ "description": "Generic specification of a source configuration file",
+ "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.",
@@ -3086,25 +2018,25 @@
},
"id": "MonitoredResourceDescriptor"
},
- "CustomAuthRequirements": {
- "description": "Configuration for a custom authentication provider.",
+ "CustomErrorRule": {
"type": "object",
"properties": {
- "provider": {
- "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
+ "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": "CustomAuthRequirements"
+ "id": "CustomErrorRule",
+ "description": "A custom error rule."
},
"MediaDownload": {
"description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
"type": "object",
"properties": {
- "completeNotification": {
- "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.",
- "type": "boolean"
- },
"enabled": {
"description": "Whether download is enabled.",
"type": "boolean"
@@ -3113,6 +2045,10 @@
"description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
"type": "string"
},
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.",
+ "type": "boolean"
+ },
"maxDirectDownloadSize": {
"description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
"format": "int64",
@@ -3129,8 +2065,18 @@
},
"id": "MediaDownload"
},
+ "CustomAuthRequirements": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
+ "type": "string"
+ }
+ },
+ "id": "CustomAuthRequirements",
+ "description": "Configuration for a custom authentication provider."
+ },
"ChangeReport": {
- "id": "ChangeReport",
"description": "Change report associated with a particular service configuration.\n\nIt contains a list of ConfigChanges based on the comparison between\ntwo service configurations.",
"type": "object",
"properties": {
@@ -3141,7 +2087,199 @@
"$ref": "ConfigChange"
}
}
+ },
+ "id": "ChangeReport"
+ },
+ "DisableServiceRequest": {
+ "description": "Request message for DisableService method.",
+ "type": "object",
+ "properties": {
+ "consumerId": {
+ "description": "The identity of consumer resource which service disablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
+ "type": "string"
+ }
+ },
+ "id": "DisableServiceRequest"
+ },
+ "SubmitConfigSourceResponse": {
+ "description": "Response message for SubmitConfigSource method.",
+ "type": "object",
+ "properties": {
+ "serviceConfig": {
+ "description": "The generated service configuration.",
+ "$ref": "Service"
+ }
+ },
+ "id": "SubmitConfigSourceResponse"
+ },
+ "MediaUpload": {
+ "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
+ "type": "object",
+ "properties": {
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
+ "type": "boolean"
+ },
+ "progressNotification": {
+ "description": "Whether to receive a notification for progress changes of media upload.",
+ "type": "boolean"
+ },
+ "enabled": {
+ "description": "Whether upload is enabled.",
+ "type": "boolean"
+ },
+ "dropzone": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
+ },
+ "startNotification": {
+ "description": "Whether to receive a notification on the start of media upload.",
+ "type": "boolean"
+ },
+ "uploadService": {
+ "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
+ "type": "string"
+ },
+ "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"
+ },
+ "BillingDestination": {
+ "id": "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"
+ }
+ }
}
+ },
+ "Advice": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Useful description for why this advice was applied and what actions should\nbe taken to mitigate any implied risks.",
+ "type": "string"
+ }
+ },
+ "id": "Advice",
+ "description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service."
+ },
+ "ManagedService": {
+ "description": "The full representation of a Service that is managed by\nGoogle Service Management.",
+ "type": "object",
+ "properties": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements.",
+ "type": "string"
+ },
+ "producerProjectId": {
+ "description": "ID of the project that produces and owns this service.",
+ "type": "string"
+ }
+ },
+ "id": "ManagedService"
+ },
+ "UsageRule": {
+ "id": "UsageRule",
+ "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
+ "type": "object",
+ "properties": {
+ "selector": {
+ "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "skipServiceControl": {
+ "type": "boolean",
+ "description": "If true, the selected method should skip service control and the control\nplane features, such as quota and billing, will not be available.\nThis flag is used by Google Cloud Endpoints to bypass checks for internal\nmethods, such as service health check methods."
+ },
+ "allowUnregisteredCalls": {
+ "description": "If true, the selected method allows unregistered calls, e.g. calls\nthat don't identify any user or application.",
+ "type": "boolean"
+ }
+ }
+ },
+ "AuthRequirement": {
+ "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
+ "type": "object",
+ "properties": {
+ "audiences": {
+ "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
+ "type": "string"
+ },
+ "providerId": {
+ "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
+ "type": "string"
+ }
+ },
+ "id": "AuthRequirement"
+ },
+ "TrafficPercentStrategy": {
+ "description": "Strategy that specifies how clients of Google Service Controller want to\nsend traffic to use different config versions. This is generally\nused by API proxy to split traffic based on your configured precentage for\neach config version.\n\nOne example of how to gradually rollout a new service configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160206\"\n traffic_percent_strategy {\n percentages: {\n \"example.googleapis.com/20160201\": 70.00\n \"example.googleapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160207\"\n traffic_percent_strategy: {\n percentages: {\n \"example.googleapis.com/20160206\": 100.00\n }\n }\n }",
+ "type": "object",
+ "properties": {
+ "percentages": {
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "Maps service configuration IDs to their corresponding traffic percentage.\nKey is the service configuration ID, Value is the traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 100.0.",
+ "type": "object"
+ }
+ },
+ "id": "TrafficPercentStrategy"
+ },
+ "Documentation": {
+ "properties": {
+ "rules": {
+ "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "DocumentationRule"
+ }
+ },
+ "overview": {
+ "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.",
+ "type": "string"
+ },
+ "pages": {
+ "description": "The top level pages for the documentation set.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ },
+ "summary": {
+ "type": "string",
+ "description": "A short summary of what the service does. Can only be provided by\nplain text."
+ },
+ "documentationRootUrl": {
+ "description": "The URL to the root of documentation.",
+ "type": "string"
+ }
+ },
+ "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"
}
},
"icons": {
@@ -3173,5 +2311,867 @@
"name": "servicemanagement",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Google Service Management API"
+ "title": "Google Service Management API",
+ "ownerName": "Google",
+ "resources": {
+ "services": {
+ "methods": {
+ "disable": {
+ "flatPath": "v1/services/{serviceName}:disable",
+ "path": "v1/services/{serviceName}:disable",
+ "id": "servicemanagement.services.disable",
+ "request": {
+ "$ref": "DisableServiceRequest"
+ },
+ "description": "Disables a service for a project, so it can no longer be\nbe used for the project. It prevents accidental usage that may cause\nunexpected billing charges or security leaks.\n\nOperation\u003cresponse: DisableServiceResponse\u003e",
+ "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"
+ ]
+ },
+ "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": {
+ "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",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ }
+ },
+ "undelete": {
+ "description": "Revives a previously deleted managed service. The method restores the\nservice using the configuration at the time the service was deleted.\nThe target service must exist and must have been deleted within the\nlast 30 days.\n\nOperation\u003cresponse: UndeleteServiceResponse\u003e",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "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"
+ },
+ "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}\".",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "parameters": {
+ "consumerId": {
+ "location": "query",
+ "description": "Include services consumed by the specified consumer.\n\nThe Google Service Management implementation accepts the following\nforms:\n- project:\u003cproject_id\u003e",
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Token identifying which result to start with; returned by a previous list\ncall."
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested size of the next page of data.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "producerProjectId": {
+ "description": "Include services produced by the specified project.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "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",
+ "id": "servicemanagement.services.list",
+ "path": "v1/services"
+ },
+ "create": {
+ "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",
+ "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"
+ },
+ "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"
+ ],
+ "flatPath": "v1/services:generateConfigReport",
+ "path": "v1/services:generateConfigReport",
+ "id": "servicemanagement.services.generateConfigReport"
+ },
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the `ServiceManager` overview for naming\nrequirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}",
+ "path": "v1/services/{serviceName}",
+ "id": "servicemanagement.services.get",
+ "description": "Gets a managed service. Authentication is required unless the service is\npublic.",
+ "response": {
+ "$ref": "ManagedService"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "GET"
+ },
+ "testIamPermissions": {
+ "flatPath": "v1/services/{servicesId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "servicemanagement.services.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "resource": {
+ "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"
+ }
+ }
+ },
+ "getConfig": {
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "serviceName": {
+ "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`."
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}/config",
+ "path": "v1/services/{serviceName}/config",
+ "id": "servicemanagement.services.getConfig",
+ "description": "Gets a service configuration (version) for a managed service."
+ },
+ "enable": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services/{serviceName}:enable",
+ "path": "v1/services/{serviceName}:enable",
+ "id": "servicemanagement.services.enable",
+ "request": {
+ "$ref": "EnableServiceRequest"
+ },
+ "description": "Enables a service for a project, so it can be used\nfor the project. See\n[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: EnableServiceResponse\u003e"
+ },
+ "delete": {
+ "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": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "pattern": "^services/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field."
+ }
+ },
+ "flatPath": "v1/services/{servicesId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "servicemanagement.services.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"
+ }
+ },
+ "resources": {
+ "consumers": {
+ "methods": {
+ "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": "^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",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "servicemanagement.services.consumers.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."
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^services/[^/]+/consumers/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy",
+ "id": "servicemanagement.services.consumers.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^services/[^/]+/consumers/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "servicemanagement.services.consumers.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
+ }
+ }
+ },
+ "rollouts": {
+ "methods": {
+ "list": {
+ "flatPath": "v1/services/{serviceName}/rollouts",
+ "path": "v1/services/{serviceName}/rollouts",
+ "id": "servicemanagement.services.rollouts.list",
+ "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.",
+ "response": {
+ "$ref": "ListServiceRolloutsResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "Use `filter` to return subset of rollouts.\nThe following filters are supported:\n -- To limit the results to only those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',\n use filter='status=SUCCESS'\n -- To limit the results to those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'\n or 'FAILED', use filter='status=CANCELLED OR status=FAILED'",
+ "type": "string"
+ },
+ "serviceName": {
+ "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": {
+ "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"
+ ]
+ },
+ "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": {
+ "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.",
+ "response": {
+ "$ref": "Rollout"
+ },
+ "parameterOrder": [
+ "serviceName",
+ "rolloutId"
+ ],
+ "httpMethod": "GET"
+ },
+ "create": {
+ "request": {
+ "$ref": "Rollout"
+ },
+ "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the service configurations to\ndifferent backend services. For example, the logging configuration will be\npushed to Google Cloud Logging.\n\nPlease note that any previous pending and running Rollouts and associated\nOperations will be automatically cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts.\n\nOperation\u003cresponse: Rollout\u003e",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "serviceName": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services/{serviceName}/rollouts",
+ "path": "v1/services/{serviceName}/rollouts",
+ "id": "servicemanagement.services.rollouts.create"
+ }
+ }
+ },
+ "configs": {
+ "methods": {
+ "list": {
+ "id": "servicemanagement.services.configs.list",
+ "path": "v1/services/{serviceName}/configs",
+ "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": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The token of the page to retrieve."
+ },
+ "pageSize": {
+ "description": "The max number of items to include in the response list.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "flatPath": "v1/services/{serviceName}/configs"
+ },
+ "get": {
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "serviceName",
+ "configId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "configId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The id of the service configuration resource."
+ },
+ "view": {
+ "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ]
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "flatPath": "v1/services/{serviceName}/configs/{configId}",
+ "path": "v1/services/{serviceName}/configs/{configId}",
+ "id": "servicemanagement.services.configs.get",
+ "description": "Gets a service configuration (version) for a managed service."
+ },
+ "create": {
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}/configs",
+ "path": "v1/services/{serviceName}/configs",
+ "id": "servicemanagement.services.configs.create",
+ "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.",
+ "request": {
+ "$ref": "Service"
+ }
+ },
+ "submit": {
+ "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",
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A string for filtering Operations.\n The following filter fields are supported:\n\n * serviceName: Required. Only `=` operator is allowed.\n * startTime: The time this job was started, in ISO 8601 format.\n Allowed operators are `\u003e=`, `\u003e`, `\u003c=`, and `\u003c`.\n * status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjunction (OR)\n logical operators. However, the serviceName restriction must be at the\n top-level and can only be combined with other restrictions via the AND\n logical operator.\n\n Examples:\n\n * `serviceName={some-service}.googleapis.com`\n * `serviceName={some-service}.googleapis.com AND startTime\u003e=\"2017-02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `serviceName={some-service}.googleapis.com AND (status=done OR startTime\u003e=\"2017-02-01\")`"
+ },
+ "name": {
+ "location": "query",
+ "description": "Not used.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/operations",
+ "path": "v1/operations",
+ "id": "servicemanagement.operations.list",
+ "description": "Lists service operations that match the specified filter in the request.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET"
+ },
+ "get": {
+ "path": "v1/{+name}",
+ "id": "servicemanagement.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/operations/{operationsId}"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://servicemanagement.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "servicemanagement:v1",
+ "revision": "20180123",
+ "documentationLink": "https://cloud.google.com/service-management/"
}
diff --git a/serviceuser/v1/serviceuser-api.json b/serviceuser/v1/serviceuser-api.json
index 4df0133..5917dcd 100644
--- a/serviceuser/v1/serviceuser-api.json
+++ b/serviceuser/v1/serviceuser-api.json
@@ -5,366 +5,11 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "SearchServicesResponse": {
- "description": "Response message for SearchServices method.",
- "type": "object",
- "properties": {
- "services": {
- "description": "Services available publicly or available to the authenticated caller.",
- "type": "array",
- "items": {
- "$ref": "PublishedService"
- }
- },
- "nextPageToken": {
- "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery.",
- "type": "string"
- }
- },
- "id": "SearchServicesResponse"
- },
- "MediaUpload": {
- "id": "MediaUpload",
- "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
- "type": "object",
- "properties": {
- "maxSize": {
- "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
- "format": "int64",
- "type": "string"
- },
- "mimeTypes": {
- "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "completeNotification": {
- "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
- "type": "boolean"
- },
- "progressNotification": {
- "description": "Whether to receive a notification for progress changes of media upload.",
- "type": "boolean"
- },
- "enabled": {
- "description": "Whether upload is enabled.",
- "type": "boolean"
- },
- "dropzone": {
- "description": "Name of the Scotty dropzone to use for the current API.",
- "type": "string"
- },
- "startNotification": {
- "description": "Whether to receive a notification on the start of media upload.",
- "type": "boolean"
- },
- "uploadService": {
- "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
- "type": "string"
- }
- }
- },
- "BillingDestination": {
- "id": "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"
- }
- }
- }
- },
- "UsageRule": {
- "id": "UsageRule",
- "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "skipServiceControl": {
- "description": "If true, the selected method should skip service control and the control\nplane features, such as quota and billing, will not be available.\nThis flag is used by Google Cloud Endpoints to bypass checks for internal\nmethods, such as service health check methods.",
- "type": "boolean"
- },
- "allowUnregisteredCalls": {
- "description": "If true, the selected method allows unregistered calls, e.g. calls\nthat don't identify any user or application.",
- "type": "boolean"
- }
- }
- },
- "AuthRequirement": {
- "id": "AuthRequirement",
- "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
- "type": "object",
- "properties": {
- "audiences": {
- "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
- "type": "string"
- },
- "providerId": {
- "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
- "type": "string"
- }
- }
- },
- "Documentation": {
- "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
- "type": "object",
- "properties": {
- "summary": {
- "description": "A short summary of what the service does. Can only be provided by\nplain text.",
- "type": "string"
- },
- "documentationRootUrl": {
- "description": "The URL to the root of documentation.",
- "type": "string"
- },
- "rules": {
- "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "DocumentationRule"
- }
- },
- "overview": {
- "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.",
- "type": "string"
- },
- "pages": {
- "description": "The top level pages for the documentation set.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- }
- },
- "id": "Documentation"
- },
- "AuthenticationRule": {
- "id": "AuthenticationRule",
- "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "allowWithoutCredential": {
- "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
- "type": "boolean"
- },
- "oauth": {
- "$ref": "OAuthRequirements",
- "description": "The requirements for OAuth credentials."
- },
- "customAuth": {
- "$ref": "CustomAuthRequirements",
- "description": "Configuration for custom authentication."
- },
- "requirements": {
- "description": "Requirements for additional authentication providers.",
- "type": "array",
- "items": {
- "$ref": "AuthRequirement"
- }
- }
- }
- },
- "BackendRule": {
- "id": "BackendRule",
- "description": "A backend rule provides configuration for an individual API element.",
- "type": "object",
- "properties": {
- "minDeadline": {
- "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
- "format": "double",
- "type": "number"
- },
- "address": {
- "description": "The address of the API backend.",
- "type": "string"
- },
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "deadline": {
- "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.",
- "format": "double",
- "type": "number"
- }
- }
- },
- "Api": {
- "id": "Api",
- "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.",
- "type": "object",
- "properties": {
- "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": {
- "description": "Source context for the protocol buffer service represented by this\nmessage.",
- "$ref": "SourceContext"
- },
- "version": {
- "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n",
- "type": "string"
- },
- "mixins": {
- "description": "Included interfaces. See Mixin.",
- "type": "array",
- "items": {
- "$ref": "Mixin"
- }
- },
- "options": {
- "description": "Any metadata attached to the interface.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "methods": {
- "description": "The methods of this interface, in unspecified order.",
- "type": "array",
- "items": {
- "$ref": "Method"
- }
- }
- }
- },
- "MetricRule": {
- "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "metricCosts": {
- "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the map is the metric name, and the values are the amount\nincreased for the metric against which the quota limits are defined.\nThe value must not be negative.",
- "type": "object",
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- }
- }
- },
- "id": "MetricRule"
- },
- "Authentication": {
- "id": "Authentication",
- "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "AuthenticationRule"
- }
- },
- "providers": {
- "description": "Defines a set of authentication providers that a service supports.",
- "type": "array",
- "items": {
- "$ref": "AuthProvider"
- }
- }
- }
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "id": "Operation"
- },
- "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": {
"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"
@@ -373,17 +18,21 @@
"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"
}
}
},
"AuthProvider": {
- "id": "AuthProvider",
"description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
"type": "object",
"properties": {
@@ -407,34 +56,21 @@
"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": {
+ "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",
"properties": {
- "usage": {
- "description": "Configuration controlling usage of this service.",
- "$ref": "Usage"
- },
- "metrics": {
- "description": "Defines the metrics used by this service.",
- "type": "array",
- "items": {
- "$ref": "MetricDescriptor"
- }
- },
- "authentication": {
- "description": "Auth configuration.",
- "$ref": "Authentication"
- },
"experimental": {
- "$ref": "Experimental",
- "description": "Experimental configuration."
+ "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`.",
@@ -442,8 +78,8 @@
"type": "integer"
},
"monitoring": {
- "$ref": "Monitoring",
- "description": "Monitoring configuration."
+ "description": "Monitoring configuration.",
+ "$ref": "Monitoring"
},
"systemTypes": {
"description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.",
@@ -457,21 +93,21 @@
"type": "string"
},
"visibility": {
- "description": "API visibility configuration.",
- "$ref": "Visibility"
+ "$ref": "Visibility",
+ "description": "API visibility configuration."
},
"quota": {
- "description": "Quota configuration.",
- "$ref": "Quota"
- },
- "billing": {
- "$ref": "Billing",
- "description": "Billing configuration."
+ "$ref": "Quota",
+ "description": "Quota configuration."
},
"name": {
"description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
"type": "string"
},
+ "billing": {
+ "description": "Billing configuration.",
+ "$ref": "Billing"
+ },
"customError": {
"description": "Custom error configuration.",
"$ref": "CustomError"
@@ -487,13 +123,6 @@
"$ref": "Endpoint"
}
},
- "apis": {
- "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
- "type": "array",
- "items": {
- "$ref": "Api"
- }
- },
"logs": {
"description": "Defines the logs used by this service.",
"type": "array",
@@ -501,6 +130,13 @@
"$ref": "LogDescriptor"
}
},
+ "apis": {
+ "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
+ "type": "array",
+ "items": {
+ "$ref": "Api"
+ }
+ },
"types": {
"description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
"type": "array",
@@ -525,8 +161,12 @@
"description": "System parameter configuration."
},
"documentation": {
- "$ref": "Documentation",
- "description": "Additional API documentation."
+ "description": "Additional API documentation.",
+ "$ref": "Documentation"
+ },
+ "logging": {
+ "$ref": "Logging",
+ "description": "Logging configuration."
},
"monitoredResources": {
"description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
@@ -535,10 +175,6 @@
"$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",
@@ -553,9 +189,23 @@
"id": {
"description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
"type": "string"
+ },
+ "usage": {
+ "description": "Configuration controlling usage of this service.",
+ "$ref": "Usage"
+ },
+ "metrics": {
+ "description": "Defines the metrics used by this service.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricDescriptor"
+ }
+ },
+ "authentication": {
+ "description": "Auth configuration.",
+ "$ref": "Authentication"
}
- },
- "id": "Service"
+ }
},
"EnumValue": {
"description": "Enum value definition.",
@@ -596,6 +246,7 @@
"id": "CustomHttpPattern"
},
"OperationMetadata": {
+ "id": "OperationMetadata",
"description": "The metadata associated with a long running operation resource.",
"type": "object",
"properties": {
@@ -623,23 +274,22 @@
"format": "int32",
"type": "integer"
}
- },
- "id": "OperationMetadata"
+ }
},
"PublishedService": {
+ "id": "PublishedService",
"description": "The published version of a Service that is managed by\nGoogle Service Management.",
"type": "object",
"properties": {
- "service": {
- "description": "The service's published configuration.",
- "$ref": "Service"
- },
"name": {
"description": "The resource name of the service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com",
"type": "string"
+ },
+ "service": {
+ "description": "The service's published configuration.",
+ "$ref": "Service"
}
- },
- "id": "PublishedService"
+ }
},
"SystemParameterRule": {
"id": "SystemParameterRule",
@@ -675,9 +325,14 @@
}
},
"HttpRule": {
+ "id": "HttpRule",
"description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.",
"type": "object",
"properties": {
+ "put": {
+ "description": "Used for updating a resource.",
+ "type": "string"
+ },
"delete": {
"description": "Used for deleting a resource.",
"type": "string"
@@ -706,8 +361,8 @@
"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"
+ "$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."
},
"custom": {
"$ref": "CustomHttpPattern",
@@ -720,15 +375,11 @@
"patch": {
"description": "Used for updating a resource.",
"type": "string"
- },
- "put": {
- "description": "Used for updating a resource.",
- "type": "string"
}
- },
- "id": "HttpRule"
+ }
},
"MonitoringDestination": {
+ "id": "MonitoringDestination",
"description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
"type": "object",
"properties": {
@@ -743,8 +394,7 @@
"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.",
@@ -831,16 +481,16 @@
"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"
}
+ },
+ "monitoredResource": {
+ "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.",
+ "type": "string"
}
}
},
@@ -885,18 +535,10 @@
"id": "Logging"
},
"QuotaLimit": {
+ "id": "QuotaLimit",
"description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
"type": "object",
"properties": {
- "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"
@@ -934,12 +576,19 @@
},
"description": "Tiered limit values. You must specify this as a key:value pair, with an\ninteger value that is the maximum number of requests allowed for the\nspecified unit. Currently only STANDARD is supported.",
"type": "object"
+ },
+ "unit": {
+ "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.",
+ "type": "string"
+ },
+ "maxLimit": {
+ "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
+ "format": "int64",
+ "type": "string"
}
- },
- "id": "QuotaLimit"
+ }
},
"Method": {
- "id": "Method",
"description": "Method represents a method of an API interface.",
"type": "object",
"properties": {
@@ -960,6 +609,8 @@
"type": "boolean"
},
"syntax": {
+ "description": "The source syntax of this method.",
+ "type": "string",
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`."
@@ -967,9 +618,7 @@
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
- ],
- "description": "The source syntax of this method.",
- "type": "string"
+ ]
},
"responseTypeUrl": {
"description": "The URL of the output message type.",
@@ -982,7 +631,8 @@
"$ref": "Option"
}
}
- }
+ },
+ "id": "Method"
},
"Mixin": {
"description": "Declares an API Interface to be included in this interface. The including\ninterface must redeclare all the methods from the included interface, but\ndocumentation and options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including interface plus the root path if\n specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }",
@@ -1003,42 +653,43 @@
"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"
}
+ },
+ "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": {
+ "id": "Http",
"description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
"type": "object",
"properties": {
- "fullyDecodeReservedExpansion": {
- "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
- "type": "boolean"
- },
"rules": {
"description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"type": "array",
"items": {
"$ref": "HttpRule"
}
+ },
+ "fullyDecodeReservedExpansion": {
+ "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
+ "type": "boolean"
}
- },
- "id": "Http"
+ }
},
"SourceInfo": {
+ "id": "SourceInfo",
"description": "Source information used to create a Service Config",
"type": "object",
"properties": {
@@ -1053,10 +704,10 @@
"type": "object"
}
}
- },
- "id": "SourceInfo"
+ }
},
"Control": {
+ "id": "Control",
"description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
"type": "object",
"properties": {
@@ -1064,8 +715,7 @@
"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.",
@@ -1087,23 +737,22 @@
"id": "SystemParameter"
},
"Field": {
+ "id": "Field",
"description": "A single field of a message type.",
"type": "object",
"properties": {
- "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"
},
+ "jsonName": {
+ "description": "The field JSON name.",
+ "type": "string"
+ },
"kind": {
+ "description": "The field type.",
+ "type": "string",
"enumDescriptions": [
"Field type unknown.",
"Field type double.",
@@ -1145,13 +794,7 @@
"TYPE_SFIXED64",
"TYPE_SINT32",
"TYPE_SINT64"
- ],
- "description": "The field type.",
- "type": "string"
- },
- "jsonName": {
- "description": "The field JSON name.",
- "type": "string"
+ ]
},
"options": {
"description": "The protocol buffer options.",
@@ -1165,10 +808,6 @@
"format": "int32",
"type": "integer"
},
- "packed": {
- "description": "Whether to use alternative packed wire representation.",
- "type": "boolean"
- },
"cardinality": {
"description": "The field cardinality.",
"type": "string",
@@ -1185,12 +824,23 @@
"CARDINALITY_REPEATED"
]
},
+ "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"
}
- },
- "id": "Field"
+ }
},
"Monitoring": {
"id": "Monitoring",
@@ -1214,7 +864,6 @@
}
},
"Enum": {
- "id": "Enum",
"description": "Enum type definition.",
"type": "object",
"properties": {
@@ -1237,12 +886,10 @@
}
},
"sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
+ "description": "The source context.",
+ "$ref": "SourceContext"
},
"syntax": {
- "description": "The source syntax.",
- "type": "string",
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`."
@@ -1250,9 +897,12 @@
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
- ]
+ ],
+ "description": "The source syntax.",
+ "type": "string"
}
- }
+ },
+ "id": "Enum"
},
"LabelDescriptor": {
"id": "LabelDescriptor",
@@ -1284,15 +934,29 @@
}
},
"EnableServiceRequest": {
- "id": "EnableServiceRequest",
"description": "Request message for EnableService method.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "EnableServiceRequest"
},
"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"
@@ -1317,22 +981,8 @@
"type": "string"
},
"sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
- "options": {
- "description": "The protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "fields": {
- "description": "The list of fields.",
- "type": "array",
- "items": {
- "$ref": "Field"
- }
+ "description": "The source context.",
+ "$ref": "SourceContext"
}
},
"id": "Type"
@@ -1349,7 +999,6 @@
"id": "Experimental"
},
"Backend": {
- "id": "Backend",
"description": "`Backend` defines the backend configuration for a service.",
"type": "object",
"properties": {
@@ -1360,10 +1009,10 @@
"$ref": "BackendRule"
}
}
- }
+ },
+ "id": "Backend"
},
"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": {
@@ -1371,7 +1020,8 @@
"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.",
@@ -1393,9 +1043,17 @@
"id": "DocumentationRule"
},
"ContextRule": {
+ "id": "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"
@@ -1406,16 +1064,8 @@
"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.",
@@ -1429,9 +1079,51 @@
"id": "SourceContext"
},
"MetricDescriptor": {
+ "id": "MetricDescriptor",
"description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
"type": "object",
"properties": {
+ "unit": {
+ "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
+ },
+ "name": {
+ "description": "The resource name of the metric descriptor.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The metric type, including its DNS name prefix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"",
+ "type": "string"
+ },
+ "valueType": {
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
+ "The value is a `Distribution`.",
+ "The value is money."
+ ],
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ],
+ "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
+ "type": "string"
+ },
"metricKind": {
"enumDescriptions": [
"Do not use this default value.",
@@ -1455,50 +1147,8 @@
"description": {
"description": "A detailed description of the metric, which can be used in documentation.",
"type": "string"
- },
- "unit": {
- "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
- "type": "string"
- },
- "labels": {
- "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
- "name": {
- "description": "The resource name of the metric descriptor.",
- "type": "string"
- },
- "type": {
- "description": "The metric type, including its DNS name prefix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"",
- "type": "string"
- },
- "valueType": {
- "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
- "The value is a `Distribution`.",
- "The value is money."
- ],
- "enum": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "MONEY"
- ]
}
- },
- "id": "MetricDescriptor"
+ }
},
"Billing": {
"id": "Billing",
@@ -1515,6 +1165,7 @@
}
},
"ListEnabledServicesResponse": {
+ "id": "ListEnabledServicesResponse",
"description": "Response message for `ListEnabledServices` method.",
"type": "object",
"properties": {
@@ -1529,8 +1180,7 @@
"description": "Token that can be passed to `ListEnabledServices` to resume a paginated\nquery.",
"type": "string"
}
- },
- "id": "ListEnabledServicesResponse"
+ }
},
"Endpoint": {
"description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
@@ -1577,9 +1227,14 @@
"id": "OAuthRequirements"
},
"Usage": {
+ "id": "Usage",
"description": "Configuration controlling usage of a service.",
"type": "object",
"properties": {
+ "producerNotificationChannel": {
+ "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
+ "type": "string"
+ },
"rules": {
"description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"type": "array",
@@ -1593,13 +1248,8 @@
"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"
}
- },
- "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`.",
@@ -1616,16 +1266,10 @@
"id": "Context"
},
"LogDescriptor": {
+ "id": "LogDescriptor",
"description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
"type": "object",
"properties": {
- "labels": {
- "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
"name": {
"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"
@@ -1637,11 +1281,18 @@
"displayName": {
"description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
"type": "string"
+ },
+ "labels": {
+ "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
}
- },
- "id": "LogDescriptor"
+ }
},
"CustomErrorRule": {
+ "id": "CustomErrorRule",
"description": "A custom error rule.",
"type": "object",
"properties": {
@@ -1653,8 +1304,7 @@
"description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
"type": "boolean"
}
- },
- "id": "CustomErrorRule"
+ }
},
"MonitoredResourceDescriptor": {
"id": "MonitoredResourceDescriptor",
@@ -1687,13 +1337,10 @@
}
},
"MediaDownload": {
+ "id": "MediaDownload",
"description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
"type": "object",
"properties": {
- "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"
@@ -1706,17 +1353,20 @@
"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"
+ },
+ "useDirectDownload": {
+ "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
+ "type": "boolean"
}
- },
- "id": "MediaDownload"
+ }
},
"CustomAuthRequirements": {
"description": "Configuration for a custom authentication provider.",
@@ -1730,29 +1380,379 @@
"id": "CustomAuthRequirements"
},
"DisableServiceRequest": {
- "id": "DisableServiceRequest",
"description": "Request message for DisableService method.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "DisableServiceRequest"
+ },
+ "SearchServicesResponse": {
+ "description": "Response message for SearchServices method.",
+ "type": "object",
+ "properties": {
+ "services": {
+ "description": "Services available publicly or available to the authenticated caller.",
+ "type": "array",
+ "items": {
+ "$ref": "PublishedService"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery.",
+ "type": "string"
+ }
+ },
+ "id": "SearchServicesResponse"
+ },
+ "MediaUpload": {
+ "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
+ "type": "object",
+ "properties": {
+ "startNotification": {
+ "description": "Whether to receive a notification on the start of media upload.",
+ "type": "boolean"
+ },
+ "uploadService": {
+ "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
+ "type": "string"
+ },
+ "mimeTypes": {
+ "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "maxSize": {
+ "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
+ "format": "int64",
+ "type": "string"
+ },
+ "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"
+ },
+ "BillingDestination": {
+ "id": "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"
+ }
+ }
+ }
+ },
+ "UsageRule": {
+ "id": "UsageRule",
+ "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
+ "type": "object",
+ "properties": {
+ "selector": {
+ "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "skipServiceControl": {
+ "description": "If true, the selected method should skip service control and the control\nplane features, such as quota and billing, will not be available.\nThis flag is used by Google Cloud Endpoints to bypass checks for internal\nmethods, such as service health check methods.",
+ "type": "boolean"
+ },
+ "allowUnregisteredCalls": {
+ "description": "If true, the selected method allows unregistered calls, e.g. calls\nthat don't identify any user or application.",
+ "type": "boolean"
+ }
+ }
+ },
+ "AuthRequirement": {
+ "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
+ "type": "object",
+ "properties": {
+ "providerId": {
+ "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
+ "type": "string"
+ },
+ "audiences": {
+ "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
+ "type": "string"
+ }
+ },
+ "id": "AuthRequirement"
+ },
+ "Documentation": {
+ "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
+ "type": "object",
+ "properties": {
+ "summary": {
+ "description": "A short summary of what the service does. Can only be provided by\nplain text.",
+ "type": "string"
+ },
+ "documentationRootUrl": {
+ "description": "The URL to the root of documentation.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "DocumentationRule"
+ }
+ },
+ "overview": {
+ "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.",
+ "type": "string"
+ },
+ "pages": {
+ "description": "The top level pages for the documentation set.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ }
+ },
+ "id": "Documentation"
+ },
+ "AuthenticationRule": {
+ "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
+ "type": "object",
+ "properties": {
+ "requirements": {
+ "description": "Requirements for additional authentication providers.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthRequirement"
+ }
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "allowWithoutCredential": {
+ "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
+ "type": "boolean"
+ },
+ "oauth": {
+ "$ref": "OAuthRequirements",
+ "description": "The requirements for OAuth credentials."
+ },
+ "customAuth": {
+ "description": "Configuration for custom authentication.",
+ "$ref": "CustomAuthRequirements"
+ }
+ },
+ "id": "AuthenticationRule"
+ },
+ "BackendRule": {
+ "description": "A backend rule provides configuration for an individual API element.",
+ "type": "object",
+ "properties": {
+ "minDeadline": {
+ "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
+ "format": "double",
+ "type": "number"
+ },
+ "address": {
+ "description": "The address of the API backend.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "deadline": {
+ "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "BackendRule"
+ },
+ "Api": {
+ "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.",
+ "type": "string"
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of the service.",
+ "type": "string"
+ },
+ "sourceContext": {
+ "description": "Source context for the protocol buffer service represented by this\nmessage.",
+ "$ref": "SourceContext"
+ },
+ "version": {
+ "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n",
+ "type": "string"
+ },
+ "mixins": {
+ "description": "Included interfaces. See Mixin.",
+ "type": "array",
+ "items": {
+ "$ref": "Mixin"
+ }
+ },
+ "options": {
+ "description": "Any metadata attached to the interface.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ },
+ "methods": {
+ "description": "The methods of this interface, in unspecified order.",
+ "type": "array",
+ "items": {
+ "$ref": "Method"
+ }
+ }
+ },
+ "id": "Api"
+ },
+ "MetricRule": {
+ "id": "MetricRule",
+ "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.",
+ "type": "object",
+ "properties": {
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "metricCosts": {
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the map is the metric name, and the values are the amount\nincreased for the metric against which the quota limits are defined.\nThe value must not be negative.",
+ "type": "object"
+ }
+ }
+ },
+ "Authentication": {
+ "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthenticationRule"
+ }
+ },
+ "providers": {
+ "description": "Defines a set of authentication providers that a service supports.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthProvider"
+ }
+ }
+ },
+ "id": "Authentication"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "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"
+ },
+ "Page": {
+ "id": "Page",
+ "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
+ "type": "object",
+ "properties": {
+ "subpages": {
+ "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ },
+ "name": {
+ "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
+ "type": "string"
+ },
+ "content": {
+ "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.",
+ "type": "string"
+ }
+ }
}
},
+ "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": "Service User",
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/service.management": {
+ "description": "Manage your Google API service configuration"
+ },
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/service.management": {
- "description": "Manage your Google API service configuration"
}
}
}
@@ -1768,6 +1768,35 @@
"resources": {
"services": {
"methods": {
+ "disable": {
+ "id": "serviceuser.projects.services.disable",
+ "path": "v1/{+name}:disable",
+ "description": "Disable a service so it can no longer be used with a\nproject. This prevents unintended usage that may cause unexpected billing\ncharges or security leaks.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
+ "request": {
+ "$ref": "DisableServiceRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/services/[^/]+$",
+ "location": "path",
+ "description": "Name of the consumer and the service to disable for that consumer.\n\nThe Service User implementation accepts the following forms for consumer:\n- \"project:\u003cproject_id\u003e\"\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:disable",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable"
+ },
"enable": {
"httpMethod": "POST",
"parameterOrder": [
@@ -1813,55 +1842,26 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "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"
+ },
"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"
- },
- "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"
+ "type": "integer",
+ "location": "query"
}
},
"flatPath": "v1/projects/{projectsId}/services"
- },
- "disable": {
- "description": "Disable a service so it can no longer be used with a\nproject. This prevents unintended usage that may cause unexpected billing\ncharges or security leaks.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
- "request": {
- "$ref": "DisableServiceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "name": {
- "description": "Name of the consumer and the service to disable for that consumer.\n\nThe Service User implementation accepts the following forms for consumer:\n- \"project:\u003cproject_id\u003e\"\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:disable",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/services/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable",
- "path": "v1/{+name}:disable",
- "id": "serviceuser.projects.services.disable"
}
}
}
@@ -1870,20 +1870,15 @@
"services": {
"methods": {
"search": {
- "response": {
- "$ref": "SearchServicesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
"pageToken": {
- "location": "query",
"description": "Token identifying which result to start with; returned by a previous list\ncall.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -1895,55 +1890,26 @@
"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."
+ "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": {
- "$.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": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"quotaUser": {
"location": "query",
@@ -1951,25 +1917,25 @@
"type": "string"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
@@ -1986,12 +1952,46 @@
"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": {
+ "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://serviceuser.googleapis.com/",
+ "servicePath": "",
"kind": "discovery#restDescription",
"description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.",
- "servicePath": "",
"basePath": ""
}
diff --git a/sheets/v4/sheets-api.json b/sheets/v4/sheets-api.json
index 362d136..8fc6a02 100644
--- a/sheets/v4/sheets-api.json
+++ b/sheets/v4/sheets-api.json
@@ -1,4341 +1,13 @@
{
- "baseUrl": "https://sheets.googleapis.com/",
- "servicePath": "",
- "description": "Reads and writes Google Sheets.",
- "kind": "discovery#restDescription",
"basePath": "",
- "id": "sheets:v4",
- "documentationLink": "https://developers.google.com/sheets/",
"revision": "20180118",
+ "documentationLink": "https://developers.google.com/sheets/",
+ "id": "sheets:v4",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "BatchGetValuesByDataFilterRequest": {
- "description": "The request for retrieving a range of values in a spreadsheet selected by a\nset of DataFilters.",
- "type": "object",
- "properties": {
- "majorDimension": {
- "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen a request that selects that range and sets `majorDimension=ROWS` will\nreturn `[[1,2],[3,4]]`,\nwhereas a request that sets `majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ]
- },
- "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": {
- "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": "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"
- }
- },
- "id": "BatchGetValuesByDataFilterRequest"
- },
- "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"
- },
- "BatchUpdateValuesResponse": {
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "totalUpdatedSheets": {
- "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "totalUpdatedCells": {
- "description": "The total number of cells updated.",
- "format": "int32",
- "type": "integer"
- },
- "totalUpdatedColumns": {
- "description": "The total number of columns where at least one cell in the column was\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "totalUpdatedRows": {
- "description": "The total number of rows where at least one cell in the row was updated.",
- "format": "int32",
- "type": "integer"
- },
- "responses": {
- "description": "One UpdateValuesResponse per requested range, in the same order as\nthe requests appeared.",
- "type": "array",
- "items": {
- "$ref": "UpdateValuesResponse"
- }
- }
- },
- "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": {
- "description": "A developer metadata entry and the data filters specified in the original\nrequest that matched it.",
- "type": "object",
- "properties": {
- "dataFilters": {
- "description": "All filters matching the returned developer metadata.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- },
- "developerMetadata": {
- "description": "The developer metadata matching the specified filters.",
- "$ref": "DeveloperMetadata"
- }
- },
- "id": "MatchedDeveloperMetadata"
- },
- "MergeCellsRequest": {
- "description": "Merges all cells in the range.",
- "type": "object",
- "properties": {
- "mergeType": {
- "enumDescriptions": [
- "Create a single merge from the range",
- "Create a merge for each column in the range",
- "Create a merge for each row in the range"
- ],
- "enum": [
- "MERGE_ALL",
- "MERGE_COLUMNS",
- "MERGE_ROWS"
- ],
- "description": "How the cells should be merged.",
- "type": "string"
- },
- "range": {
- "description": "The range of cells to merge.",
- "$ref": "GridRange"
- }
- },
- "id": "MergeCellsRequest"
- },
- "AddProtectedRangeRequest": {
- "description": "Adds a new protected range.",
- "type": "object",
- "properties": {
- "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.)",
- "$ref": "ProtectedRange"
- }
- },
- "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"
- },
- "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": {
- "description": "The location where the metadata is associated.",
- "$ref": "DeveloperMetadataLocation"
- },
- "visibility": {
- "enumDescriptions": [
- "Default value.",
- "Document-visible metadata is accessible from any developer project with\naccess to the document.",
- "Project-visible metadata is only visible to and accessible by the developer\nproject that created the metadata."
- ],
- "enum": [
- "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
- "DOCUMENT",
- "PROJECT"
- ],
- "description": "The metadata visibility. Developer metadata must always have a visibility\nspecified.",
- "type": "string"
- },
- "metadataValue": {
- "description": "Data associated with the metadata's key.",
- "type": "string"
- }
- },
- "id": "DeveloperMetadata"
- },
- "DuplicateFilterViewResponse": {
- "description": "The result of a filter view being duplicated.",
- "type": "object",
- "properties": {
- "filter": {
- "$ref": "FilterView",
- "description": "The newly created filter."
- }
- },
- "id": "DuplicateFilterViewResponse"
- },
- "DuplicateSheetResponse": {
- "description": "The result of duplicating a sheet.",
- "type": "object",
- "properties": {
- "properties": {
- "description": "The properties of the duplicate sheet.",
- "$ref": "SheetProperties"
- }
- },
- "id": "DuplicateSheetResponse"
- },
- "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": {
- "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": {
- "description": "The delimiter type to use.",
- "type": "string",
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "\",\"",
- "\";\"",
- "\".\"",
- "\" \"",
- "A custom value as defined in delimiter.",
- "Automatically detect columns."
- ],
- "enum": [
- "DELIMITER_TYPE_UNSPECIFIED",
- "COMMA",
- "SEMICOLON",
- "PERIOD",
- "SPACE",
- "CUSTOM",
- "AUTODETECT"
- ]
- }
- },
- "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": {
- "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": {
- "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`.",
- "$ref": "Spreadsheet"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- }
- },
- "id": "BatchUpdateSpreadsheetResponse"
- },
- "AppendValuesResponse": {
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "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"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- }
- },
- "id": "AppendValuesResponse"
- },
- "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"
- },
- "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"
- },
- "MoveDimensionRequest": {
- "description": "Moves one or more rows or columns.",
- "type": "object",
- "properties": {
- "destinationIndex": {
- "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1..3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5).\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.",
- "format": "int32",
- "type": "integer"
- },
- "source": {
- "description": "The source dimensions to move.",
- "$ref": "DimensionRange"
- }
- },
- "id": "MoveDimensionRequest"
- },
- "AddConditionalFormatRuleRequest": {
- "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented.",
- "type": "object",
- "properties": {
- "rule": {
- "description": "The rule to add.",
- "$ref": "ConditionalFormatRule"
- },
- "index": {
- "description": "The zero-based index where the rule should be inserted.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AddConditionalFormatRuleRequest"
- },
- "ChartSpec": {
- "description": "The specifications of a chart.",
- "type": "object",
- "properties": {
- "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": {
- "$ref": "TextFormat",
- "description": "The subtitle text format.\nStrikethrough and underline are not supported."
- },
- "subtitle": {
- "description": "The subtitle of the chart.",
- "type": "string"
- },
- "subtitleTextPosition": {
- "$ref": "TextPosition",
- "description": "The subtitle text position.\nThis field is optional."
- },
- "backgroundColor": {
- "$ref": "Color",
- "description": "The background color of the entire chart.\nNot applicable to Org charts."
- },
- "basicChart": {
- "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports.",
- "$ref": "BasicChartSpec"
- },
- "orgChart": {
- "$ref": "OrgChartSpec",
- "description": "An org chart specification."
- },
- "pieChart": {
- "description": "A pie chart specification.",
- "$ref": "PieChartSpec"
- },
- "titleTextFormat": {
- "$ref": "TextFormat",
- "description": "The title text format.\nStrikethrough and underline are not supported."
- },
- "title": {
- "description": "The title of the chart.",
- "type": "string"
- },
- "altText": {
- "description": "The alternative text that describes the chart. This is often used\nfor accessibility.",
- "type": "string"
- },
- "titleTextPosition": {
- "description": "The title text position.\nThis field is optional.",
- "$ref": "TextPosition"
- },
- "histogramChart": {
- "$ref": "HistogramChartSpec",
- "description": "A histogram chart specification."
- },
- "candlestickChart": {
- "$ref": "CandlestickChartSpec",
- "description": "A candlestick chart specification."
- },
- "bubbleChart": {
- "$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"
- }
- },
- "id": "ChartSpec"
- },
- "CreateDeveloperMetadataRequest": {
- "description": "A request to create developer metadata.",
- "type": "object",
- "properties": {
- "developerMetadata": {
- "description": "The developer metadata to create.",
- "$ref": "DeveloperMetadata"
- }
- },
- "id": "CreateDeveloperMetadataRequest"
- },
- "BatchGetValuesByDataFilterResponse": {
- "description": "The response when retrieving more than one range of values in a spreadsheet\nselected by DataFilters.",
- "type": "object",
- "properties": {
- "valueRanges": {
- "description": "The requested values with the list of data filters that matched them.",
- "type": "array",
- "items": {
- "$ref": "MatchedValueRange"
- }
- },
- "spreadsheetId": {
- "description": "The ID of the spreadsheet the data was retrieved from.",
- "type": "string"
- }
- },
- "id": "BatchGetValuesByDataFilterResponse"
- },
- "LineStyle": {
- "description": "Properties that describe the style of a line.",
- "type": "object",
- "properties": {
- "type": {
- "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"
- ],
- "description": "The dash type of the line.",
- "type": "string"
- },
- "width": {
- "description": "The thickness of the line, in px.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "LineStyle"
- },
- "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": {
- "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": {
- "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"
- },
- "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"
- },
- "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": {
- "description": "Properties of a sheet.",
- "type": "object",
- "properties": {
- "title": {
- "description": "The name of the sheet.",
- "type": "string"
- },
- "tabColor": {
- "description": "The color of the tab in the UI.",
- "$ref": "Color"
- },
- "index": {
- "description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet will be added or moved to the end\nof the sheet list. When updating sheet indices or inserting\nsheets, movement is considered in \"before the move\" indexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ahead of S2 the index would have to be set to 2. A sheet\nindex update request will be ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "description": "The ID of the sheet. Must be non-negative.\nThis field cannot be changed once set.",
- "format": "int32",
- "type": "integer"
- },
- "rightToLeft": {
- "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
- "type": "boolean"
- },
- "hidden": {
- "description": "True if the sheet is hidden in the UI, false if it's visible.",
- "type": "boolean"
- },
- "gridProperties": {
- "$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": {
- "enumDescriptions": [
- "Default value, do not use.",
- "The sheet is a grid.",
- "The sheet has no grid and instead has an object like a chart or image."
- ],
- "enum": [
- "SHEET_TYPE_UNSPECIFIED",
- "GRID",
- "OBJECT"
- ],
- "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.",
- "type": "string"
- }
- },
- "id": "SheetProperties"
- },
- "UpdateDimensionPropertiesRequest": {
- "description": "Updates properties of dimensions within the specified range.",
- "type": "object",
- "properties": {
- "properties": {
- "$ref": "DimensionProperties",
- "description": "Properties to update."
- },
- "range": {
- "$ref": "DimensionRange",
- "description": "The rows or columns to update."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateDimensionPropertiesRequest"
- },
- "SourceAndDestination": {
- "description": "A combination of a source range and how to extend that source.",
- "type": "object",
- "properties": {
- "source": {
- "description": "The location of the data to use as the source of the autofill.",
- "$ref": "GridRange"
- },
- "dimension": {
- "description": "The dimension that data should be filled into.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ]
- },
- "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": {
- "filterViewId": {
- "description": "The ID of the filter view.",
- "format": "int32",
- "type": "integer"
- },
- "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"
- }
- },
- "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"
- }
- },
- "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": {
- "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."
- },
- "parentLabels": {
- "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional.",
- "$ref": "ChartData"
- },
- "nodeSize": {
- "enumDescriptions": [
- "Default value, do not use.",
- "The small org chart node size.",
- "The medium org chart node size.",
- "The large org chart node size."
- ],
- "enum": [
- "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
- "SMALL",
- "MEDIUM",
- "LARGE"
- ],
- "description": "The size of the org chart nodes.",
- "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"
- },
- "SearchDeveloperMetadataRequest": {
- "description": "A request to retrieve all developer metadata matching the set of specified\ncriteria.",
- "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"
- }
- }
- },
- "id": "SearchDeveloperMetadataRequest"
- },
- "BandingProperties": {
- "description": "Properties referring a single dimension (either row or column). If both\nBandedRange.row_properties and BandedRange.column_properties are\nset, the fill colors are applied to cells according to the following rules:\n\n* header_color and footer_color take priority over band colors.\n* first_band_color takes priority over second_band_color.\n* row_properties takes priority over column_properties.\n\nFor example, the first row color takes priority over the first column\ncolor, but the first column color takes priority over the second row color.\nSimilarly, the row header takes priority over the column header in the\ntop left cell, but the column header takes priority over the first row\ncolor if the row header is not set.",
- "type": "object",
- "properties": {
- "firstBandColor": {
- "description": "The first color that is alternating. (Required)",
- "$ref": "Color"
- },
- "secondBandColor": {
- "description": "The second color that is alternating. (Required)",
- "$ref": "Color"
- },
- "footerColor": {
- "$ref": "Color",
- "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn."
- },
- "headerColor": {
- "description": "The color of the first row or column. If this field is set, the first\nrow or column will be filled with this color and the colors will\nalternate between first_band_color and second_band_color starting\nfrom the second row or column. Otherwise, the first row or column will be\nfilled with first_band_color and the colors will proceed to alternate\nas they normally would.",
- "$ref": "Color"
- }
- },
- "id": "BandingProperties"
- },
- "CandlestickSeries": {
- "description": "The series of a CandlestickData.",
- "type": "object",
- "properties": {
- "data": {
- "$ref": "ChartData",
- "description": "The data of the CandlestickSeries."
- }
- },
- "id": "CandlestickSeries"
- },
- "BasicFilter": {
- "description": "The default filter associated with a sheet.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The range the filter covers.",
- "$ref": "GridRange"
- },
- "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"
- },
- "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": "BasicFilter"
- },
- "AddProtectedRangeResponse": {
- "description": "The result of adding a new protected range.",
- "type": "object",
- "properties": {
- "protectedRange": {
- "description": "The newly added protected range.",
- "$ref": "ProtectedRange"
- }
- },
- "id": "AddProtectedRangeResponse"
- },
- "HistogramChartSpec": {
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/histogram\"\u003ehistogram chart\u003c/a\u003e.\nA histogram chart groups data items into bins, displaying each bin as a\ncolumn of stacked items. Histograms are used to display the distribution\nof a dataset. Each column of items represents a range into which those\nitems fall. The number of bins can be chosen automatically or specified\nexplicitly.",
- "type": "object",
- "properties": {
- "bucketSize": {
- "description": "By default the bucket size (the range of values stacked in a single\ncolumn) is chosen automatically, but it may be overridden here.\nE.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.\nCannot be negative.\nThis field is optional.",
- "format": "double",
- "type": "number"
- },
- "outlierPercentile": {
- "description": "The outlier percentile is used to ensure that outliers do not adversely\naffect the calculation of bucket sizes. For example, setting an outlier\npercentile of 0.05 indicates that the top and bottom 5% of values when\ncalculating buckets. The values are still included in the chart, they will\nbe added to the first or last buckets instead of their own buckets.\nMust be between 0.0 and 0.5.",
- "format": "double",
- "type": "number"
- },
- "showItemDividers": {
- "description": "Whether horizontal divider lines should be displayed between items in each\ncolumn.",
- "type": "boolean"
- },
- "series": {
- "description": "The series for a histogram may be either a single series of values to be\nbucketed or multiple series, each of the same length, containing the name\nof the series followed by the values to be bucketed for that series.",
- "type": "array",
- "items": {
- "$ref": "HistogramSeries"
- }
- },
- "legendPosition": {
- "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": [
- "HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND",
- "INSIDE_LEGEND"
- ],
- "description": "The position of the chart legend.",
- "type": "string"
- }
- },
- "id": "HistogramChartSpec"
- },
- "UpdateValuesResponse": {
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "updatedColumns": {
- "description": "The number of columns where at least one cell in the column was updated.",
- "format": "int32",
- "type": "integer"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "updatedRange": {
- "description": "The range (in A1 notation) that updates were applied to.",
- "type": "string"
- },
- "updatedCells": {
- "description": "The number of cells updated.",
- "format": "int32",
- "type": "integer"
- },
- "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 after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`.",
- "$ref": "ValueRange"
- }
- },
- "id": "UpdateValuesResponse"
- },
- "ErrorValue": {
- "description": "An error in a cell.",
- "type": "object",
- "properties": {
- "type": {
- "description": "The type of error.",
- "type": "string",
- "enumDescriptions": [
- "The default error type, do not use this.",
- "Corresponds to the `#ERROR!` error.",
- "Corresponds to the `#NULL!` error.",
- "Corresponds to the `#DIV/0` error.",
- "Corresponds to the `#VALUE!` error.",
- "Corresponds to the `#REF!` error.",
- "Corresponds to the `#NAME?` error.",
- "Corresponds to the `#NUM`! error.",
- "Corresponds to the `#N/A` error.",
- "Corresponds to the `Loading...` state."
- ],
- "enum": [
- "ERROR_TYPE_UNSPECIFIED",
- "ERROR",
- "NULL_VALUE",
- "DIVIDE_BY_ZERO",
- "VALUE",
- "REF",
- "NAME",
- "NUM",
- "N_A",
- "LOADING"
- ]
- },
- "message": {
- "description": "A message with more information about the error\n(in the spreadsheet's locale).",
- "type": "string"
- }
- },
- "id": "ErrorValue"
- },
- "PivotValue": {
- "description": "The definition of how a value in a pivot table should be calculated.",
- "type": "object",
- "properties": {
- "summarizeFunction": {
- "enumDescriptions": [
- "The default, do not use.",
- "Corresponds to the `SUM` function.",
- "Corresponds to the `COUNTA` function.",
- "Corresponds to the `COUNT` function.",
- "Corresponds to the `COUNTUNIQUE` function.",
- "Corresponds to the `AVERAGE` function.",
- "Corresponds to the `MAX` function.",
- "Corresponds to the `MIN` function.",
- "Corresponds to the `MEDIAN` function.",
- "Corresponds to the `PRODUCT` function.",
- "Corresponds to the `STDEV` function.",
- "Corresponds to the `STDEVP` function.",
- "Corresponds to the `VAR` function.",
- "Corresponds to the `VARP` function.",
- "Indicates the formula should be used as-is.\nOnly valid if PivotValue.formula was set."
- ],
- "enum": [
- "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED",
- "SUM",
- "COUNTA",
- "COUNT",
- "COUNTUNIQUE",
- "AVERAGE",
- "MAX",
- "MIN",
- "MEDIAN",
- "PRODUCT",
- "STDEV",
- "STDEVP",
- "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"
- },
- "formula": {
- "description": "A custom formula to calculate the value. The formula must start\nwith an `=` character.",
- "type": "string"
- }
- },
- "id": "PivotValue"
- },
- "CopySheetToAnotherSpreadsheetRequest": {
- "description": "The request to copy a sheet across spreadsheets.",
- "type": "object",
- "properties": {
- "destinationSpreadsheetId": {
- "description": "The ID of the spreadsheet to copy the sheet to.",
- "type": "string"
- }
- },
- "id": "CopySheetToAnotherSpreadsheetRequest"
- },
- "PivotGroupSortValueBucket": {
- "description": "Information about which values in a pivot group should be used for sorting.",
- "type": "object",
- "properties": {
- "valuesIndex": {
- "description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.",
- "format": "int32",
- "type": "integer"
- },
- "buckets": {
- "description": "Determines the bucket from which values are chosen to sort.\n\nFor example, in a pivot table with one row group & two column groups,\nthe row group can list up to two values. The first value corresponds\nto a value within the first column group, and the second value\ncorresponds to a value in the second column group. If no values\nare listed, this would indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.",
- "type": "array",
- "items": {
- "$ref": "ExtendedValue"
- }
- }
- },
- "id": "PivotGroupSortValueBucket"
- },
- "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."
- },
- "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."
- },
- "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"
- },
- "customSubtotals": {
- "description": "Custom subtotal columns appearing in this series. The order in which\nsubtotals are defined is not significant. Only one subtotal may be\ndefined for each data point.",
- "type": "array",
- "items": {
- "$ref": "WaterfallChartCustomSubtotal"
- }
- },
- "subtotalColumnsStyle": {
- "description": "Styles for all subtotal columns in this series.",
- "$ref": "WaterfallChartColumnStyle"
- }
- },
- "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"
- },
- "CandlestickChartSpec": {
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/candlestickchart\"\u003ecandlestick chart\u003c/a\u003e.",
- "type": "object",
- "properties": {
- "domain": {
- "$ref": "CandlestickDomain",
- "description": "The domain data (horizontal axis) for the candlestick chart. String data\nwill be treated as discrete labels, other data will be treated as\ncontinuous values."
- },
- "data": {
- "description": "The Candlestick chart data.\nOnly one CandlestickData is supported.",
- "type": "array",
- "items": {
- "$ref": "CandlestickData"
- }
- }
- },
- "id": "CandlestickChartSpec"
- },
- "BatchClearValuesByDataFilterResponse": {
- "description": "The response when clearing a range of values selected with\nDataFilters in a spreadsheet.",
- "type": "object",
- "properties": {
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "clearedRanges": {
- "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "BatchClearValuesByDataFilterResponse"
- },
- "CandlestickData": {
- "description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.",
- "type": "object",
- "properties": {
- "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": {
- "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."
- }
- },
- "id": "CandlestickData"
- },
- "EmbeddedObjectPosition": {
- "description": "The position of an embedded object such as a chart.",
- "type": "object",
- "properties": {
- "newSheet": {
- "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.",
- "type": "boolean"
- },
- "sheetId": {
- "description": "The sheet this is on. Set only if the embedded object\nis on its own sheet. Must be non-negative.",
- "format": "int32",
- "type": "integer"
- },
- "overlayPosition": {
- "$ref": "OverlayPosition",
- "description": "The position at which the object is overlaid on top of a grid."
- }
- },
- "id": "EmbeddedObjectPosition"
- },
- "DeleteProtectedRangeRequest": {
- "description": "Deletes the protected range with the given ID.",
- "type": "object",
- "properties": {
- "protectedRangeId": {
- "description": "The ID of the protected range to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteProtectedRangeRequest"
- },
- "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": {
- "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"
- },
- "metadataKey": {
- "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_key.",
- "type": "string"
- },
- "metadataId": {
- "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_id.",
- "format": "int32",
- "type": "integer"
- },
- "visibility": {
- "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.visibility. If left unspecified, all developer\nmetadata visibile to the requesting project is considered.",
- "type": "string",
- "enumDescriptions": [
- "Default value.",
- "Document-visible metadata is accessible from any developer project with\naccess to the document.",
- "Project-visible metadata is only visible to and accessible by the developer\nproject that created the metadata."
- ],
- "enum": [
- "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
- "DOCUMENT",
- "PROJECT"
- ]
- },
- "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": {
- "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"
- }
- },
- "id": "DeveloperMetadataLookup"
- },
- "AutoFillRequest": {
- "description": "Fills in more data based on existing data.",
- "type": "object",
- "properties": {
- "useAlternateSeries": {
- "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data.",
- "type": "boolean"
- },
- "sourceAndDestination": {
- "$ref": "SourceAndDestination",
- "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data."
- },
- "range": {
- "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range.",
- "$ref": "GridRange"
- }
- },
- "id": "AutoFillRequest"
- },
- "GradientRule": {
- "description": "A rule that applies a gradient color scale format, based on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints.",
- "type": "object",
- "properties": {
- "midpoint": {
- "description": "An optional midway interpolation point.",
- "$ref": "InterpolationPoint"
- },
- "minpoint": {
- "$ref": "InterpolationPoint",
- "description": "The starting interpolation point."
- },
- "maxpoint": {
- "$ref": "InterpolationPoint",
- "description": "The final interpolation point."
- }
- },
- "id": "GradientRule"
- },
- "ClearValuesRequest": {
- "description": "The request for clearing a range of values in a spreadsheet.",
- "type": "object",
- "properties": {},
- "id": "ClearValuesRequest"
- },
- "SetBasicFilterRequest": {
- "description": "Sets the basic filter associated with a sheet.",
- "type": "object",
- "properties": {
- "filter": {
- "$ref": "BasicFilter",
- "description": "The filter to set."
- }
- },
- "id": "SetBasicFilterRequest"
- },
- "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": {
- "type": {
- "description": "How the value should be interpreted.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "The interpolation point will use the minimum value in the\ncells over the range of the conditional format.",
- "The interpolation point will use the maximum value in the\ncells over the range of the conditional format.",
- "The interpolation point will use exactly the value in\nInterpolationPoint.value.",
- "The interpolation point will be the given percentage over\nall the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=(MAX(FLATTEN(range)) * (value / 100))\n + (MIN(FLATTEN(range)) * (1 - (value / 100)))`\n(where errors in the range are ignored when flattening).",
- "The interpolation point will be the given percentile\nover all the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=PERCENTILE(FLATTEN(range), value / 100)`\n(where errors in the range are ignored when flattening)."
- ],
- "enum": [
- "INTERPOLATION_POINT_TYPE_UNSPECIFIED",
- "MIN",
- "MAX",
- "NUMBER",
- "PERCENT",
- "PERCENTILE"
- ]
- },
- "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."
- }
- },
- "id": "InterpolationPoint"
- },
- "BatchClearValuesByDataFilterRequest": {
- "description": "The request for clearing more than one range selected by a\nDataFilter in a spreadsheet.",
- "type": "object",
- "properties": {
- "dataFilters": {
- "description": "The DataFilters used to determine which ranges to clear.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- }
- },
- "id": "BatchClearValuesByDataFilterRequest"
- },
- "GetSpreadsheetByDataFilterRequest": {
- "description": "The request for retrieving a Spreadsheet.",
- "type": "object",
- "properties": {
- "includeGridData": {
- "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
- "type": "boolean"
- },
- "dataFilters": {
- "description": "The DataFilters used to select which ranges to retrieve from\nthe spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- }
- },
- "id": "GetSpreadsheetByDataFilterRequest"
- },
- "DeleteEmbeddedObjectRequest": {
- "description": "Deletes the embedded object with the given ID.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The ID of the embedded object to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteEmbeddedObjectRequest"
- },
- "FindReplaceResponse": {
- "description": "The result of the find/replace.",
- "type": "object",
- "properties": {
- "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": {
- "description": "The number of rows changed.",
- "format": "int32",
- "type": "integer"
- },
- "sheetsChanged": {
- "description": "The number of sheets changed.",
- "format": "int32",
- "type": "integer"
- },
- "formulasChanged": {
- "description": "The number of formula cells changed.",
- "format": "int32",
- "type": "integer"
- },
- "valuesChanged": {
- "description": "The number of non-formula cells changed.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "FindReplaceResponse"
- },
- "UpdateValuesByDataFilterResponse": {
- "description": "The response when updating a range of values by a data filter in a\nspreadsheet.",
- "type": "object",
- "properties": {
- "updatedRange": {
- "description": "The range (in A1 notation) that updates were applied to.",
- "type": "string"
- },
- "updatedCells": {
- "description": "The number of cells updated.",
- "format": "int32",
- "type": "integer"
- },
- "dataFilter": {
- "description": "The data filter that selected the range that was updated.",
- "$ref": "DataFilter"
- },
- "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",
- "type": "integer"
- }
- },
- "id": "UpdateValuesByDataFilterResponse"
- },
- "DeleteSheetRequest": {
- "description": "Deletes the requested sheet.",
- "type": "object",
- "properties": {
- "sheetId": {
- "description": "The ID of the sheet to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteSheetRequest"
- },
- "DuplicateFilterViewRequest": {
- "description": "Duplicates a particular filter view.",
- "type": "object",
- "properties": {
- "filterId": {
- "description": "The ID of the filter being duplicated.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DuplicateFilterViewRequest"
- },
- "MatchedValueRange": {
- "description": "A value range that was matched by one or more data filers.",
- "type": "object",
- "properties": {
- "valueRange": {
- "$ref": "ValueRange",
- "description": "The values matched by the DataFilter."
- },
- "dataFilters": {
- "description": "The DataFilters from the request that matched the range of\nvalues.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- }
- },
- "id": "MatchedValueRange"
- },
- "DeveloperMetadataLocation": {
- "description": "A location where metadata may be associated in a spreadsheet.",
- "type": "object",
- "properties": {
- "dimensionRange": {
- "description": "Represents the row or column when metadata is associated with\na dimension. The specified DimensionRange must represent a single row\nor column; it cannot be unbounded or span multiple rows or columns.",
- "$ref": "DimensionRange"
- },
- "spreadsheet": {
- "description": "True when metadata is associated with an entire spreadsheet.",
- "type": "boolean"
- },
- "sheetId": {
- "description": "The ID of the sheet when metadata is associated with an entire sheet.",
- "format": "int32",
- "type": "integer"
- },
- "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": "The type of location this object represents. This field is read-only.",
- "type": "string"
- }
- },
- "id": "DeveloperMetadataLocation"
- },
- "UpdateConditionalFormatRuleResponse": {
- "description": "The result of updating a conditional format rule.",
- "type": "object",
- "properties": {
- "newIndex": {
- "description": "The index of the new rule.",
- "format": "int32",
- "type": "integer"
- },
- "oldIndex": {
- "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
- "format": "int32",
- "type": "integer"
- },
- "newRule": {
- "$ref": "ConditionalFormatRule",
- "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
- },
- "oldRule": {
- "$ref": "ConditionalFormatRule",
- "description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule)."
- }
- },
- "id": "UpdateConditionalFormatRuleResponse"
- },
- "ConditionValue": {
- "description": "The value of the condition.",
- "type": "object",
- "properties": {
- "relativeDate": {
- "description": "A relative date (based on the current date).\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDATE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey are supported only in conditional formatting and\nconditional filters.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The value is one year before today.",
- "The value is one month before today.",
- "The value is one week before today.",
- "The value is yesterday.",
- "The value is today.",
- "The value is tomorrow."
- ],
- "enum": [
- "RELATIVE_DATE_UNSPECIFIED",
- "PAST_YEAR",
- "PAST_MONTH",
- "PAST_WEEK",
- "YESTERDAY",
- "TODAY",
- "TOMORROW"
- ]
- },
- "userEnteredValue": {
- "description": "A value the condition is based on.\nThe value will be parsed as if the user typed into a cell.\nFormulas are supported (and must begin with an `=`).",
- "type": "string"
- }
- },
- "id": "ConditionValue"
- },
- "DuplicateSheetRequest": {
- "description": "Duplicates the contents of a sheet.",
- "type": "object",
- "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"
- },
- "sourceSheetId": {
- "description": "The sheet to duplicate.",
- "format": "int32",
- "type": "integer"
- },
- "newSheetId": {
- "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DuplicateSheetRequest"
- },
- "ExtendedValue": {
- "description": "The kinds of value that a cell in a spreadsheet can have.",
- "type": "object",
- "properties": {
- "numberValue": {
- "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
- "format": "double",
- "type": "number"
- },
- "errorValue": {
- "description": "Represents an error.\nThis field is read-only.",
- "$ref": "ErrorValue"
- },
- "stringValue": {
- "description": "Represents a string value.\nLeading single quotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.",
- "type": "string"
- },
- "boolValue": {
- "description": "Represents a boolean value.",
- "type": "boolean"
- },
- "formulaValue": {
- "description": "Represents a formula.",
- "type": "string"
- }
- },
- "id": "ExtendedValue"
- },
- "HistogramSeries": {
- "description": "A histogram series containing the series color and data.",
- "type": "object",
- "properties": {
- "barColor": {
- "description": "The color of the column representing this series in each bucket.\nThis field is optional.",
- "$ref": "Color"
- },
- "data": {
- "description": "The data for this histogram series.",
- "$ref": "ChartData"
- }
- },
- "id": "HistogramSeries"
- },
- "BatchClearValuesResponse": {
- "description": "The response when clearing a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "clearedRanges": {
- "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- }
- },
- "id": "BatchClearValuesResponse"
- },
- "Spreadsheet": {
- "description": "Resource that represents a spreadsheet.",
- "type": "object",
- "properties": {
- "spreadsheetUrl": {
- "description": "The url of the spreadsheet.\nThis field is read-only.",
- "type": "string"
- },
- "properties": {
- "description": "Overall properties of a spreadsheet.",
- "$ref": "SpreadsheetProperties"
- },
- "spreadsheetId": {
- "description": "The ID of the spreadsheet.\nThis field is read-only.",
- "type": "string"
- },
- "namedRanges": {
- "description": "The named ranges defined in a spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "NamedRange"
- }
- },
- "developerMetadata": {
- "description": "The developer metadata associated with a spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
- },
- "sheets": {
- "description": "The sheets that are part of a spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "Sheet"
- }
- }
- },
- "id": "Spreadsheet"
- },
- "BandedRange": {
- "description": "A banded (alternating colors) range in a sheet.",
- "type": "object",
- "properties": {
- "rowProperties": {
- "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified.",
- "$ref": "BandingProperties"
- },
- "columnProperties": {
- "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.",
- "$ref": "BandingProperties"
- },
- "range": {
- "description": "The range over which these properties are applied.",
- "$ref": "GridRange"
- },
- "bandedRangeId": {
- "description": "The id of the banded range.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "BandedRange"
- },
- "AddChartRequest": {
- "description": "Adds a chart to a sheet in the spreadsheet.",
- "type": "object",
- "properties": {
- "chart": {
- "description": "The chart that should be added to the spreadsheet, including the position\nwhere it should be placed. The chartId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a chart that already exists.)",
- "$ref": "EmbeddedChart"
- }
- },
- "id": "AddChartRequest"
- },
- "UpdateProtectedRangeRequest": {
- "description": "Updates an existing protected range with the specified\nprotectedRangeId.",
- "type": "object",
- "properties": {
- "protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The protected range to update with the new properties."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `protectedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateProtectedRangeRequest"
- },
- "DataFilter": {
- "description": "Filter that describes what data should be selected or returned from a\nrequest.",
- "type": "object",
- "properties": {
- "gridRange": {
- "$ref": "GridRange",
- "description": "Selects data that matches the range described by the GridRange."
- },
- "developerMetadataLookup": {
- "description": "Selects data associated with the developer metadata matching the criteria\ndescribed by this DeveloperMetadataLookup.",
- "$ref": "DeveloperMetadataLookup"
- },
- "a1Range": {
- "description": "Selects data that matches the specified A1 range.",
- "type": "string"
- }
- },
- "id": "DataFilter"
- },
- "TextFormat": {
- "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.",
- "type": "object",
- "properties": {
- "underline": {
- "description": "True if the text is underlined.",
- "type": "boolean"
- },
- "bold": {
- "description": "True if the text is bold.",
- "type": "boolean"
- },
- "foregroundColor": {
- "$ref": "Color",
- "description": "The foreground color of the text."
- },
- "fontFamily": {
- "description": "The font family.",
- "type": "string"
- },
- "strikethrough": {
- "description": "True if the text has a strikethrough.",
- "type": "boolean"
- },
- "italic": {
- "description": "True if the text is italicized.",
- "type": "boolean"
- },
- "fontSize": {
- "description": "The size of the font.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TextFormat"
- },
- "AddSheetResponse": {
- "description": "The result of adding a sheet.",
- "type": "object",
- "properties": {
- "properties": {
- "$ref": "SheetProperties",
- "description": "The properties of the newly added sheet."
- }
- },
- "id": "AddSheetResponse"
- },
- "AddFilterViewResponse": {
- "description": "The result of adding a filter view.",
- "type": "object",
- "properties": {
- "filter": {
- "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": {
- "maxIterations": {
- "description": "When iterative calculation is enabled, the maximum number of calculation\nrounds to perform.",
- "format": "int32",
- "type": "integer"
- },
- "convergenceThreshold": {
- "description": "When iterative calculation is enabled and successive results differ by\nless than this threshold value, the calculation rounds stop.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "IterativeCalculationSettings"
- },
- "SpreadsheetProperties": {
- "description": "Properties of a spreadsheet.",
- "type": "object",
- "properties": {
- "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"
- },
- "title": {
- "description": "The title of the spreadsheet.",
- "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": {
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "Volatile functions are updated on every change.",
- "Volatile functions are updated on every change and every minute.",
- "Volatile functions are updated on every change and hourly."
- ],
- "enum": [
- "RECALCULATION_INTERVAL_UNSPECIFIED",
- "ON_CHANGE",
- "MINUTE",
- "HOUR"
- ],
- "description": "The amount of time to wait before volatile functions are recalculated.",
- "type": "string"
- },
- "defaultFormat": {
- "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"
- }
- },
- "id": "SpreadsheetProperties"
- },
- "OverlayPosition": {
- "description": "The location an object is overlaid on top of a grid.",
- "type": "object",
- "properties": {
- "widthPixels": {
- "description": "The width of the object, in pixels. Defaults to 600.",
- "format": "int32",
- "type": "integer"
- },
- "offsetXPixels": {
- "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.",
- "format": "int32",
- "type": "integer"
- },
- "anchorCell": {
- "description": "The cell the object is anchored to.",
- "$ref": "GridCoordinate"
- },
- "offsetYPixels": {
- "description": "The vertical offset, in pixels, that the object is offset\nfrom the anchor cell.",
- "format": "int32",
- "type": "integer"
- },
- "heightPixels": {
- "description": "The height of the object, in pixels. Defaults to 371.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "OverlayPosition"
- },
- "RepeatCellRequest": {
- "description": "Updates all cells in the range to the values in the given Cell object.\nOnly the fields listed in the fields field are updated; others are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges will automatically\nincrement for each field in the range.\nFor example, if writing a cell with formula `=A1` into range B2:C4,\nB2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`,\nC2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`.\n\nTo keep the formula's ranges static, use the `$` indicator.\nFor example, use the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing.",
- "type": "object",
- "properties": {
- "cell": {
- "description": "The data to write.",
- "$ref": "CellData"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range to repeat the cell in."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `cell` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "RepeatCellRequest"
- },
- "AddChartResponse": {
- "description": "The result of adding a chart to a spreadsheet.",
- "type": "object",
- "properties": {
- "chart": {
- "$ref": "EmbeddedChart",
- "description": "The newly added chart."
- }
- },
- "id": "AddChartResponse"
- },
- "InsertDimensionRequest": {
- "description": "Inserts rows or columns in a sheet at a particular index.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The dimensions to insert. Both the start and end indexes must be bounded.",
- "$ref": "DimensionRange"
- },
- "inheritFromBefore": {
- "description": "Whether dimension properties should be extended from the dimensions\nbefore or after the newly inserted dimensions.\nTrue to inherit from the dimensions before (in which case the start\nindex must be greater than 0), and false to inherit from the dimensions\nafter.\n\nFor example, if row index 0 has red background and row index 1\nhas a green background, then inserting 2 rows at index 1 can inherit\neither the green or red background. If `inheritFromBefore` is true,\nthe two new rows will be red (because the row before the insertion point\nwas red), whereas if `inheritFromBefore` is false, the two new rows will\nbe green (because the row after the insertion point was green).",
- "type": "boolean"
- }
- },
- "id": "InsertDimensionRequest"
- },
- "UpdateSpreadsheetPropertiesRequest": {
- "description": "Updates properties of a spreadsheet.",
- "type": "object",
- "properties": {
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root 'properties' is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "properties": {
- "description": "The properties to update.",
- "$ref": "SpreadsheetProperties"
- }
- },
- "id": "UpdateSpreadsheetPropertiesRequest"
- },
- "BatchUpdateValuesRequest": {
- "description": "The request for updating more than one range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "responseValueRenderOption": {
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string",
- "enumDescriptions": [
- "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
- "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
- "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
- ],
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ]
- },
- "includeValuesInResponse": {
- "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
- "type": "boolean"
- },
- "valueInputOption": {
- "enumDescriptions": [
- "Default input value. This value must not be used.",
- "The values the user has entered will not be parsed and will be stored\nas-is.",
- "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
- ],
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ],
- "description": "How the input data should be interpreted.",
- "type": "string"
- },
- "data": {
- "description": "The new values to apply to the spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "ValueRange"
- }
- },
- "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"
- ]
- }
- },
- "id": "BatchUpdateValuesRequest"
- },
- "ProtectedRange": {
- "description": "A protected range.",
- "type": "object",
- "properties": {
- "description": {
- "description": "The description of this protected range.",
- "type": "string"
- },
- "unprotectedRanges": {
- "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets.",
- "type": "array",
- "items": {
- "$ref": "GridRange"
- }
- },
- "namedRangeId": {
- "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "type": "string"
- },
- "protectedRangeId": {
- "description": "The ID of the protected range.\nThis field is read-only.",
- "format": "int32",
- "type": "integer"
- },
- "warningOnly": {
- "description": "True if this protected range will show a warning when editing.\nWarning-based protection means that every user can edit data in the\nprotected range, except editing will prompt a warning asking the user\nto confirm the edit.\n\nWhen writing: if this field is true, then editors is ignored.\nAdditionally, if this field is changed from true to false and the\n`editors` field is not set (nor included in the field mask), then\nthe editors will be set to all the editors in the document.",
- "type": "boolean"
- },
- "requestingUserCanEdit": {
- "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only.",
- "type": "boolean"
- },
- "range": {
- "$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"
- }
- },
- "id": "ProtectedRange"
- },
- "DimensionProperties": {
- "description": "Properties about a dimension.",
- "type": "object",
- "properties": {
- "pixelSize": {
- "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "hiddenByFilter": {
- "description": "True if this dimension is being filtered.\nThis field is read-only.",
- "type": "boolean"
- },
- "hiddenByUser": {
- "description": "True if this dimension is explicitly hidden.",
- "type": "boolean"
- },
- "developerMetadata": {
- "description": "The developer metadata associated with a single row or column.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
- }
- },
- "id": "DimensionProperties"
- },
- "NamedRange": {
- "description": "A named range.",
- "type": "object",
- "properties": {
- "namedRangeId": {
- "description": "The ID of the named range.",
- "type": "string"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range this represents."
- },
- "name": {
- "description": "The name of the named range.",
- "type": "string"
- }
- },
- "id": "NamedRange"
- },
- "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",
- "type": "integer"
- },
- "endIndex": {
- "description": "The end (exclusive) of the span, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "description": "The sheet this span is on.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DimensionRange"
- },
- "CutPasteRequest": {
- "description": "Moves data from the source to the destination.",
- "type": "object",
- "properties": {
- "destination": {
- "$ref": "GridCoordinate",
- "description": "The top-left coordinate where the data should be pasted."
- },
- "source": {
- "$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",
- "PASTE_FORMAT",
- "PASTE_NO_BORDERS",
- "PASTE_FORMULA",
- "PASTE_DATA_VALIDATION",
- "PASTE_CONDITIONAL_FORMATTING"
- ],
- "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
- "type": "string"
- }
- },
- "id": "CutPasteRequest"
- },
- "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"
- },
- "left": {
- "description": "The left border of the cell.",
- "$ref": "Border"
- }
- },
- "id": "Borders"
- },
- "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."
- },
- "series": {
- "$ref": "ChartData",
- "description": "The data being visualized in this chart series."
- },
- "type": {
- "description": "The type of this series. Valid only if the\nchartType is\nCOMBO.\nDifferent types will change the way the series is visualized.\nOnly LINE, AREA,\nand COLUMN are supported.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/linechart\"\u003eline chart\u003c/a\u003e.",
- "An \u003ca href=\"/chart/interactive/docs/gallery/areachart\"\u003earea chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/columnchart\"\u003ecolumn chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/scatterchart\"\u003escatter chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/combochart\"\u003ecombo chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/steppedareachart\"\u003estepped area chart\u003c/a\u003e."
- ],
- "enum": [
- "BASIC_CHART_TYPE_UNSPECIFIED",
- "BAR",
- "LINE",
- "AREA",
- "COLUMN",
- "SCATTER",
- "COMBO",
- "STEPPED_AREA"
- ]
- },
- "targetAxis": {
- "description": "The minor axis that will specify the range of values for this series.\nFor example, if charting stocks over time, the \"Volume\" series\nmay want to be pinned to the right with the prices pinned to the left,\nbecause the scale of trading volume is different than the scale of\nprices.\nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart's type.",
- "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."
- ],
- "enum": [
- "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
- "BOTTOM_AXIS",
- "LEFT_AXIS",
- "RIGHT_AXIS"
- ]
- }
- },
- "id": "BasicChartSeries"
- },
- "AutoResizeDimensionsRequest": {
- "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
- "type": "object",
- "properties": {
- "dimensions": {
- "description": "The dimensions to automatically resize.",
- "$ref": "DimensionRange"
- }
- },
- "id": "AutoResizeDimensionsRequest"
- },
- "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": {
- "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": {
- "description": "The range whose borders should be updated.",
- "$ref": "GridRange"
- },
- "innerHorizontal": {
- "$ref": "Border",
- "description": "The horizontal border to put within the range."
- },
- "top": {
- "description": "The border to put at the top of the range.",
- "$ref": "Border"
- },
- "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"
- }
- },
- "id": "UpdateBordersRequest"
- },
- "CellFormat": {
- "description": "The format of a cell.",
- "type": "object",
- "properties": {
- "numberFormat": {
- "description": "A format describing how number values should be represented to the user.",
- "$ref": "NumberFormat"
- },
- "hyperlinkDisplayType": {
- "description": "How a hyperlink, if it exists, should be displayed in the cell.",
- "type": "string",
- "enumDescriptions": [
- "The default value: the hyperlink is rendered. Do not use this.",
- "A hyperlink should be explicitly rendered.",
- "A hyperlink should not be rendered."
- ],
- "enum": [
- "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
- "LINKED",
- "PLAIN_TEXT"
- ]
- },
- "horizontalAlignment": {
- "description": "The horizontal alignment of the value in the cell.",
- "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."
- ],
- "enum": [
- "HORIZONTAL_ALIGN_UNSPECIFIED",
- "LEFT",
- "CENTER",
- "RIGHT"
- ]
- },
- "textFormat": {
- "$ref": "TextFormat",
- "description": "The format of the text in the cell (unless overridden by a format run)."
- },
- "backgroundColor": {
- "description": "The background color of the cell.",
- "$ref": "Color"
- },
- "padding": {
- "description": "The padding of the cell.",
- "$ref": "Padding"
- },
- "verticalAlignment": {
- "enumDescriptions": [
- "The vertical alignment is not specified. Do not use this.",
- "The text is explicitly aligned to the top of the cell.",
- "The text is explicitly aligned to the middle of the cell.",
- "The text is explicitly aligned to the bottom of the cell."
- ],
- "enum": [
- "VERTICAL_ALIGN_UNSPECIFIED",
- "TOP",
- "MIDDLE",
- "BOTTOM"
- ],
- "description": "The vertical alignment of the value in the cell.",
- "type": "string"
- },
- "borders": {
- "description": "The borders of the cell.",
- "$ref": "Borders"
- },
- "textDirection": {
- "description": "The direction of the text in the cell.",
- "type": "string",
- "enumDescriptions": [
- "The text direction is not specified. Do not use this.",
- "The text direction of left-to-right was set by the user.",
- "The text direction of right-to-left was set by the user."
- ],
- "enum": [
- "TEXT_DIRECTION_UNSPECIFIED",
- "LEFT_TO_RIGHT",
- "RIGHT_TO_LEFT"
- ]
- },
- "wrapStrategy": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Lines that are longer than the cell width will be written in the next\ncell over, so long as that cell is empty. If the next cell over is\nnon-empty, this behaves the same as CLIP. The text will never wrap\nto the next line unless the user manually inserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline that is very long. \u003c- Text continues into next cell\n | Next newline. |",
- "This wrap strategy represents the old Google Sheets wrap strategy where\nwords that are longer than a line are clipped rather than broken. This\nstrategy is not supported on all platforms and is being phased out.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is clipped.\n | word. |",
- "Lines that are longer than the cell width will be clipped.\nThe text will never wrap to the next line unless the user manually\ninserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline t| \u003c- Text is clipped\n | Next newline. |",
- "Words that are longer than a line are wrapped at the character level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is broken.\n | ong word. |"
- ],
- "enum": [
- "WRAP_STRATEGY_UNSPECIFIED",
- "OVERFLOW_CELL",
- "LEGACY_WRAP",
- "CLIP",
- "WRAP"
- ],
- "description": "The wrap strategy for the value in the cell.",
- "type": "string"
- },
- "textRotation": {
- "$ref": "TextRotation",
- "description": "The rotation applied to text in a cell"
- }
- },
- "id": "CellFormat"
- },
- "ClearValuesResponse": {
- "description": "The response when clearing a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "clearedRange": {
- "description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)",
- "type": "string"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- }
- },
- "id": "ClearValuesResponse"
- },
- "DeleteConditionalFormatRuleRequest": {
- "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.",
- "type": "object",
- "properties": {
- "index": {
- "description": "The zero-based index of the rule to be deleted.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "description": "The sheet the rule is being deleted from.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteConditionalFormatRuleRequest"
- },
- "AddBandingResponse": {
- "description": "The result of adding a banded range.",
- "type": "object",
- "properties": {
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range that was added."
- }
- },
- "id": "AddBandingResponse"
- },
- "DeleteNamedRangeRequest": {
- "description": "Removes the named range with the given ID from the spreadsheet.",
- "type": "object",
- "properties": {
- "namedRangeId": {
- "description": "The ID of the named range to delete.",
- "type": "string"
- }
- },
- "id": "DeleteNamedRangeRequest"
- },
- "WaterfallChartCustomSubtotal": {
- "description": "A custom subtotal column for a waterfall chart series.",
- "type": "object",
- "properties": {
- "subtotalIndex": {
- "description": "The 0-based index of a data point within the series. If\ndata_is_subtotal is true, the data point at this index is the\nsubtotal. Otherwise, the subtotal appears after the data point with\nthis index. A series can have multiple subtotals at arbitrary indices,\nbut subtotals do not affect the indices of the data points. For\nexample, if a series has 3 data points, their indices will always be 0,\n1, and 2, regardless of how many subtotals exist on the series or what\ndata points they are associated with.",
- "format": "int32",
- "type": "integer"
- },
- "dataIsSubtotal": {
- "description": "True if the data point at subtotal_index is the subtotal. If false,\nthe subtotal will be computed and appear after the data point.",
- "type": "boolean"
- },
- "label": {
- "description": "A label for the subtotal column.",
- "type": "string"
- }
- },
- "id": "WaterfallChartCustomSubtotal"
- },
- "ChartData": {
- "description": "The data included in a domain or series.",
- "type": "object",
- "properties": {
- "sourceRange": {
- "$ref": "ChartSourceRange",
- "description": "The source ranges of the data."
- }
- },
- "id": "ChartData"
- },
- "BatchGetValuesResponse": {
- "description": "The response when retrieving more than one range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "valueRanges": {
- "description": "The requested values. The order of the ValueRanges is the same as the\norder of the requested ranges.",
- "type": "array",
- "items": {
- "$ref": "ValueRange"
- }
- },
- "spreadsheetId": {
- "description": "The ID of the spreadsheet the data was retrieved from.",
- "type": "string"
- }
- },
- "id": "BatchGetValuesResponse"
- },
- "UpdateBandingRequest": {
- "description": "Updates properties of the supplied banded range.",
- "type": "object",
- "properties": {
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range to update with the new properties."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `bandedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateBandingRequest"
- },
- "Color": {
- "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
- "type": "object",
- "properties": {
- "green": {
- "description": "The amount of green in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
- "blue": {
- "description": "The amount of blue in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
- "alpha": {
- "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
- "format": "float",
- "type": "number"
- },
- "red": {
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- }
- },
- "id": "Color"
- },
- "PivotGroup": {
- "description": "A single grouping (either row or column) in a pivot table.",
- "type": "object",
- "properties": {
- "sortOrder": {
- "enumDescriptions": [
- "Default value, do not use this.",
- "Sort ascending.",
- "Sort descending."
- ],
- "enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ],
- "description": "The order the values in this group should be sorted.",
- "type": "string"
- },
- "valueBucket": {
- "$ref": "PivotGroupSortValueBucket",
- "description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values."
- },
- "sourceColumnOffset": {
- "description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.",
- "format": "int32",
- "type": "integer"
- },
- "showTotals": {
- "description": "True if the pivot table should include the totals for this grouping.",
- "type": "boolean"
- },
- "valueMetadata": {
- "description": "Metadata about values in the grouping.",
- "type": "array",
- "items": {
- "$ref": "PivotGroupValueMetadata"
- }
- }
- },
- "id": "PivotGroup"
- },
- "PivotTable": {
- "description": "A pivot table.",
- "type": "object",
- "properties": {
- "criteria": {
- "additionalProperties": {
- "$ref": "PivotFilterCriteria"
- },
- "description": "An optional mapping of filters per source column offset.\n\nThe filters will be applied before aggregating data into the pivot table.\nThe map's key is the column offset of the source range that you want to\nfilter, and the value is the criteria for that column.\n\nFor example, if the source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, whereas the key `1` is for column `D`.",
- "type": "object"
- },
- "rows": {
- "description": "Each row grouping in the pivot table.",
- "type": "array",
- "items": {
- "$ref": "PivotGroup"
- }
- },
- "valueLayout": {
- "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)."
- ],
- "enum": [
- "HORIZONTAL",
- "VERTICAL"
- ]
- },
- "values": {
- "description": "A list of values to include in the pivot table.",
- "type": "array",
- "items": {
- "$ref": "PivotValue"
- }
- },
- "source": {
- "$ref": "GridRange",
- "description": "The range the pivot table is reading data from."
- },
- "columns": {
- "description": "Each column grouping in the pivot table.",
- "type": "array",
- "items": {
- "$ref": "PivotGroup"
- }
- }
- },
- "id": "PivotTable"
- },
- "ChartSourceRange": {
- "description": "Source ranges for a chart.",
- "type": "object",
- "properties": {
- "sources": {
- "description": "The ranges of data for a series or domain.\nExactly one dimension must have a length of 1,\nand all sources in the list must have the same dimension\nwith length 1.\nThe domain (if it exists) & all series must have the same number\nof source ranges. If using more than one source range, then the source\nrange at a given offset must be contiguous across the domain and series.\n\nFor example, these are valid configurations:\n\n domain sources: A1:A5\n series1 sources: B1:B5\n series2 sources: D6:D10\n\n domain sources: A1:A5, C10:C12\n series1 sources: B1:B5, D10:D12\n series2 sources: C1:C5, E10:E12",
- "type": "array",
- "items": {
- "$ref": "GridRange"
- }
- }
- },
- "id": "ChartSourceRange"
- },
- "SearchDeveloperMetadataResponse": {
- "description": "A reply to a developer metadata search request.",
- "type": "object",
- "properties": {
- "matchedDeveloperMetadata": {
- "description": "The metadata matching the criteria of the search request.",
- "type": "array",
- "items": {
- "$ref": "MatchedDeveloperMetadata"
- }
- }
- },
- "id": "SearchDeveloperMetadataResponse"
- },
- "AppendCellsRequest": {
- "description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.",
- "type": "object",
- "properties": {
- "rows": {
- "description": "The data to append.",
- "type": "array",
- "items": {
- "$ref": "RowData"
- }
- },
- "fields": {
- "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "sheetId": {
- "description": "The sheet ID to append the data to.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AppendCellsRequest"
- },
- "ValueRange": {
- "description": "Data within a range of the spreadsheet.",
- "type": "object",
- "properties": {
- "majorDimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The major dimension of the values.\n\nFor output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`\nwill set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`\nthen `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.\n\nWhen writing, if this field is not set, it defaults to ROWS.",
- "type": "string"
- },
- "values": {
- "description": "The data that was read or to be written. This is an array of arrays,\nthe outer array representing all the data and each inner array\nrepresenting a major dimension. Each item in the inner array\ncorresponds with one cell.\n\nFor output, empty trailing rows and columns will not be included.\n\nFor input, supported value types are: bool, string, and double.\nNull values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.",
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- },
- "range": {
- "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.",
- "type": "string"
- }
- },
- "id": "ValueRange"
- },
- "AddBandingRequest": {
- "description": "Adds a new banded range to the spreadsheet.",
- "type": "object",
- "properties": {
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range to add. The bandedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
- }
- },
- "id": "AddBandingRequest"
- },
- "Response": {
- "description": "A single response from an update.",
- "type": "object",
- "properties": {
- "updateConditionalFormatRule": {
- "$ref": "UpdateConditionalFormatRuleResponse",
- "description": "A reply from updating a conditional format rule."
- },
- "createDeveloperMetadata": {
- "description": "A reply from creating a developer metadata entry.",
- "$ref": "CreateDeveloperMetadataResponse"
- },
- "addNamedRange": {
- "$ref": "AddNamedRangeResponse",
- "description": "A reply from adding a named range."
- },
- "deleteDeveloperMetadata": {
- "$ref": "DeleteDeveloperMetadataResponse",
- "description": "A reply from deleting a developer metadata entry."
- },
- "addFilterView": {
- "$ref": "AddFilterViewResponse",
- "description": "A reply from adding a filter view."
- },
- "addBanding": {
- "description": "A reply from adding a banded range.",
- "$ref": "AddBandingResponse"
- },
- "addProtectedRange": {
- "description": "A reply from adding a protected range.",
- "$ref": "AddProtectedRangeResponse"
- },
- "duplicateSheet": {
- "description": "A reply from duplicating a sheet.",
- "$ref": "DuplicateSheetResponse"
- },
- "updateEmbeddedObjectPosition": {
- "description": "A reply from updating an embedded object's position.",
- "$ref": "UpdateEmbeddedObjectPositionResponse"
- },
- "deleteConditionalFormatRule": {
- "description": "A reply from deleting a conditional format rule.",
- "$ref": "DeleteConditionalFormatRuleResponse"
- },
- "duplicateFilterView": {
- "$ref": "DuplicateFilterViewResponse",
- "description": "A reply from duplicating a filter view."
- },
- "addChart": {
- "description": "A reply from adding a chart.",
- "$ref": "AddChartResponse"
- },
- "updateDeveloperMetadata": {
- "description": "A reply from updating a developer metadata entry.",
- "$ref": "UpdateDeveloperMetadataResponse"
- },
- "findReplace": {
- "description": "A reply from doing a find/replace.",
- "$ref": "FindReplaceResponse"
- },
- "addSheet": {
- "$ref": "AddSheetResponse",
- "description": "A reply from adding a sheet."
- }
- },
- "id": "Response"
- },
- "InsertRangeRequest": {
- "description": "Inserts cells into a range, shifting the existing cells over or down.",
- "type": "object",
- "properties": {
- "shiftDimension": {
- "description": "The dimension which will be shifted when inserting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existing cells will be shifted right.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ]
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range to insert new cells into."
- }
- },
- "id": "InsertRangeRequest"
- },
- "TextFormatRun": {
- "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set.",
- "type": "object",
- "properties": {
- "startIndex": {
- "description": "The character index where this run starts.",
- "format": "int32",
- "type": "integer"
- },
- "format": {
- "$ref": "TextFormat",
- "description": "The format of this run. Absent values inherit the cell's format."
- }
- },
- "id": "TextFormatRun"
- },
- "EmbeddedChart": {
- "description": "A chart embedded in a sheet.",
- "type": "object",
- "properties": {
- "chartId": {
- "description": "The ID of the chart.",
- "format": "int32",
- "type": "integer"
- },
- "position": {
- "$ref": "EmbeddedObjectPosition",
- "description": "The position of the chart."
- },
- "spec": {
- "description": "The specification of the chart.",
- "$ref": "ChartSpec"
- }
- },
- "id": "EmbeddedChart"
- },
- "AddNamedRangeResponse": {
- "description": "The result of adding a named range.",
- "type": "object",
- "properties": {
- "namedRange": {
- "$ref": "NamedRange",
- "description": "The named range to add."
- }
- },
- "id": "AddNamedRangeResponse"
- },
- "BatchUpdateValuesByDataFilterResponse": {
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "totalUpdatedSheets": {
- "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "totalUpdatedCells": {
- "description": "The total number of cells updated.",
- "format": "int32",
- "type": "integer"
- },
- "totalUpdatedColumns": {
- "description": "The total number of columns where at least one cell in the column was\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "totalUpdatedRows": {
- "description": "The total number of rows where at least one cell in the row was updated.",
- "format": "int32",
- "type": "integer"
- },
- "responses": {
- "description": "The response for each range updated.",
- "type": "array",
- "items": {
- "$ref": "UpdateValuesByDataFilterResponse"
- }
- }
- },
- "id": "BatchUpdateValuesByDataFilterResponse"
- },
- "RowData": {
- "description": "Data about each cell in a row.",
- "type": "object",
- "properties": {
- "values": {
- "description": "The values in the row, one per column.",
- "type": "array",
- "items": {
- "$ref": "CellData"
- }
- }
- },
- "id": "RowData"
- },
- "GridData": {
- "description": "Data in the grid, as well as metadata about the dimensions.",
- "type": "object",
- "properties": {
- "startColumn": {
- "description": "The first column this GridData refers to, zero-based.",
- "format": "int32",
- "type": "integer"
- },
- "rowMetadata": {
- "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.",
- "type": "array",
- "items": {
- "$ref": "DimensionProperties"
- }
- },
- "rowData": {
- "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.",
- "type": "array",
- "items": {
- "$ref": "RowData"
- }
- },
- "startRow": {
- "description": "The first row this GridData refers to, zero-based.",
- "format": "int32",
- "type": "integer"
- },
- "columnMetadata": {
- "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
- "type": "array",
- "items": {
- "$ref": "DimensionProperties"
- }
- }
- },
- "id": "GridData"
- },
- "Border": {
- "description": "A border along a cell.",
- "type": "object",
- "properties": {
- "style": {
- "description": "The style of the border.",
- "type": "string",
- "enumDescriptions": [
- "The style is not specified. Do not use this.",
- "The border is dotted.",
- "The border is dashed.",
- "The border is a thin solid line.",
- "The border is a medium solid line.",
- "The border is a thick solid line.",
- "No border.\nUsed only when updating a border in order to erase it.",
- "The border is two solid lines."
- ],
- "enum": [
- "STYLE_UNSPECIFIED",
- "DOTTED",
- "DASHED",
- "SOLID",
- "SOLID_MEDIUM",
- "SOLID_THICK",
- "NONE",
- "DOUBLE"
- ]
- },
- "color": {
- "$ref": "Color",
- "description": "The color of the border."
- },
- "width": {
- "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Border"
- },
- "FindReplaceRequest": {
- "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": {
- "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"
- },
- "range": {
- "description": "The range to find/replace over.",
- "$ref": "GridRange"
- },
- "sheetId": {
- "description": "The sheet to find/replace over.",
- "format": "int32",
- "type": "integer"
- },
- "allSheets": {
- "description": "True to find/replace over all sheets.",
- "type": "boolean"
- },
- "matchCase": {
- "description": "True if the search is case sensitive.",
- "type": "boolean"
- }
- },
- "id": "FindReplaceRequest"
- },
- "UpdateNamedRangeRequest": {
- "description": "Updates properties of the named range with the specified\nnamedRangeId.",
- "type": "object",
- "properties": {
- "namedRange": {
- "description": "The named range to update with the new properties.",
- "$ref": "NamedRange"
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `namedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateNamedRangeRequest"
- },
- "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"
- }
- },
- "id": "AddSheetRequest"
- },
- "UpdateCellsRequest": {
- "description": "Updates all cells in a range with new data.",
- "type": "object",
- "properties": {
- "start": {
- "$ref": "GridCoordinate",
- "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written."
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range to write data to.\n\nIf the data in rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared."
- },
- "rows": {
- "description": "The data to write.",
- "type": "array",
- "items": {
- "$ref": "RowData"
- }
- },
- "fields": {
- "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateCellsRequest"
- },
- "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": {
- "description": "The rule that was deleted.",
- "$ref": "ConditionalFormatRule"
- }
- },
- "id": "DeleteConditionalFormatRuleResponse"
- },
- "DeleteRangeRequest": {
- "description": "Deletes a range of cells, shifting other cells into the deleted area.",
- "type": "object",
- "properties": {
- "shiftDimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace the deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells.",
- "type": "string"
- },
- "range": {
- "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": {
- "description": "The column index of the coordinate.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "description": "The sheet this coordinate is on.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GridCoordinate"
- },
- "UpdateSheetPropertiesRequest": {
- "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": {
- "rowCount": {
- "description": "The number of rows in the grid.",
- "format": "int32",
- "type": "integer"
- },
- "frozenRowCount": {
- "description": "The number of rows that are frozen in the grid.",
- "format": "int32",
- "type": "integer"
- },
- "hideGridlines": {
- "description": "True if the grid isn't showing gridlines in the UI.",
- "type": "boolean"
- },
- "columnCount": {
- "description": "The number of columns in the grid.",
- "format": "int32",
- "type": "integer"
- },
- "frozenColumnCount": {
- "description": "The number of columns that are frozen in the grid.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GridProperties"
- },
- "UnmergeCellsRequest": {
- "description": "Unmerges cells in the given range.",
- "type": "object",
- "properties": {
- "range": {
- "$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": {
- "dimensionIndex": {
- "description": "The dimension the sort should be applied to.",
- "format": "int32",
- "type": "integer"
- },
- "sortOrder": {
- "description": "The order data should be sorted.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use this.",
- "Sort ascending.",
- "Sort descending."
- ],
- "enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ]
- }
- },
- "id": "SortSpec"
- },
- "Sheet": {
- "description": "A sheet in a spreadsheet.",
- "type": "object",
- "properties": {
- "merges": {
- "description": "The ranges that are merged together.",
- "type": "array",
- "items": {
- "$ref": "GridRange"
- }
- },
- "data": {
- "description": "Data in the grid, if this is a grid sheet.\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D).",
- "type": "array",
- "items": {
- "$ref": "GridData"
- }
- },
- "bandedRanges": {
- "description": "The banded (i.e. alternating colors) ranges on this sheet.",
- "type": "array",
- "items": {
- "$ref": "BandedRange"
- }
- },
- "charts": {
- "description": "The specifications of every chart on this sheet.",
- "type": "array",
- "items": {
- "$ref": "EmbeddedChart"
- }
- },
- "properties": {
- "description": "The properties of the sheet.",
- "$ref": "SheetProperties"
- },
- "filterViews": {
- "description": "The filter views in this sheet.",
- "type": "array",
- "items": {
- "$ref": "FilterView"
- }
- },
- "conditionalFormats": {
- "description": "The conditional format rules in this sheet.",
- "type": "array",
- "items": {
- "$ref": "ConditionalFormatRule"
- }
- },
- "protectedRanges": {
- "description": "The protected ranges in this sheet.",
- "type": "array",
- "items": {
- "$ref": "ProtectedRange"
- }
- },
- "developerMetadata": {
- "description": "The developer metadata associated with a sheet.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
- },
- "basicFilter": {
- "description": "The filter on this sheet, if any.",
- "$ref": "BasicFilter"
- }
- },
- "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": {
- "description": "A rule that may or may not match, depending on the condition.",
- "type": "object",
- "properties": {
- "format": {
- "$ref": "CellFormat",
- "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color."
- },
- "condition": {
- "$ref": "BooleanCondition",
- "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
- }
- },
- "id": "BooleanRule"
- },
- "FilterCriteria": {
- "description": "Criteria for showing/hiding rows in a filter or filter view.",
- "type": "object",
- "properties": {
- "hiddenValues": {
- "description": "Values that should be hidden.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "condition": {
- "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": {
- "description": "Metadata about a value in a pivot grouping.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)",
- "$ref": "ExtendedValue"
- },
- "collapsed": {
- "description": "True if the data corresponding to the value is collapsed.",
- "type": "boolean"
- }
- },
- "id": "PivotGroupValueMetadata"
- },
- "WaterfallChartSpec": {
- "description": "A waterfall chart.",
- "type": "object",
- "properties": {
- "firstValueIsTotal": {
- "description": "True to interpret the first value as a total.",
- "type": "boolean"
- },
- "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": {
- "$ref": "WaterfallChartDomain",
- "description": "The domain data (horizontal axis) for the waterfall chart."
- }
- },
- "id": "WaterfallChartSpec"
- },
- "Editors": {
- "description": "The editors of a protected range.",
- "type": "object",
- "properties": {
- "users": {
- "description": "The email addresses of users with edit access to the protected range.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "groups": {
- "description": "The email addresses of groups with edit access to the protected range.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "domainUsersCanEdit": {
- "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on documents within a domain.",
- "type": "boolean"
- }
- },
- "id": "Editors"
- },
- "UpdateConditionalFormatRuleRequest": {
- "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
- "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"
- },
- "BasicChartDomain": {
- "description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date.",
- "type": "object",
- "properties": {
- "domain": {
- "description": "The data of the domain. For example, if charting stock prices over time,\nthis is the data representing the dates.",
- "$ref": "ChartData"
- },
- "reversed": {
- "description": "True to reverse the order of the domain values (horizontal axis).",
- "type": "boolean"
- }
- },
- "id": "BasicChartDomain"
- },
- "DataValidationRule": {
- "description": "A data validation rule.",
- "type": "object",
- "properties": {
- "condition": {
- "description": "The condition that data in the cell must match.",
- "$ref": "BooleanCondition"
- },
- "showCustomUi": {
- "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
- "type": "boolean"
- },
- "strict": {
- "description": "True if invalid data should be rejected.",
- "type": "boolean"
- },
- "inputMessage": {
- "description": "A message to show the user when adding data to the cell.",
- "type": "string"
- }
- },
- "id": "DataValidationRule"
- },
- "PasteDataRequest": {
- "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
- "type": "object",
- "properties": {
- "type": {
- "enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
- ],
- "enum": [
- "PASTE_NORMAL",
- "PASTE_VALUES",
- "PASTE_FORMAT",
- "PASTE_NO_BORDERS",
- "PASTE_FORMULA",
- "PASTE_DATA_VALIDATION",
- "PASTE_CONDITIONAL_FORMATTING"
- ],
- "description": "How the data should be pasted.",
- "type": "string"
- },
- "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": {
- "description": "Appends rows or columns to the end of a sheet.",
- "type": "object",
- "properties": {
- "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"
- },
- "dimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "Whether rows or columns should be appended.",
- "type": "string"
- }
- },
- "id": "AppendDimensionRequest"
- },
- "AddNamedRangeRequest": {
- "description": "Adds a named range to the spreadsheet.",
- "type": "object",
- "properties": {
- "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.)",
- "$ref": "NamedRange"
- }
- },
- "id": "AddNamedRangeRequest"
- },
- "CreateDeveloperMetadataResponse": {
- "description": "The response from creating developer metadata.",
- "type": "object",
- "properties": {
- "developerMetadata": {
- "description": "The developer metadata that was created.",
- "$ref": "DeveloperMetadata"
- }
- },
- "id": "CreateDeveloperMetadataResponse"
- },
- "UpdateEmbeddedObjectPositionRequest": {
- "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": {
- "angle": {
- "description": "The angle between the standard orientation and the desired orientation.\nMeasured in degrees. Valid values are between -90 and 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNote: For LTR text direction positive angles are in the counterclockwise\ndirection, whereas for RTL they are in the clockwise direction",
- "format": "int32",
- "type": "integer"
- },
- "vertical": {
- "description": "If true, text reads top to bottom, but the orientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |",
- "type": "boolean"
- }
- },
- "id": "TextRotation"
- },
- "PieChartSpec": {
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.",
- "type": "object",
- "properties": {
- "series": {
- "$ref": "ChartData",
- "description": "The data that covers the one and only series of the pie chart."
- },
- "legendPosition": {
- "description": "Where the legend of the pie chart should be drawn.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The legend is rendered on the bottom of the chart.",
- "The legend is rendered on the left of the chart.",
- "The legend is rendered on the right of the chart.",
- "The legend is rendered on the top of the chart.",
- "No legend is rendered.",
- "Each pie slice has a label attached to it."
- ],
- "enum": [
- "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND",
- "LABELED_LEGEND"
- ]
- },
- "pieHole": {
- "description": "The size of the hole in the pie chart.",
- "format": "double",
- "type": "number"
- },
- "domain": {
- "$ref": "ChartData",
- "description": "The data that covers the domain of the pie chart."
- },
- "threeDimensional": {
- "description": "True if the pie is three dimensional.",
- "type": "boolean"
- }
- },
- "id": "PieChartSpec"
- },
- "UpdateDeveloperMetadataRequest": {
- "description": "A request to update properties of developer metadata.\nUpdates the properties of the developer metadata selected by the filters to\nthe values provided in the DeveloperMetadata resource. Callers must\nspecify the properties they wish to update in the fields parameter, as well\nas specify at least one DataFilter matching the metadata they wish to\nupdate.",
- "type": "object",
- "properties": {
- "dataFilters": {
- "description": "The filters matching the developer metadata entries to update.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `developerMetadata` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "developerMetadata": {
- "$ref": "DeveloperMetadata",
- "description": "The value that all metadata matched by the data filters will be updated to."
- }
- },
- "id": "UpdateDeveloperMetadataRequest"
- },
- "WaterfallChartColumnStyle": {
- "description": "Styles for a waterfall chart column.",
- "type": "object",
- "properties": {
- "label": {
- "description": "The label of the column's legend.",
- "type": "string"
- },
- "color": {
- "$ref": "Color",
- "description": "The color of the column."
- }
- },
- "id": "WaterfallChartColumnStyle"
- },
- "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"
- }
- },
- "id": "UpdateFilterViewRequest"
- },
- "ConditionalFormatRule": {
- "description": "A rule describing a conditional format.",
- "type": "object",
- "properties": {
- "booleanRule": {
- "$ref": "BooleanRule",
- "description": "The formatting is either \"on\" or \"off\" according to the rule."
- },
- "ranges": {
- "description": "The ranges that will be formatted if the condition is true.\nAll the ranges must be on the same grid.",
- "type": "array",
- "items": {
- "$ref": "GridRange"
- }
- },
- "gradientRule": {
- "$ref": "GradientRule",
- "description": "The formatting will vary based on the gradients in 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": {
- "$ref": "GridRange",
- "description": "The location to paste to. If the range covers a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of the destination range)."
- },
- "pasteOrientation": {
- "enumDescriptions": [
- "Paste normally.",
- "Paste transposed, where all rows become columns and vice versa."
- ],
- "enum": [
- "NORMAL",
- "TRANSPOSE"
- ],
- "description": "How that data should be oriented when pasting.",
- "type": "string"
- }
- },
- "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": {
- "enumDescriptions": [
- "The default value, do not use.",
- "The cell's value must be greater than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be greater than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be less than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be less than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be not equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
- "The cell's value must not be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
- "The cell's value must contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must not contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must start with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must end with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be exactly the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be a valid email address.\nSupported by data validation.\nRequires no ConditionValues.",
- "The cell's value must be a valid URL.\nSupported by data validation.\nRequires no ConditionValues.",
- "The cell's value must be the same date as the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be before the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be after the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be on or before the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be on or after the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be between the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
- "The cell's value must be outside the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
- "The cell's value must be a date.\nSupported by data validation.\nRequires no ConditionValues.",
- "The cell's value must be listed in the grid in condition value's range.\nSupported by data validation.\nRequires a single ConditionValue,\nand the value must be a valid range in A1 notation.",
- "The cell's value must in the list of condition values.\nSupported by data validation.\nSupports any number of condition values,\none per item in the list.\nFormulas are not supported in the values.",
- "The cell's value must be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
- "The cell's value must not be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
- "The condition's formula must evaluate to true.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue."
- ],
- "enum": [
- "CONDITION_TYPE_UNSPECIFIED",
- "NUMBER_GREATER",
- "NUMBER_GREATER_THAN_EQ",
- "NUMBER_LESS",
- "NUMBER_LESS_THAN_EQ",
- "NUMBER_EQ",
- "NUMBER_NOT_EQ",
- "NUMBER_BETWEEN",
- "NUMBER_NOT_BETWEEN",
- "TEXT_CONTAINS",
- "TEXT_NOT_CONTAINS",
- "TEXT_STARTS_WITH",
- "TEXT_ENDS_WITH",
- "TEXT_EQ",
- "TEXT_IS_EMAIL",
- "TEXT_IS_URL",
- "DATE_EQ",
- "DATE_BEFORE",
- "DATE_AFTER",
- "DATE_ON_OR_BEFORE",
- "DATE_ON_OR_AFTER",
- "DATE_BETWEEN",
- "DATE_NOT_BETWEEN",
- "DATE_IS_VALID",
- "ONE_OF_RANGE",
- "ONE_OF_LIST",
- "BLANK",
- "NOT_BLANK",
- "CUSTOM_FORMULA"
- ],
- "description": "The type of condition.",
- "type": "string"
- },
- "values": {
- "description": "The values of the condition. The number of supported values depends\non the condition type. Some support zero values,\nothers one or two values,\nand ConditionType.ONE_OF_LIST supports an arbitrary number of values.",
- "type": "array",
- "items": {
- "$ref": "ConditionValue"
- }
- }
- },
- "id": "BooleanCondition"
- },
- "Request": {
- "description": "A single kind of update to apply to a spreadsheet.",
- "type": "object",
- "properties": {
- "setBasicFilter": {
- "$ref": "SetBasicFilterRequest",
- "description": "Sets the basic filter on a sheet."
- },
- "addConditionalFormatRule": {
- "$ref": "AddConditionalFormatRuleRequest",
- "description": "Adds a new conditional format rule."
- },
- "addNamedRange": {
- "description": "Adds a named range.",
- "$ref": "AddNamedRangeRequest"
- },
- "updateCells": {
- "$ref": "UpdateCellsRequest",
- "description": "Updates many cells at once."
- },
- "updateSpreadsheetProperties": {
- "description": "Updates the spreadsheet's properties.",
- "$ref": "UpdateSpreadsheetPropertiesRequest"
- },
- "deleteEmbeddedObject": {
- "$ref": "DeleteEmbeddedObjectRequest",
- "description": "Deletes an embedded object (e.g, chart, image) in a sheet."
- },
- "updateFilterView": {
- "$ref": "UpdateFilterViewRequest",
- "description": "Updates the properties of a filter view."
- },
- "addBanding": {
- "$ref": "AddBandingRequest",
- "description": "Adds a new banded range"
- },
- "autoResizeDimensions": {
- "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
- "$ref": "AutoResizeDimensionsRequest"
- },
- "appendCells": {
- "$ref": "AppendCellsRequest",
- "description": "Appends cells after the last row with data in a sheet."
- },
- "cutPaste": {
- "description": "Cuts data from one area and pastes it to another.",
- "$ref": "CutPasteRequest"
- },
- "mergeCells": {
- "$ref": "MergeCellsRequest",
- "description": "Merges cells together."
- },
- "updateNamedRange": {
- "description": "Updates a named range.",
- "$ref": "UpdateNamedRangeRequest"
- },
- "updateSheetProperties": {
- "description": "Updates a sheet's properties.",
- "$ref": "UpdateSheetPropertiesRequest"
- },
- "deleteDimension": {
- "description": "Deletes rows or columns in a sheet.",
- "$ref": "DeleteDimensionRequest"
- },
- "autoFill": {
- "description": "Automatically fills in more data based on existing data.",
- "$ref": "AutoFillRequest"
- },
- "sortRange": {
- "$ref": "SortRangeRequest",
- "description": "Sorts data in a range."
- },
- "deleteProtectedRange": {
- "description": "Deletes a protected range.",
- "$ref": "DeleteProtectedRangeRequest"
- },
- "duplicateFilterView": {
- "description": "Duplicates a filter view.",
- "$ref": "DuplicateFilterViewRequest"
- },
- "addChart": {
- "description": "Adds a chart.",
- "$ref": "AddChartRequest"
- },
- "findReplace": {
- "$ref": "FindReplaceRequest",
- "description": "Finds and replaces occurrences of some text with other text."
- },
- "updateChartSpec": {
- "description": "Updates a chart's specifications.",
- "$ref": "UpdateChartSpecRequest"
- },
- "textToColumns": {
- "description": "Converts a column of text into many columns of text.",
- "$ref": "TextToColumnsRequest"
- },
- "updateProtectedRange": {
- "description": "Updates a protected range.",
- "$ref": "UpdateProtectedRangeRequest"
- },
- "addSheet": {
- "description": "Adds a sheet.",
- "$ref": "AddSheetRequest"
- },
- "copyPaste": {
- "$ref": "CopyPasteRequest",
- "description": "Copies data from one area and pastes it to another."
- },
- "deleteFilterView": {
- "$ref": "DeleteFilterViewRequest",
- "description": "Deletes a filter view from a sheet."
- },
- "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": {
- "description": "Adds a filter view.",
- "$ref": "AddFilterViewRequest"
- },
- "updateBorders": {
- "description": "Updates the borders in a range of cells.",
- "$ref": "UpdateBordersRequest"
- },
- "setDataValidation": {
- "description": "Sets data validation for one or more cells.",
- "$ref": "SetDataValidationRequest"
- },
- "deleteConditionalFormatRule": {
- "$ref": "DeleteConditionalFormatRuleRequest",
- "description": "Deletes an existing conditional format rule."
- },
- "clearBasicFilter": {
- "description": "Clears the basic filter on a sheet.",
- "$ref": "ClearBasicFilterRequest"
- },
- "repeatCell": {
- "description": "Repeats a single cell across a range.",
- "$ref": "RepeatCellRequest"
- },
- "appendDimension": {
- "description": "Appends dimensions to the end of a sheet.",
- "$ref": "AppendDimensionRequest"
- },
- "createDeveloperMetadata": {
- "description": "Creates new developer metadata",
- "$ref": "CreateDeveloperMetadataRequest"
- },
- "updateConditionalFormatRule": {
- "description": "Updates an existing conditional format rule.",
- "$ref": "UpdateConditionalFormatRuleRequest"
- },
- "insertRange": {
- "$ref": "InsertRangeRequest",
- "description": "Inserts new cells in a sheet, shifting the existing cells."
- },
- "deleteDeveloperMetadata": {
- "$ref": "DeleteDeveloperMetadataRequest",
- "description": "Deletes developer metadata"
- },
- "moveDimension": {
- "description": "Moves rows or columns to another location in a sheet.",
- "$ref": "MoveDimensionRequest"
- },
- "randomizeRange": {
- "description": "Randomizes the order of the rows in a range.",
- "$ref": "RandomizeRangeRequest"
- },
- "updateBanding": {
- "$ref": "UpdateBandingRequest",
- "description": "Updates a banded range"
- },
- "deleteNamedRange": {
- "$ref": "DeleteNamedRangeRequest",
- "description": "Deletes a named range."
- },
- "addProtectedRange": {
- "$ref": "AddProtectedRangeRequest",
- "description": "Adds a protected range."
- },
- "duplicateSheet": {
- "description": "Duplicates a sheet.",
- "$ref": "DuplicateSheetRequest"
- },
- "unmergeCells": {
- "description": "Unmerges merged cells.",
- "$ref": "UnmergeCellsRequest"
- },
- "deleteSheet": {
- "description": "Deletes a sheet.",
- "$ref": "DeleteSheetRequest"
- },
- "updateEmbeddedObjectPosition": {
- "$ref": "UpdateEmbeddedObjectPositionRequest",
- "description": "Updates an embedded object's (e.g. chart, image) position."
- },
- "updateDeveloperMetadata": {
- "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."
- }
- },
- "id": "Request"
- },
- "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"
- },
- "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": {
- "endRowIndex": {
- "description": "The end row (exclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "endColumnIndex": {
- "description": "The end column (exclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "startRowIndex": {
- "description": "The start row (inclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "startColumnIndex": {
- "description": "The start column (inclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "description": "The sheet this range is on.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GridRange"
- },
"BasicChartSpec": {
+ "id": "BasicChartSpec",
"description": "The specification for a basic chart. See BasicChartType for the list\nof charts this supports.",
"type": "object",
"properties": {
@@ -4451,10 +123,10 @@
"description": "True to make the chart 3D.\nApplies to Bar and Column charts.",
"type": "boolean"
}
- },
- "id": "BasicChartSpec"
+ }
},
"BubbleChartSpec": {
+ "id": "BubbleChartSpec",
"description": "A \u003ca href=\"/chart/interactive/docs/gallery/bubblechart\"\u003ebubble chart\u003c/a\u003e.",
"type": "object",
"properties": {
@@ -4464,12 +136,10 @@
"type": "integer"
},
"series": {
- "description": "The data contianing the bubble y-values. These values locate the bubbles\nin the chart vertically.",
- "$ref": "ChartData"
+ "$ref": "ChartData",
+ "description": "The data contianing the bubble y-values. These values locate the bubbles\nin the chart vertically."
},
"legendPosition": {
- "description": "Where the legend of the chart should be drawn.",
- "type": "string",
"enumDescriptions": [
"Default value, do not use.",
"The legend is rendered on the bottom of the chart.",
@@ -4487,32 +157,34 @@
"TOP_LEGEND",
"NO_LEGEND",
"INSIDE_LEGEND"
- ]
+ ],
+ "description": "Where the legend of the chart should be drawn.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally.",
+ "$ref": "ChartData"
+ },
+ "bubbleSizes": {
+ "description": "The data contianing the bubble sizes. Bubble sizes are used to draw\nthe bubbles at different sizes relative to each other.\nIf specified, group_ids must also be specified. This field is\noptional.",
+ "$ref": "ChartData"
},
"bubbleOpacity": {
"description": "The opacity of the bubbles between 0 and 1.0.\n0 is fully transparent and 1 is fully opaque.",
"format": "float",
"type": "number"
},
- "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"
- },
- "domain": {
- "$ref": "ChartData",
- "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally."
+ "bubbleBorderColor": {
+ "description": "The bubble border color.",
+ "$ref": "Color"
},
"bubbleTextStyle": {
- "description": "The format of the text inside the bubbles.\nUnderline and Strikethrough are not supported.",
- "$ref": "TextFormat"
- },
- "bubbleBorderColor": {
- "$ref": "Color",
- "description": "The bubble border color."
+ "$ref": "TextFormat",
+ "description": "The format of the text inside the bubbles.\nUnderline and Strikethrough are not supported."
},
"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."
+ "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",
@@ -4523,10 +195,10 @@
"format": "int32",
"type": "integer"
}
- },
- "id": "BubbleChartSpec"
+ }
},
"SetDataValidationRequest": {
+ "id": "SetDataValidationRequest",
"description": "Sets a data validation rule to every cell in the range.\nTo clear validation in a range, call this with no rule specified.",
"type": "object",
"properties": {
@@ -4538,13 +210,17 @@
"$ref": "GridRange",
"description": "The range the data validation rule should apply to."
}
- },
- "id": "SetDataValidationRequest"
+ }
},
"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": {
"description": "A pivot table anchored at this cell. The size of pivot table itself\nis computed dynamically based on its data, grouping, filters, values,\netc. Only the top-left cell of the pivot table contains the pivot table\ndefinition. The other cells will contain the calculated values of the\nresults of the pivot in their effective_value fields.",
"$ref": "PivotTable"
@@ -4554,8 +230,8 @@
"description": "The format the user entered for the cell.\n\nWhen writing, the new format will be merged with the existing format."
},
"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"
+ "$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."
},
"note": {
"description": "Any note on the cell.",
@@ -4583,15 +259,69 @@
"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"
}
- },
- "id": "CellData"
+ }
+ },
+ "BatchUpdateValuesByDataFilterRequest": {
+ "id": "BatchUpdateValuesByDataFilterRequest",
+ "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": {
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "enumDescriptions": [
+ "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
+ "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
+ "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
+ ],
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ]
+ },
+ "includeValuesInResponse": {
+ "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
+ "type": "boolean"
+ },
+ "valueInputOption": {
+ "enumDescriptions": [
+ "Default input value. This value must not be used.",
+ "The values the user has entered will not be parsed and will be stored\nas-is.",
+ "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
+ ],
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
+ ],
+ "description": "How the input data should be interpreted.",
+ "type": "string"
+ },
+ "data": {
+ "description": "The new values to apply to the spreadsheet. If more than one range is\nmatched by the specified DataFilter the specified values will be\napplied to all of those ranges.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilterValueRange"
+ }
+ }
+ }
},
"TextPosition": {
+ "id": "TextPosition",
"description": "Position settings for text.",
"type": "object",
"properties": {
@@ -4611,68 +341,10 @@
"RIGHT"
]
}
- },
- "id": "TextPosition"
- },
- "BatchUpdateValuesByDataFilterRequest": {
- "description": "The request for updating more than one range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "responseValueRenderOption": {
- "enumDescriptions": [
- "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
- "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
- "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
- ],
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string"
- },
- "includeValuesInResponse": {
- "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
- "type": "boolean"
- },
- "valueInputOption": {
- "description": "How the input data should be interpreted.",
- "type": "string",
- "enumDescriptions": [
- "Default input value. This value must not be used.",
- "The values the user has entered will not be parsed and will be stored\nas-is.",
- "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
- ],
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ]
- },
- "data": {
- "description": "The new values to apply to the spreadsheet. If more than one range is\nmatched by the specified DataFilter the specified values will be\napplied to all of those ranges.",
- "type": "array",
- "items": {
- "$ref": "DataFilterValueRange"
- }
- },
- "responseDateTimeRenderOption": {
- "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"
- ]
- }
- },
- "id": "BatchUpdateValuesByDataFilterRequest"
+ }
},
"BatchUpdateSpreadsheetRequest": {
+ "id": "BatchUpdateSpreadsheetRequest",
"description": "The request for updating any aspect of a spreadsheet.",
"type": "object",
"properties": {
@@ -4698,18 +370,15 @@
"$ref": "Request"
}
}
- },
- "id": "BatchUpdateSpreadsheetRequest"
+ }
},
"BasicChartAxis": {
"description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.",
"type": "object",
"properties": {
- "format": {
- "$ref": "TextFormat",
- "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
- },
"position": {
+ "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.",
@@ -4721,9 +390,7 @@
"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.",
@@ -4732,6 +399,10 @@
"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"
@@ -4764,6 +435,7 @@
"id": "Padding"
},
"DeleteDimensionRequest": {
+ "id": "DeleteDimensionRequest",
"description": "Deletes the dimensions from the sheet.",
"type": "object",
"properties": {
@@ -4771,10 +443,10 @@
"description": "The dimensions to delete from the sheet.",
"$ref": "DimensionRange"
}
- },
- "id": "DeleteDimensionRequest"
+ }
},
"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": {
@@ -4787,8 +459,7 @@
"$ref": "ChartSpec",
"description": "The specification to apply to the chart."
}
- },
- "id": "UpdateChartSpecRequest"
+ }
},
"DeleteFilterViewRequest": {
"description": "Deletes a particular filter view.",
@@ -4801,20 +472,4342 @@
}
},
"id": "DeleteFilterViewRequest"
+ },
+ "BatchGetValuesByDataFilterRequest": {
+ "description": "The request for retrieving a range of values in a spreadsheet selected by a\nset of DataFilters.",
+ "type": "object",
+ "properties": {
+ "majorDimension": {
+ "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen a request that selects that range and sets `majorDimension=ROWS` will\nreturn `[[1,2],[3,4]]`,\nwhereas a request that sets `majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ]
+ },
+ "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": {
+ "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "enumDescriptions": [
+ "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
+ "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
+ "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
+ ],
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ]
+ },
+ "dateTimeRenderOption": {
+ "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": "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"
+ }
+ },
+ "id": "BatchGetValuesByDataFilterRequest"
+ },
+ "DeleteDeveloperMetadataResponse": {
+ "id": "DeleteDeveloperMetadataResponse",
+ "description": "The response from deleting developer metadata.",
+ "type": "object",
+ "properties": {
+ "deletedDeveloperMetadata": {
+ "description": "The metadata that was deleted.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ }
+ }
+ },
+ "BatchUpdateValuesResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "totalUpdatedCells": {
+ "description": "The total number of cells updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalUpdatedColumns": {
+ "description": "The total number of columns where at least one cell in the column was\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "totalUpdatedRows": {
+ "description": "The total number of rows where at least one cell in the row was updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "responses": {
+ "description": "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"
+ }
+ },
+ "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"
+ },
+ "MergeCellsRequest": {
+ "id": "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."
+ }
+ }
+ },
+ "MatchedDeveloperMetadata": {
+ "description": "A developer metadata entry and the data filters specified in the original\nrequest that matched it.",
+ "type": "object",
+ "properties": {
+ "dataFilters": {
+ "description": "All filters matching the returned developer metadata.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ }
+ },
+ "developerMetadata": {
+ "description": "The developer metadata matching the specified filters.",
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "id": "MatchedDeveloperMetadata"
+ },
+ "AddProtectedRangeRequest": {
+ "id": "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.)"
+ }
+ }
+ },
+ "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": {
+ "id": "DeveloperMetadata",
+ "description": "Developer metadata associated with a location or object in a spreadsheet.\nDeveloper metadata may be used to associate arbitrary data with various\nparts of a spreadsheet and will remain associated at those locations as they\nmove around and the spreadsheet is edited. For example, if developer\nmetadata is associated with row 5 and another row is then subsequently\ninserted above row 5, that original metadata will still be associated with\nthe row it was first associated with (what is now row 6). If the associated\nobject is deleted its metadata will be deleted too.",
+ "type": "object",
+ "properties": {
+ "metadataKey": {
+ "description": "The metadata key. There may be multiple metadata in a spreadsheet with the\nsame key. Developer metadata must always have a key specified.",
+ "type": "string"
+ },
+ "metadataId": {
+ "description": "The spreadsheet-scoped unique ID that identifies the metadata. IDs may be\nspecified when metadata is created, otherwise one will be randomly\ngenerated and assigned. Must be positive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "location": {
+ "description": "The location where the metadata is associated.",
+ "$ref": "DeveloperMetadataLocation"
+ },
+ "visibility": {
+ "enumDescriptions": [
+ "Default value.",
+ "Document-visible metadata is accessible from any developer project with\naccess to the document.",
+ "Project-visible metadata is only visible to and accessible by the developer\nproject that created the metadata."
+ ],
+ "enum": [
+ "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
+ "DOCUMENT",
+ "PROJECT"
+ ],
+ "description": "The metadata visibility. Developer metadata must always have a visibility\nspecified.",
+ "type": "string"
+ },
+ "metadataValue": {
+ "description": "Data associated with the metadata's key.",
+ "type": "string"
+ }
+ }
+ },
+ "DuplicateSheetResponse": {
+ "id": "DuplicateSheetResponse",
+ "description": "The result of duplicating a sheet.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "The properties of the duplicate sheet.",
+ "$ref": "SheetProperties"
+ }
+ }
+ },
+ "TextToColumnsRequest": {
+ "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "GridRange",
+ "description": "The source data range. This must span exactly one column."
+ },
+ "delimiterType": {
+ "description": "The delimiter type to use.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "\",\"",
+ "\";\"",
+ "\".\"",
+ "\" \"",
+ "A custom value as defined in delimiter.",
+ "Automatically detect columns."
+ ],
+ "enum": [
+ "DELIMITER_TYPE_UNSPECIFIED",
+ "COMMA",
+ "SEMICOLON",
+ "PERIOD",
+ "SPACE",
+ "CUSTOM",
+ "AUTODETECT"
+ ]
+ },
+ "delimiter": {
+ "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
+ "type": "string"
+ }
+ },
+ "id": "TextToColumnsRequest"
+ },
+ "ClearBasicFilterRequest": {
+ "id": "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"
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ }
+ },
+ "id": "BatchUpdateSpreadsheetResponse"
+ },
+ "AppendValuesResponse": {
+ "id": "AppendValuesResponse",
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ },
+ "PivotFilterCriteria": {
+ "id": "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"
+ }
+ }
+ }
+ },
+ "AddFilterViewRequest": {
+ "id": "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.)"
+ }
+ }
+ },
+ "MoveDimensionRequest": {
+ "description": "Moves one or more rows or columns.",
+ "type": "object",
+ "properties": {
+ "destinationIndex": {
+ "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1..3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5).\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "source": {
+ "description": "The source dimensions to move.",
+ "$ref": "DimensionRange"
+ }
+ },
+ "id": "MoveDimensionRequest"
+ },
+ "AddConditionalFormatRuleRequest": {
+ "id": "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"
+ }
+ }
+ },
+ "ChartSpec": {
+ "id": "ChartSpec",
+ "description": "The specifications of a chart.",
+ "type": "object",
+ "properties": {
+ "waterfallChart": {
+ "description": "A waterfall chart specification.",
+ "$ref": "WaterfallChartSpec"
+ },
+ "fontName": {
+ "description": "The name of the font to use by default for all chart text (e.g. title,\naxis labels, legend). If a font is specified for a specific part of the\nchart it will override this font name.",
+ "type": "string"
+ },
+ "maximized": {
+ "description": "True to make a chart fill the entire space in which it's rendered with\nminimum padding. False to use the default padding.\n(Not applicable to Geo and Org charts.)",
+ "type": "boolean"
+ },
+ "hiddenDimensionStrategy": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Charts will skip hidden rows and columns.",
+ "Charts will skip hidden rows only.",
+ "Charts will skip hidden columns only.",
+ "Charts will not skip any hidden rows or columns."
+ ],
+ "enum": [
+ "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
+ "SKIP_HIDDEN_ROWS_AND_COLUMNS",
+ "SKIP_HIDDEN_ROWS",
+ "SKIP_HIDDEN_COLUMNS",
+ "SHOW_ALL"
+ ],
+ "description": "Determines how the charts will use hidden rows or columns.",
+ "type": "string"
+ },
+ "subtitleTextFormat": {
+ "description": "The subtitle text format.\nStrikethrough and underline are not supported.",
+ "$ref": "TextFormat"
+ },
+ "subtitle": {
+ "description": "The subtitle of the chart.",
+ "type": "string"
+ },
+ "backgroundColor": {
+ "description": "The background color of the entire chart.\nNot applicable to Org charts.",
+ "$ref": "Color"
+ },
+ "subtitleTextPosition": {
+ "$ref": "TextPosition",
+ "description": "The subtitle text position.\nThis field is optional."
+ },
+ "basicChart": {
+ "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports.",
+ "$ref": "BasicChartSpec"
+ },
+ "orgChart": {
+ "description": "An org chart specification.",
+ "$ref": "OrgChartSpec"
+ },
+ "pieChart": {
+ "description": "A pie chart specification.",
+ "$ref": "PieChartSpec"
+ },
+ "titleTextFormat": {
+ "$ref": "TextFormat",
+ "description": "The title text format.\nStrikethrough and underline are not supported."
+ },
+ "title": {
+ "description": "The title of the chart.",
+ "type": "string"
+ },
+ "altText": {
+ "description": "The alternative text that describes the chart. This is often used\nfor accessibility.",
+ "type": "string"
+ },
+ "titleTextPosition": {
+ "description": "The title text position.\nThis field is optional.",
+ "$ref": "TextPosition"
+ },
+ "histogramChart": {
+ "description": "A histogram chart specification.",
+ "$ref": "HistogramChartSpec"
+ },
+ "candlestickChart": {
+ "$ref": "CandlestickChartSpec",
+ "description": "A candlestick chart specification."
+ },
+ "bubbleChart": {
+ "$ref": "BubbleChartSpec",
+ "description": "A bubble chart specification."
+ }
+ }
+ },
+ "CreateDeveloperMetadataRequest": {
+ "description": "A request to create developer metadata.",
+ "type": "object",
+ "properties": {
+ "developerMetadata": {
+ "description": "The developer metadata to create.",
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "id": "CreateDeveloperMetadataRequest"
+ },
+ "BatchGetValuesByDataFilterResponse": {
+ "id": "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"
+ }
+ }
+ }
+ },
+ "LineStyle": {
+ "description": "Properties that describe the style of a line.",
+ "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"
+ },
+ "DataFilterValueRange": {
+ "id": "DataFilterValueRange",
+ "description": "A range of values whose location is specified by a DataFilter.",
+ "type": "object",
+ "properties": {
+ "majorDimension": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The major dimension of the values.",
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ },
+ "dataFilter": {
+ "$ref": "DataFilter",
+ "description": "The data filter describing the location of the values in the spreadsheet."
+ }
+ }
+ },
+ "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"
+ },
+ "CandlestickDomain": {
+ "description": "The domain of a CandlestickChart.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "ChartData",
+ "description": "The data of the CandlestickDomain."
+ },
+ "reversed": {
+ "description": "True to reverse the order of the domain values (horizontal axis).",
+ "type": "boolean"
+ }
+ },
+ "id": "CandlestickDomain"
+ },
+ "SheetProperties": {
+ "id": "SheetProperties",
+ "description": "Properties of a sheet.",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "The name of the sheet.",
+ "type": "string"
+ },
+ "tabColor": {
+ "description": "The color of the tab in the UI.",
+ "$ref": "Color"
+ },
+ "index": {
+ "description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet will be added or moved to the end\nof the sheet list. When updating sheet indices or inserting\nsheets, movement is considered in \"before the move\" indexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ahead of S2 the index would have to be set to 2. A sheet\nindex update request will be ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The ID of the sheet. Must be non-negative.\nThis field cannot be changed once set.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rightToLeft": {
+ "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
+ "type": "boolean"
+ },
+ "hidden": {
+ "description": "True if the sheet is hidden in the UI, false if it's visible.",
+ "type": "boolean"
+ },
+ "gridProperties": {
+ "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets.",
+ "$ref": "GridProperties"
+ },
+ "sheetType": {
+ "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": {
+ "id": "UpdateDimensionPropertiesRequest",
+ "description": "Updates properties of dimensions within the specified range.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "description": "The rows or columns to update.",
+ "$ref": "DimensionRange"
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "DimensionProperties",
+ "description": "Properties to update."
+ }
+ }
+ },
+ "SourceAndDestination": {
+ "description": "A combination of a source range and how to extend that source.",
+ "type": "object",
+ "properties": {
+ "dimension": {
+ "description": "The dimension that data should be filled into.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ]
+ },
+ "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."
+ }
+ },
+ "id": "SourceAndDestination"
+ },
+ "OrgChartSpec": {
+ "description": "An \u003ca href=\"/chart/interactive/docs/gallery/orgchart\"\u003eorg chart\u003c/a\u003e.\nOrg charts require a unique set of labels in labels and may\noptionally include parent_labels and tooltips.\nparent_labels contain, for each node, the label identifying the parent\nnode. tooltips contain, for each node, an optional tooltip.\n\nFor example, to describe an OrgChart with Alice as the CEO, Bob as the\nPresident (reporting to Alice) and Cathy as VP of Sales (also reporting to\nAlice), have labels contain \"Alice\", \"Bob\", \"Cathy\",\nparent_labels contain \"\", \"Alice\", \"Alice\" and tooltips contain\n\"CEO\", \"President\", \"VP Sales\".",
+ "type": "object",
+ "properties": {
+ "parentLabels": {
+ "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional.",
+ "$ref": "ChartData"
+ },
+ "nodeSize": {
+ "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."
+ ],
+ "enum": [
+ "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
+ "SMALL",
+ "MEDIUM",
+ "LARGE"
+ ]
+ },
+ "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."
+ },
+ "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."
+ }
+ },
+ "id": "OrgChartSpec"
+ },
+ "FilterView": {
+ "id": "FilterView",
+ "description": "A filter view.",
+ "type": "object",
+ "properties": {
+ "criteria": {
+ "additionalProperties": {
+ "$ref": "FilterCriteria"
+ },
+ "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
+ "type": "object"
+ },
+ "title": {
+ "description": "The name of the filter view.",
+ "type": "string"
+ },
+ "range": {
+ "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "$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"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "SearchDeveloperMetadataRequest": {
+ "id": "SearchDeveloperMetadataRequest",
+ "description": "A request to retrieve all developer metadata matching the set of specified\ncriteria.",
+ "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"
+ }
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "firstBandColor": {
+ "$ref": "Color",
+ "description": "The first color that is alternating. (Required)"
+ },
+ "secondBandColor": {
+ "$ref": "Color",
+ "description": "The second color that is alternating. (Required)"
+ },
+ "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."
+ }
+ }
+ },
+ "CandlestickSeries": {
+ "id": "CandlestickSeries",
+ "description": "The series of a CandlestickData.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "The data of the CandlestickSeries.",
+ "$ref": "ChartData"
+ }
+ }
+ },
+ "BasicFilter": {
+ "description": "The default filter associated with a sheet.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "$ref": "GridRange",
+ "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"
+ }
+ },
+ "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": "BasicFilter"
+ },
+ "AddProtectedRangeResponse": {
+ "id": "AddProtectedRangeResponse",
+ "description": "The result of adding a new protected range.",
+ "type": "object",
+ "properties": {
+ "protectedRange": {
+ "description": "The newly added protected range.",
+ "$ref": "ProtectedRange"
+ }
+ }
+ },
+ "HistogramChartSpec": {
+ "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.",
+ "type": "object",
+ "properties": {
+ "bucketSize": {
+ "description": "By default the bucket size (the range of values stacked in a single\ncolumn) is chosen automatically, but it may be overridden here.\nE.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.\nCannot be negative.\nThis field is optional.",
+ "format": "double",
+ "type": "number"
+ },
+ "outlierPercentile": {
+ "description": "The outlier percentile is used to ensure that outliers do not adversely\naffect the calculation of bucket sizes. For example, setting an outlier\npercentile of 0.05 indicates that the top and bottom 5% of values when\ncalculating buckets. The values are still included in the chart, they will\nbe added to the first or last buckets instead of their own buckets.\nMust be between 0.0 and 0.5.",
+ "format": "double",
+ "type": "number"
+ },
+ "showItemDividers": {
+ "description": "Whether horizontal divider lines should be displayed between items in each\ncolumn.",
+ "type": "boolean"
+ },
+ "series": {
+ "description": "The series for a histogram may be either a single series of values to be\nbucketed or multiple series, each of the same length, containing the name\nof the series followed by the values to be bucketed for that series.",
+ "type": "array",
+ "items": {
+ "$ref": "HistogramSeries"
+ }
+ },
+ "legendPosition": {
+ "description": "The position of the chart legend.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered.",
+ "The legend is rendered inside the chart area."
+ ],
+ "enum": [
+ "HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND",
+ "INSIDE_LEGEND"
+ ]
+ }
+ }
+ },
+ "UpdateValuesResponse": {
+ "id": "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",
+ "type": "integer"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "updatedRange": {
+ "description": "The range (in A1 notation) that updates were applied to.",
+ "type": "string"
+ },
+ "updatedCells": {
+ "description": "The number of cells updated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "ErrorValue": {
+ "id": "ErrorValue",
+ "description": "An error in a cell.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of error.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default error type, do not use this.",
+ "Corresponds to the `#ERROR!` error.",
+ "Corresponds to the `#NULL!` error.",
+ "Corresponds to the `#DIV/0` error.",
+ "Corresponds to the `#VALUE!` error.",
+ "Corresponds to the `#REF!` error.",
+ "Corresponds to the `#NAME?` error.",
+ "Corresponds to the `#NUM`! error.",
+ "Corresponds to the `#N/A` error.",
+ "Corresponds to the `Loading...` state."
+ ],
+ "enum": [
+ "ERROR_TYPE_UNSPECIFIED",
+ "ERROR",
+ "NULL_VALUE",
+ "DIVIDE_BY_ZERO",
+ "VALUE",
+ "REF",
+ "NAME",
+ "NUM",
+ "N_A",
+ "LOADING"
+ ]
+ },
+ "message": {
+ "description": "A message with more information about the error\n(in the spreadsheet's locale).",
+ "type": "string"
+ }
+ }
+ },
+ "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.",
+ "Corresponds to the `COUNTA` function.",
+ "Corresponds to the `COUNT` function.",
+ "Corresponds to the `COUNTUNIQUE` function.",
+ "Corresponds to the `AVERAGE` function.",
+ "Corresponds to the `MAX` function.",
+ "Corresponds to the `MIN` function.",
+ "Corresponds to the `MEDIAN` function.",
+ "Corresponds to the `PRODUCT` function.",
+ "Corresponds to the `STDEV` function.",
+ "Corresponds to the `STDEVP` function.",
+ "Corresponds to the `VAR` function.",
+ "Corresponds to the `VARP` function.",
+ "Indicates the formula should be used as-is.\nOnly valid if PivotValue.formula was set."
+ ],
+ "enum": [
+ "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED",
+ "SUM",
+ "COUNTA",
+ "COUNT",
+ "COUNTUNIQUE",
+ "AVERAGE",
+ "MAX",
+ "MIN",
+ "MEDIAN",
+ "PRODUCT",
+ "STDEV",
+ "STDEVP",
+ "VAR",
+ "VARP",
+ "CUSTOM"
+ ]
+ },
+ "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"
+ }
+ },
+ "id": "PivotValue"
+ },
+ "CopySheetToAnotherSpreadsheetRequest": {
+ "description": "The request to copy a sheet across spreadsheets.",
+ "type": "object",
+ "properties": {
+ "destinationSpreadsheetId": {
+ "description": "The ID of the spreadsheet to copy the sheet to.",
+ "type": "string"
+ }
+ },
+ "id": "CopySheetToAnotherSpreadsheetRequest"
+ },
+ "PivotGroupSortValueBucket": {
+ "description": "Information about which values in a pivot group should be used for sorting.",
+ "type": "object",
+ "properties": {
+ "valuesIndex": {
+ "description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "buckets": {
+ "description": "Determines the bucket from which values are chosen to sort.\n\nFor example, in a pivot table with one row group & two column groups,\nthe row group can list up to two values. The first value corresponds\nto a value within the first column group, and the second value\ncorresponds to a value in the second column group. If no values\nare listed, this would indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.",
+ "type": "array",
+ "items": {
+ "$ref": "ExtendedValue"
+ }
+ }
+ },
+ "id": "PivotGroupSortValueBucket"
+ },
+ "WaterfallChartSeries": {
+ "description": "A single series of data for a waterfall chart.",
+ "type": "object",
+ "properties": {
+ "positiveColumnsStyle": {
+ "description": "Styles for all columns in this series with positive values.",
+ "$ref": "WaterfallChartColumnStyle"
+ },
+ "data": {
+ "description": "The data being visualized in this series.",
+ "$ref": "ChartData"
+ },
+ "negativeColumnsStyle": {
+ "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"
+ },
+ "customSubtotals": {
+ "description": "Custom subtotal columns appearing in this series. The order in which\nsubtotals are defined is not significant. Only one subtotal may be\ndefined for each data point.",
+ "type": "array",
+ "items": {
+ "$ref": "WaterfallChartCustomSubtotal"
+ }
+ },
+ "subtotalColumnsStyle": {
+ "$ref": "WaterfallChartColumnStyle",
+ "description": "Styles for all subtotal columns in this series."
+ }
+ },
+ "id": "WaterfallChartSeries"
+ },
+ "DeleteDeveloperMetadataRequest": {
+ "id": "DeleteDeveloperMetadataRequest",
+ "description": "A request to delete developer metadata.",
+ "type": "object",
+ "properties": {
+ "dataFilter": {
+ "$ref": "DataFilter",
+ "description": "The data filter describing the criteria used to select which developer\nmetadata entry to delete."
+ }
+ }
+ },
+ "CandlestickChartSpec": {
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/candlestickchart\"\u003ecandlestick chart\u003c/a\u003e.",
+ "type": "object",
+ "properties": {
+ "domain": {
+ "$ref": "CandlestickDomain",
+ "description": "The domain data (horizontal axis) for the candlestick chart. String data\nwill be treated as discrete labels, other data will be treated as\ncontinuous values."
+ },
+ "data": {
+ "description": "The Candlestick chart data.\nOnly one CandlestickData is supported.",
+ "type": "array",
+ "items": {
+ "$ref": "CandlestickData"
+ }
+ }
+ },
+ "id": "CandlestickChartSpec"
+ },
+ "BatchClearValuesByDataFilterResponse": {
+ "description": "The response when clearing a range of values selected with\nDataFilters in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "clearedRanges": {
+ "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "BatchClearValuesByDataFilterResponse"
+ },
+ "CandlestickData": {
+ "description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "The range data (vertical axis) for the close/final value for each candle.\nThis is the top of the candle body. If greater than the open value the\ncandle will be filled. Otherwise the candle will be hollow.",
+ "$ref": "CandlestickSeries"
+ },
+ "openSeries": {
+ "description": "The range data (vertical axis) for the open/initial value for each\ncandle. This is the bottom of the candle body. If less than the close\nvalue the candle will be filled. Otherwise the candle will be hollow.",
+ "$ref": "CandlestickSeries"
+ },
+ "highSeries": {
+ "$ref": "CandlestickSeries",
+ "description": "The range data (vertical axis) for the high/maximum value for each\ncandle. This is the top of the candle's center line."
+ }
+ },
+ "id": "CandlestickData"
+ },
+ "EmbeddedObjectPosition": {
+ "description": "The position of an embedded object such as a chart.",
+ "type": "object",
+ "properties": {
+ "newSheet": {
+ "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.",
+ "type": "boolean"
+ },
+ "sheetId": {
+ "description": "The sheet this is on. Set only if the embedded object\nis on its own sheet. Must be non-negative.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "overlayPosition": {
+ "description": "The position at which the object is overlaid on top of a grid.",
+ "$ref": "OverlayPosition"
+ }
+ },
+ "id": "EmbeddedObjectPosition"
+ },
+ "DeleteProtectedRangeRequest": {
+ "description": "Deletes the protected range with the given ID.",
+ "type": "object",
+ "properties": {
+ "protectedRangeId": {
+ "description": "The ID of the protected range to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteProtectedRangeRequest"
+ },
+ "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": {
+ "metadataLocation": {
+ "$ref": "DeveloperMetadataLocation",
+ "description": "Limits the selected developer metadata to those entries associated with\nthe specified location. This field either matches exact locations or all\nintersecting locations according the specified\nlocationMatchingStrategy."
+ },
+ "locationMatchingStrategy": {
+ "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"
+ },
+ "metadataKey": {
+ "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_key.",
+ "type": "string"
+ },
+ "metadataId": {
+ "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "visibility": {
+ "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.visibility. If left unspecified, all developer\nmetadata visibile to the requesting project is considered.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value.",
+ "Document-visible metadata is accessible from any developer project with\naccess to the document.",
+ "Project-visible metadata is only visible to and accessible by the developer\nproject that created the metadata."
+ ],
+ "enum": [
+ "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
+ "DOCUMENT",
+ "PROJECT"
+ ]
+ },
+ "metadataValue": {
+ "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_value.",
+ "type": "string"
+ }
+ },
+ "id": "DeveloperMetadataLookup"
+ },
+ "AutoFillRequest": {
+ "description": "Fills in more data based on existing data.",
+ "type": "object",
+ "properties": {
+ "useAlternateSeries": {
+ "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data.",
+ "type": "boolean"
+ },
+ "sourceAndDestination": {
+ "$ref": "SourceAndDestination",
+ "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data."
+ },
+ "range": {
+ "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "AutoFillRequest"
+ },
+ "GradientRule": {
+ "description": "A rule that applies a gradient color scale format, based on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints.",
+ "type": "object",
+ "properties": {
+ "midpoint": {
+ "description": "An optional midway interpolation point.",
+ "$ref": "InterpolationPoint"
+ },
+ "minpoint": {
+ "description": "The starting interpolation point.",
+ "$ref": "InterpolationPoint"
+ },
+ "maxpoint": {
+ "description": "The final interpolation point.",
+ "$ref": "InterpolationPoint"
+ }
+ },
+ "id": "GradientRule"
+ },
+ "SetBasicFilterRequest": {
+ "id": "SetBasicFilterRequest",
+ "description": "Sets the basic filter associated with a sheet.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "The filter to set.",
+ "$ref": "BasicFilter"
+ }
+ }
+ },
+ "ClearValuesRequest": {
+ "id": "ClearValuesRequest",
+ "description": "The request for clearing a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {}
+ },
+ "BatchClearValuesByDataFilterRequest": {
+ "description": "The request for clearing more than one range selected by a\nDataFilter in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "dataFilters": {
+ "description": "The DataFilters used to determine which ranges to clear.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ }
+ }
+ },
+ "id": "BatchClearValuesByDataFilterRequest"
+ },
+ "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."
+ },
+ "type": {
+ "description": "How the value should be interpreted.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "The interpolation point will use the minimum value in the\ncells over the range of the conditional format.",
+ "The interpolation point will use the maximum value in the\ncells over the range of the conditional format.",
+ "The interpolation point will use exactly the value in\nInterpolationPoint.value.",
+ "The interpolation point will be the given percentage over\nall the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=(MAX(FLATTEN(range)) * (value / 100))\n + (MIN(FLATTEN(range)) * (1 - (value / 100)))`\n(where errors in the range are ignored when flattening).",
+ "The interpolation point will be the given percentile\nover all the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=PERCENTILE(FLATTEN(range), value / 100)`\n(where errors in the range are ignored when flattening)."
+ ],
+ "enum": [
+ "INTERPOLATION_POINT_TYPE_UNSPECIFIED",
+ "MIN",
+ "MAX",
+ "NUMBER",
+ "PERCENT",
+ "PERCENTILE"
+ ]
+ }
+ },
+ "id": "InterpolationPoint"
+ },
+ "GetSpreadsheetByDataFilterRequest": {
+ "id": "GetSpreadsheetByDataFilterRequest",
+ "description": "The request for retrieving a Spreadsheet.",
+ "type": "object",
+ "properties": {
+ "dataFilters": {
+ "description": "The DataFilters used to select which ranges to retrieve from\nthe spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ }
+ },
+ "includeGridData": {
+ "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
+ "type": "boolean"
+ }
+ }
+ },
+ "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": {
+ "description": "The number of rows changed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetsChanged": {
+ "description": "The number of sheets changed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "formulasChanged": {
+ "description": "The number of formula cells changed.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "FindReplaceResponse"
+ },
+ "DeleteEmbeddedObjectRequest": {
+ "id": "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"
+ }
+ }
+ },
+ "UpdateValuesByDataFilterResponse": {
+ "id": "UpdateValuesByDataFilterResponse",
+ "description": "The response when updating a range of values by a data filter in a\nspreadsheet.",
+ "type": "object",
+ "properties": {
+ "updatedRows": {
+ "description": "The number of rows where at least one cell in the row was updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "updatedData": {
+ "$ref": "ValueRange",
+ "description": "The values of the cells in the range matched by the dataFilter after all\nupdates were applied. This is only included if the request's\n`includeValuesInResponse` field was `true`."
+ },
+ "updatedColumns": {
+ "description": "The number of columns where at least one cell in the column was updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "updatedRange": {
+ "description": "The range (in A1 notation) that updates were applied to.",
+ "type": "string"
+ },
+ "updatedCells": {
+ "description": "The number of cells updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "dataFilter": {
+ "description": "The data filter that selected the range that was updated.",
+ "$ref": "DataFilter"
+ }
+ }
+ },
+ "DuplicateFilterViewRequest": {
+ "id": "DuplicateFilterViewRequest",
+ "description": "Duplicates a particular filter view.",
+ "type": "object",
+ "properties": {
+ "filterId": {
+ "description": "The ID of the filter being duplicated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "DeleteSheetRequest": {
+ "description": "Deletes the requested sheet.",
+ "type": "object",
+ "properties": {
+ "sheetId": {
+ "description": "The ID of the sheet to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteSheetRequest"
+ },
+ "DeveloperMetadataLocation": {
+ "id": "DeveloperMetadataLocation",
+ "description": "A location where metadata may be associated in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "dimensionRange": {
+ "description": "Represents the row or column when metadata is associated with\na dimension. The specified DimensionRange must represent a single row\nor column; it cannot be unbounded or span multiple rows or columns.",
+ "$ref": "DimensionRange"
+ },
+ "spreadsheet": {
+ "description": "True when metadata is associated with an entire spreadsheet.",
+ "type": "boolean"
+ },
+ "sheetId": {
+ "description": "The ID of the sheet when metadata is associated with an entire sheet.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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": "The type of location this object represents. This field is read-only.",
+ "type": "string"
+ }
+ }
+ },
+ "MatchedValueRange": {
+ "id": "MatchedValueRange",
+ "description": "A value range that was matched by one or more data filers.",
+ "type": "object",
+ "properties": {
+ "valueRange": {
+ "$ref": "ValueRange",
+ "description": "The values matched by the DataFilter."
+ },
+ "dataFilters": {
+ "description": "The DataFilters from the request that matched the range of\nvalues.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ }
+ }
+ }
+ },
+ "UpdateConditionalFormatRuleResponse": {
+ "description": "The result of updating a conditional format rule.",
+ "type": "object",
+ "properties": {
+ "oldRule": {
+ "description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule).",
+ "$ref": "ConditionalFormatRule"
+ },
+ "newIndex": {
+ "description": "The index of the new rule.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "oldIndex": {
+ "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "newRule": {
+ "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)",
+ "$ref": "ConditionalFormatRule"
+ }
+ },
+ "id": "UpdateConditionalFormatRuleResponse"
+ },
+ "DuplicateSheetRequest": {
+ "description": "Duplicates the contents of a sheet.",
+ "type": "object",
+ "properties": {
+ "newSheetName": {
+ "description": "The name of the new sheet. If empty, a new name is chosen for you.",
+ "type": "string"
+ },
+ "sourceSheetId": {
+ "description": "The sheet to duplicate.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "newSheetId": {
+ "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "insertSheetIndex": {
+ "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DuplicateSheetRequest"
+ },
+ "ConditionValue": {
+ "id": "ConditionValue",
+ "description": "The value of the condition.",
+ "type": "object",
+ "properties": {
+ "relativeDate": {
+ "description": "A relative date (based on the current date).\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDATE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey are supported only in conditional formatting and\nconditional filters.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The value is one year before today.",
+ "The value is one month before today.",
+ "The value is one week before today.",
+ "The value is yesterday.",
+ "The value is today.",
+ "The value is tomorrow."
+ ],
+ "enum": [
+ "RELATIVE_DATE_UNSPECIFIED",
+ "PAST_YEAR",
+ "PAST_MONTH",
+ "PAST_WEEK",
+ "YESTERDAY",
+ "TODAY",
+ "TOMORROW"
+ ]
+ },
+ "userEnteredValue": {
+ "description": "A value the condition is based on.\nThe value will be parsed as if the user typed into a cell.\nFormulas are supported (and must begin with an `=`).",
+ "type": "string"
+ }
+ }
+ },
+ "ExtendedValue": {
+ "id": "ExtendedValue",
+ "description": "The kinds of value that a cell in a spreadsheet can have.",
+ "type": "object",
+ "properties": {
+ "errorValue": {
+ "description": "Represents an error.\nThis field is read-only.",
+ "$ref": "ErrorValue"
+ },
+ "stringValue": {
+ "description": "Represents a string value.\nLeading single quotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.",
+ "type": "string"
+ },
+ "boolValue": {
+ "description": "Represents a boolean value.",
+ "type": "boolean"
+ },
+ "formulaValue": {
+ "description": "Represents a formula.",
+ "type": "string"
+ },
+ "numberValue": {
+ "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
+ "format": "double",
+ "type": "number"
+ }
+ }
+ },
+ "AddChartRequest": {
+ "description": "Adds a chart to a sheet in the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "chart": {
+ "description": "The chart that should be added to the spreadsheet, including the position\nwhere it should be placed. The chartId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a chart that already exists.)",
+ "$ref": "EmbeddedChart"
+ }
+ },
+ "id": "AddChartRequest"
+ },
+ "BandedRange": {
+ "id": "BandedRange",
+ "description": "A banded (alternating colors) range in a sheet.",
+ "type": "object",
+ "properties": {
+ "rowProperties": {
+ "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified.",
+ "$ref": "BandingProperties"
+ },
+ "columnProperties": {
+ "$ref": "BandingProperties",
+ "description": "Properties for column bands. These properties will be applied on a column-\nby-column basis throughout all the columns in the range. At least one of\nrow_properties or column_properties must be specified."
+ },
+ "range": {
+ "description": "The range over which these properties are applied.",
+ "$ref": "GridRange"
+ },
+ "bandedRangeId": {
+ "description": "The id of the banded range.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "Spreadsheet": {
+ "description": "Resource that represents a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "SpreadsheetProperties",
+ "description": "Overall properties of a spreadsheet."
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet.\nThis field is read-only.",
+ "type": "string"
+ },
+ "namedRanges": {
+ "description": "The named ranges defined in a spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "NamedRange"
+ }
+ },
+ "developerMetadata": {
+ "description": "The developer metadata associated with a spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "sheets": {
+ "description": "The sheets that are part of a spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "Sheet"
+ }
+ },
+ "spreadsheetUrl": {
+ "description": "The url of the spreadsheet.\nThis field is read-only.",
+ "type": "string"
+ }
+ },
+ "id": "Spreadsheet"
+ },
+ "BatchClearValuesResponse": {
+ "description": "The response when clearing a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "clearedRanges": {
+ "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "BatchClearValuesResponse"
+ },
+ "HistogramSeries": {
+ "description": "A histogram series containing the series color and data.",
+ "type": "object",
+ "properties": {
+ "barColor": {
+ "description": "The color of the column representing this series in each bucket.\nThis field is optional.",
+ "$ref": "Color"
+ },
+ "data": {
+ "description": "The data for this histogram series.",
+ "$ref": "ChartData"
+ }
+ },
+ "id": "HistogramSeries"
+ },
+ "UpdateProtectedRangeRequest": {
+ "id": "UpdateProtectedRangeRequest",
+ "description": "Updates an existing protected range with the specified\nprotectedRangeId.",
+ "type": "object",
+ "properties": {
+ "protectedRange": {
+ "$ref": "ProtectedRange",
+ "description": "The protected range to update with the new properties."
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `protectedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "id": "DataFilter"
+ },
+ "TextFormat": {
+ "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.",
+ "type": "object",
+ "properties": {
+ "italic": {
+ "description": "True if the text is italicized.",
+ "type": "boolean"
+ },
+ "strikethrough": {
+ "description": "True if the text has a strikethrough.",
+ "type": "boolean"
+ },
+ "fontSize": {
+ "description": "The size of the font.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "underline": {
+ "description": "True if the text is underlined.",
+ "type": "boolean"
+ },
+ "foregroundColor": {
+ "$ref": "Color",
+ "description": "The foreground color of the text."
+ },
+ "bold": {
+ "description": "True if the text is bold.",
+ "type": "boolean"
+ },
+ "fontFamily": {
+ "description": "The font family.",
+ "type": "string"
+ }
+ },
+ "id": "TextFormat"
+ },
+ "AddSheetResponse": {
+ "id": "AddSheetResponse",
+ "description": "The result of adding a sheet.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties of the newly added sheet."
+ }
+ }
+ },
+ "AddFilterViewResponse": {
+ "description": "The result of adding a filter view.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The newly added filter view."
+ }
+ },
+ "id": "AddFilterViewResponse"
+ },
+ "IterativeCalculationSettings": {
+ "id": "IterativeCalculationSettings",
+ "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.",
+ "type": "object",
+ "properties": {
+ "convergenceThreshold": {
+ "description": "When iterative calculation is enabled and successive results differ by\nless than this threshold value, the calculation rounds stop.",
+ "format": "double",
+ "type": "number"
+ },
+ "maxIterations": {
+ "description": "When iterative calculation is enabled, the maximum number of calculation\nrounds to perform.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "SpreadsheetProperties": {
+ "id": "SpreadsheetProperties",
+ "description": "Properties of a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "autoRecalc": {
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "Volatile functions are updated on every change.",
+ "Volatile functions are updated on every change and every minute.",
+ "Volatile functions are updated on every change and hourly."
+ ],
+ "enum": [
+ "RECALCULATION_INTERVAL_UNSPECIFIED",
+ "ON_CHANGE",
+ "MINUTE",
+ "HOUR"
+ ],
+ "description": "The amount of time to wait before volatile functions are recalculated.",
+ "type": "string"
+ },
+ "defaultFormat": {
+ "$ref": "CellFormat",
+ "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only."
+ },
+ "title": {
+ "description": "The title of the spreadsheet.",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`.",
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale of the spreadsheet in one of the following formats:\n\n* an ISO 639-1 language code such as `en`\n\n* an ISO 639-2 language code such as `fil`, if no 639-1 code exists\n\n* a combination of the ISO language code and country code, such as `en_US`\n\nNote: when updating this field, not all locales/languages are supported.",
+ "type": "string"
+ },
+ "iterativeCalculationSettings": {
+ "$ref": "IterativeCalculationSettings",
+ "description": "Determines whether and how circular references are resolved with iterative\ncalculation. Absence of this field means that circular references will\nresult in calculation errors."
+ }
+ }
+ },
+ "OverlayPosition": {
+ "description": "The location an object is overlaid on top of a grid.",
+ "type": "object",
+ "properties": {
+ "widthPixels": {
+ "description": "The width of the object, in pixels. Defaults to 600.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "offsetXPixels": {
+ "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "anchorCell": {
+ "$ref": "GridCoordinate",
+ "description": "The cell the object is anchored to."
+ },
+ "offsetYPixels": {
+ "description": "The vertical offset, in pixels, that the object is offset\nfrom the anchor cell.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "heightPixels": {
+ "description": "The height of the object, in pixels. Defaults to 371.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "OverlayPosition"
+ },
+ "RepeatCellRequest": {
+ "id": "RepeatCellRequest",
+ "description": "Updates all cells in the range to the values in the given Cell object.\nOnly the fields listed in the fields field are updated; others are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges will automatically\nincrement for each field in the range.\nFor example, if writing a cell with formula `=A1` into range B2:C4,\nB2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`,\nC2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`.\n\nTo keep the formula's ranges static, use the `$` indicator.\nFor example, use the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing.",
+ "type": "object",
+ "properties": {
+ "cell": {
+ "description": "The data to write.",
+ "$ref": "CellData"
+ },
+ "range": {
+ "description": "The range to repeat the cell in.",
+ "$ref": "GridRange"
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `cell` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ }
+ },
+ "AddChartResponse": {
+ "description": "The result of adding a chart to a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "chart": {
+ "description": "The newly added chart.",
+ "$ref": "EmbeddedChart"
+ }
+ },
+ "id": "AddChartResponse"
+ },
+ "InsertDimensionRequest": {
+ "id": "InsertDimensionRequest",
+ "description": "Inserts rows or columns in a sheet at a particular index.",
+ "type": "object",
+ "properties": {
+ "inheritFromBefore": {
+ "description": "Whether dimension properties should be extended from the dimensions\nbefore or after the newly inserted dimensions.\nTrue to inherit from the dimensions before (in which case the start\nindex must be greater than 0), and false to inherit from the dimensions\nafter.\n\nFor example, if row index 0 has red background and row index 1\nhas a green background, then inserting 2 rows at index 1 can inherit\neither the green or red background. If `inheritFromBefore` is true,\nthe two new rows will be red (because the row before the insertion point\nwas red), whereas if `inheritFromBefore` is false, the two new rows will\nbe green (because the row after the insertion point was green).",
+ "type": "boolean"
+ },
+ "range": {
+ "description": "The dimensions to insert. Both the start and end indexes must be bounded.",
+ "$ref": "DimensionRange"
+ }
+ }
+ },
+ "UpdateSpreadsheetPropertiesRequest": {
+ "description": "Updates properties of a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root 'properties' is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "SpreadsheetProperties",
+ "description": "The properties to update."
+ }
+ },
+ "id": "UpdateSpreadsheetPropertiesRequest"
+ },
+ "ProtectedRange": {
+ "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"
+ },
+ "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": {
+ "$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."
+ },
+ "description": {
+ "description": "The description of this protected range.",
+ "type": "string"
+ },
+ "unprotectedRanges": {
+ "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets.",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ },
+ "namedRangeId": {
+ "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "type": "string"
+ },
+ "protectedRangeId": {
+ "description": "The ID of the protected range.\nThis field is read-only.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ProtectedRange"
+ },
+ "BatchUpdateValuesRequest": {
+ "id": "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": {
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "enumDescriptions": [
+ "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
+ "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
+ "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
+ ],
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ]
+ },
+ "includeValuesInResponse": {
+ "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
+ "type": "boolean"
+ },
+ "valueInputOption": {
+ "description": "How the input data should be interpreted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default input value. This value must not be used.",
+ "The values the user has entered will not be parsed and will be stored\nas-is.",
+ "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
+ ],
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
+ ]
+ },
+ "data": {
+ "description": "The new values to apply to the spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ValueRange"
+ }
+ }
+ }
+ },
+ "DimensionProperties": {
+ "id": "DimensionProperties",
+ "description": "Properties about a dimension.",
+ "type": "object",
+ "properties": {
+ "developerMetadata": {
+ "description": "The developer metadata associated with a single row or column.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "pixelSize": {
+ "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "hiddenByFilter": {
+ "description": "True if this dimension is being filtered.\nThis field is read-only.",
+ "type": "boolean"
+ },
+ "hiddenByUser": {
+ "description": "True if this dimension is explicitly hidden.",
+ "type": "boolean"
+ }
+ }
+ },
+ "DimensionRange": {
+ "id": "DimensionRange",
+ "description": "A range along a single dimension on a sheet.\nAll indexes are zero-based.\nIndexes are half open: the start index is inclusive\nand the end index is exclusive.\nMissing indexes indicate the range is unbounded on that side.",
+ "type": "object",
+ "properties": {
+ "dimension": {
+ "description": "The dimension of the span.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ]
+ },
+ "startIndex": {
+ "description": "The start (inclusive) of the span, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "endIndex": {
+ "description": "The end (exclusive) of the span, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet this span is on.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "NamedRange": {
+ "description": "A named range.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the named range.",
+ "type": "string"
+ },
+ "namedRangeId": {
+ "description": "The ID of the named range.",
+ "type": "string"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range this represents."
+ }
+ },
+ "id": "NamedRange"
+ },
+ "CutPasteRequest": {
+ "id": "CutPasteRequest",
+ "description": "Moves data from the source to the destination.",
+ "type": "object",
+ "properties": {
+ "destination": {
+ "$ref": "GridCoordinate",
+ "description": "The top-left coordinate where the data should be pasted."
+ },
+ "source": {
+ "description": "The source data to cut.",
+ "$ref": "GridRange"
+ },
+ "pasteType": {
+ "enumDescriptions": [
+ "Paste values, formulas, formats, and merges.",
+ "Paste the values ONLY without formats, formulas, or merges.",
+ "Paste the format and data validation only.",
+ "Like PASTE_NORMAL but without borders.",
+ "Paste the formulas only.",
+ "Paste the data validation only.",
+ "Paste the conditional formatting rules only."
+ ],
+ "enum": [
+ "PASTE_NORMAL",
+ "PASTE_VALUES",
+ "PASTE_FORMAT",
+ "PASTE_NO_BORDERS",
+ "PASTE_FORMULA",
+ "PASTE_DATA_VALIDATION",
+ "PASTE_CONDITIONAL_FORMATTING"
+ ],
+ "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
+ "type": "string"
+ }
+ }
+ },
+ "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": {
+ "targetAxis": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
+ "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
+ "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
+ ],
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
+ ],
+ "description": "The minor axis that will specify the range of values for this series.\nFor example, if charting stocks over time, the \"Volume\" series\nmay want to be pinned to the right with the prices pinned to the left,\nbecause the scale of trading volume is different than the scale of\nprices.\nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart's type.",
+ "type": "string"
+ },
+ "lineStyle": {
+ "description": "The line style of this series. Valid only if the\nchartType is AREA,\nLINE, or SCATTER.\nCOMBO charts are also supported if the\nseries chart type is\nAREA or LINE.",
+ "$ref": "LineStyle"
+ },
+ "series": {
+ "$ref": "ChartData",
+ "description": "The data being visualized in this chart series."
+ },
+ "type": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/linechart\"\u003eline chart\u003c/a\u003e.",
+ "An \u003ca href=\"/chart/interactive/docs/gallery/areachart\"\u003earea chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/columnchart\"\u003ecolumn chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/scatterchart\"\u003escatter chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/combochart\"\u003ecombo chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/steppedareachart\"\u003estepped area chart\u003c/a\u003e."
+ ],
+ "enum": [
+ "BASIC_CHART_TYPE_UNSPECIFIED",
+ "BAR",
+ "LINE",
+ "AREA",
+ "COLUMN",
+ "SCATTER",
+ "COMBO",
+ "STEPPED_AREA"
+ ],
+ "description": "The type of this series. Valid only if the\nchartType is\nCOMBO.\nDifferent types will change the way the series is visualized.\nOnly LINE, AREA,\nand COLUMN are supported.",
+ "type": "string"
+ }
+ },
+ "id": "BasicChartSeries"
+ },
+ "Borders": {
+ "id": "Borders",
+ "description": "The borders of the cell.",
+ "type": "object",
+ "properties": {
+ "top": {
+ "$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"
+ },
+ "bottom": {
+ "$ref": "Border",
+ "description": "The bottom border of the cell."
+ }
+ }
+ },
+ "AutoResizeDimensionsRequest": {
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
+ "type": "object",
+ "properties": {
+ "dimensions": {
+ "$ref": "DimensionRange",
+ "description": "The dimensions to automatically resize."
+ }
+ },
+ "id": "AutoResizeDimensionsRequest"
+ },
+ "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": {
+ "description": "The border to put at the right of the range.",
+ "$ref": "Border"
+ },
+ "range": {
+ "description": "The range whose borders should be updated.",
+ "$ref": "GridRange"
+ },
+ "innerHorizontal": {
+ "description": "The horizontal border to put within the range.",
+ "$ref": "Border"
+ },
+ "top": {
+ "$ref": "Border",
+ "description": "The border to put at the top of the range."
+ },
+ "left": {
+ "$ref": "Border",
+ "description": "The border to put at the left of the range."
+ }
+ }
+ },
+ "CellFormat": {
+ "id": "CellFormat",
+ "description": "The format of a cell.",
+ "type": "object",
+ "properties": {
+ "borders": {
+ "description": "The borders of the cell.",
+ "$ref": "Borders"
+ },
+ "textDirection": {
+ "enumDescriptions": [
+ "The text direction is not specified. Do not use this.",
+ "The text direction of left-to-right was set by the user.",
+ "The text direction of right-to-left was set by the user."
+ ],
+ "enum": [
+ "TEXT_DIRECTION_UNSPECIFIED",
+ "LEFT_TO_RIGHT",
+ "RIGHT_TO_LEFT"
+ ],
+ "description": "The direction of the text in the cell.",
+ "type": "string"
+ },
+ "wrapStrategy": {
+ "description": "The wrap strategy for the value in the cell.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Lines that are longer than the cell width will be written in the next\ncell over, so long as that cell is empty. If the next cell over is\nnon-empty, this behaves the same as CLIP. The text will never wrap\nto the next line unless the user manually inserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline that is very long. \u003c- Text continues into next cell\n | Next newline. |",
+ "This wrap strategy represents the old Google Sheets wrap strategy where\nwords that are longer than a line are clipped rather than broken. This\nstrategy is not supported on all platforms and is being phased out.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is clipped.\n | word. |",
+ "Lines that are longer than the cell width will be clipped.\nThe text will never wrap to the next line unless the user manually\ninserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline t| \u003c- Text is clipped\n | Next newline. |",
+ "Words that are longer than a line are wrapped at the character level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is broken.\n | ong word. |"
+ ],
+ "enum": [
+ "WRAP_STRATEGY_UNSPECIFIED",
+ "OVERFLOW_CELL",
+ "LEGACY_WRAP",
+ "CLIP",
+ "WRAP"
+ ]
+ },
+ "textRotation": {
+ "$ref": "TextRotation",
+ "description": "The rotation applied to text in a cell"
+ },
+ "numberFormat": {
+ "$ref": "NumberFormat",
+ "description": "A format describing how number values should be represented to the user."
+ },
+ "horizontalAlignment": {
+ "description": "The horizontal alignment of the value in the cell.",
+ "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."
+ ],
+ "enum": [
+ "HORIZONTAL_ALIGN_UNSPECIFIED",
+ "LEFT",
+ "CENTER",
+ "RIGHT"
+ ]
+ },
+ "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.",
+ "A hyperlink should not be rendered."
+ ],
+ "enum": [
+ "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
+ "LINKED",
+ "PLAIN_TEXT"
+ ]
+ },
+ "textFormat": {
+ "description": "The format of the text in the cell (unless overridden by a format run).",
+ "$ref": "TextFormat"
+ },
+ "backgroundColor": {
+ "description": "The background color of the cell.",
+ "$ref": "Color"
+ },
+ "verticalAlignment": {
+ "enumDescriptions": [
+ "The vertical alignment is not specified. Do not use this.",
+ "The text is explicitly aligned to the top of the cell.",
+ "The text is explicitly aligned to the middle of the cell.",
+ "The text is explicitly aligned to the bottom of the cell."
+ ],
+ "enum": [
+ "VERTICAL_ALIGN_UNSPECIFIED",
+ "TOP",
+ "MIDDLE",
+ "BOTTOM"
+ ],
+ "description": "The vertical alignment of the value in the cell.",
+ "type": "string"
+ },
+ "padding": {
+ "$ref": "Padding",
+ "description": "The padding of the cell."
+ }
+ }
+ },
+ "ClearValuesResponse": {
+ "description": "The response when clearing a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "clearedRange": {
+ "description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)",
+ "type": "string"
+ }
+ },
+ "id": "ClearValuesResponse"
+ },
+ "DeleteConditionalFormatRuleRequest": {
+ "id": "DeleteConditionalFormatRuleRequest",
+ "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.",
+ "type": "object",
+ "properties": {
+ "sheetId": {
+ "description": "The sheet the rule is being deleted from.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "index": {
+ "description": "The zero-based index of the rule to be deleted.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "DeleteNamedRangeRequest": {
+ "id": "DeleteNamedRangeRequest",
+ "description": "Removes the named range with the given ID from the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "namedRangeId": {
+ "description": "The ID of the named range to delete.",
+ "type": "string"
+ }
+ }
+ },
+ "AddBandingResponse": {
+ "id": "AddBandingResponse",
+ "description": "The result of adding a banded range.",
+ "type": "object",
+ "properties": {
+ "bandedRange": {
+ "description": "The banded range that was added.",
+ "$ref": "BandedRange"
+ }
+ }
+ },
+ "WaterfallChartCustomSubtotal": {
+ "id": "WaterfallChartCustomSubtotal",
+ "description": "A custom subtotal column for a waterfall chart series.",
+ "type": "object",
+ "properties": {
+ "label": {
+ "description": "A label for the subtotal column.",
+ "type": "string"
+ },
+ "subtotalIndex": {
+ "description": "The 0-based index of a data point within the series. If\ndata_is_subtotal is true, the data point at this index is the\nsubtotal. Otherwise, the subtotal appears after the data point with\nthis index. A series can have multiple subtotals at arbitrary indices,\nbut subtotals do not affect the indices of the data points. For\nexample, if a series has 3 data points, their indices will always be 0,\n1, and 2, regardless of how many subtotals exist on the series or what\ndata points they are associated with.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "dataIsSubtotal": {
+ "description": "True if the data point at subtotal_index is the subtotal. If false,\nthe subtotal will be computed and appear after the data point.",
+ "type": "boolean"
+ }
+ }
+ },
+ "ChartData": {
+ "id": "ChartData",
+ "description": "The data included in a domain or series.",
+ "type": "object",
+ "properties": {
+ "sourceRange": {
+ "description": "The source ranges of the data.",
+ "$ref": "ChartSourceRange"
+ }
+ }
+ },
+ "BatchGetValuesResponse": {
+ "description": "The response when retrieving more than one range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "valueRanges": {
+ "description": "The requested values. The order of the ValueRanges is the same as the\norder of the requested ranges.",
+ "type": "array",
+ "items": {
+ "$ref": "ValueRange"
+ }
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet the data was retrieved from.",
+ "type": "string"
+ }
+ },
+ "id": "BatchGetValuesResponse"
+ },
+ "UpdateBandingRequest": {
+ "id": "UpdateBandingRequest",
+ "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"
+ }
+ }
+ },
+ "Color": {
+ "id": "Color",
+ "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
+ "type": "object",
+ "properties": {
+ "red": {
+ "description": "The amount of red in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "green": {
+ "description": "The amount of green in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "blue": {
+ "description": "The amount of blue in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "alpha": {
+ "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
+ "format": "float",
+ "type": "number"
+ }
+ }
+ },
+ "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",
+ "type": "integer"
+ },
+ "showTotals": {
+ "description": "True if the pivot table should include the totals for this grouping.",
+ "type": "boolean"
+ },
+ "valueMetadata": {
+ "description": "Metadata about values in the grouping.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotGroupValueMetadata"
+ }
+ },
+ "sortOrder": {
+ "description": "The order the values in this group should be sorted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort descending."
+ ],
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ]
+ }
+ }
+ },
+ "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": {
+ "enumDescriptions": [
+ "Values are laid out horizontally (as columns).",
+ "Values are laid out vertically (as rows)."
+ ],
+ "enum": [
+ "HORIZONTAL",
+ "VERTICAL"
+ ],
+ "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
+ "type": "string"
+ },
+ "values": {
+ "description": "A list of values to include in the pivot table.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotValue"
+ }
+ },
+ "source": {
+ "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"
+ }
+ }
+ }
+ },
+ "ChartSourceRange": {
+ "description": "Source ranges for a chart.",
+ "type": "object",
+ "properties": {
+ "sources": {
+ "description": "The ranges of data for a series or domain.\nExactly one dimension must have a length of 1,\nand all sources in the list must have the same dimension\nwith length 1.\nThe domain (if it exists) & all series must have the same number\nof source ranges. If using more than one source range, then the source\nrange at a given offset must be contiguous across the domain and series.\n\nFor example, these are valid configurations:\n\n domain sources: A1:A5\n series1 sources: B1:B5\n series2 sources: D6:D10\n\n domain sources: A1:A5, C10:C12\n series1 sources: B1:B5, D10:D12\n series2 sources: C1:C5, E10:E12",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ }
+ },
+ "id": "ChartSourceRange"
+ },
+ "SearchDeveloperMetadataResponse": {
+ "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"
+ }
+ }
+ }
+ },
+ "ValueRange": {
+ "description": "Data within a range of the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.",
+ "type": "string"
+ },
+ "majorDimension": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The major dimension of the values.\n\nFor output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`\nwill set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`\nthen `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.\n\nWhen writing, if this field is not set, it defaults to ROWS.",
+ "type": "string"
+ },
+ "values": {
+ "description": "The data that was read or to be written. This is an array of arrays,\nthe outer array representing all the data and each inner array\nrepresenting a major dimension. Each item in the inner array\ncorresponds with one cell.\n\nFor output, empty trailing rows and columns will not be included.\n\nFor input, supported value types are: bool, string, and double.\nNull values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ }
+ },
+ "id": "ValueRange"
+ },
+ "AppendCellsRequest": {
+ "description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.",
+ "type": "object",
+ "properties": {
+ "sheetId": {
+ "description": "The sheet ID to append the data to.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rows": {
+ "description": "The data to append.",
+ "type": "array",
+ "items": {
+ "$ref": "RowData"
+ }
+ },
+ "fields": {
+ "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "AppendCellsRequest"
+ },
+ "AddBandingRequest": {
+ "description": "Adds a new banded range to the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "bandedRange": {
+ "$ref": "BandedRange",
+ "description": "The banded range to add. The bandedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
+ }
+ },
+ "id": "AddBandingRequest"
+ },
+ "Response": {
+ "description": "A single response from an update.",
+ "type": "object",
+ "properties": {
+ "addSheet": {
+ "description": "A reply from adding a sheet.",
+ "$ref": "AddSheetResponse"
+ },
+ "updateConditionalFormatRule": {
+ "$ref": "UpdateConditionalFormatRuleResponse",
+ "description": "A reply from updating a conditional format rule."
+ },
+ "createDeveloperMetadata": {
+ "$ref": "CreateDeveloperMetadataResponse",
+ "description": "A reply from creating a developer metadata entry."
+ },
+ "addNamedRange": {
+ "$ref": "AddNamedRangeResponse",
+ "description": "A reply from adding a named range."
+ },
+ "deleteDeveloperMetadata": {
+ "$ref": "DeleteDeveloperMetadataResponse",
+ "description": "A reply from deleting a developer metadata entry."
+ },
+ "addFilterView": {
+ "description": "A reply from adding a filter view.",
+ "$ref": "AddFilterViewResponse"
+ },
+ "addBanding": {
+ "description": "A reply from adding a banded range.",
+ "$ref": "AddBandingResponse"
+ },
+ "addProtectedRange": {
+ "description": "A reply from adding a protected range.",
+ "$ref": "AddProtectedRangeResponse"
+ },
+ "duplicateSheet": {
+ "$ref": "DuplicateSheetResponse",
+ "description": "A reply from duplicating a sheet."
+ },
+ "updateEmbeddedObjectPosition": {
+ "$ref": "UpdateEmbeddedObjectPositionResponse",
+ "description": "A reply from updating an embedded object's position."
+ },
+ "deleteConditionalFormatRule": {
+ "description": "A reply from deleting a conditional format rule.",
+ "$ref": "DeleteConditionalFormatRuleResponse"
+ },
+ "duplicateFilterView": {
+ "description": "A reply from duplicating a filter view.",
+ "$ref": "DuplicateFilterViewResponse"
+ },
+ "addChart": {
+ "description": "A reply from adding a chart.",
+ "$ref": "AddChartResponse"
+ },
+ "updateDeveloperMetadata": {
+ "description": "A reply from updating a developer metadata entry.",
+ "$ref": "UpdateDeveloperMetadataResponse"
+ },
+ "findReplace": {
+ "$ref": "FindReplaceResponse",
+ "description": "A reply from doing a find/replace."
+ }
+ },
+ "id": "Response"
+ },
+ "EmbeddedChart": {
+ "id": "EmbeddedChart",
+ "description": "A chart embedded in a sheet.",
+ "type": "object",
+ "properties": {
+ "chartId": {
+ "description": "The ID of the chart.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "position": {
+ "description": "The position of the chart.",
+ "$ref": "EmbeddedObjectPosition"
+ },
+ "spec": {
+ "description": "The specification of the chart.",
+ "$ref": "ChartSpec"
+ }
+ }
+ },
+ "TextFormatRun": {
+ "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set.",
+ "type": "object",
+ "properties": {
+ "startIndex": {
+ "description": "The character index where this run starts.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "format": {
+ "$ref": "TextFormat",
+ "description": "The format of this run. Absent values inherit the cell's format."
+ }
+ },
+ "id": "TextFormatRun"
+ },
+ "InsertRangeRequest": {
+ "description": "Inserts cells into a range, shifting the existing cells over or down.",
+ "type": "object",
+ "properties": {
+ "shiftDimension": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The dimension which will be shifted when inserting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existing cells will be shifted right.",
+ "type": "string"
+ },
+ "range": {
+ "description": "The range to insert new cells into.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "InsertRangeRequest"
+ },
+ "AddNamedRangeResponse": {
+ "id": "AddNamedRangeResponse",
+ "description": "The result of adding a named range.",
+ "type": "object",
+ "properties": {
+ "namedRange": {
+ "description": "The named range to add.",
+ "$ref": "NamedRange"
+ }
+ }
+ },
+ "BatchUpdateValuesByDataFilterResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "totalUpdatedCells": {
+ "description": "The total number of cells updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalUpdatedColumns": {
+ "description": "The total number of columns where at least one cell in the column was\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "totalUpdatedRows": {
+ "description": "The total number of rows where at least one cell in the row was updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "responses": {
+ "description": "The response for each range updated.",
+ "type": "array",
+ "items": {
+ "$ref": "UpdateValuesByDataFilterResponse"
+ }
+ },
+ "totalUpdatedSheets": {
+ "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "BatchUpdateValuesByDataFilterResponse"
+ },
+ "RowData": {
+ "description": "Data about each cell in a row.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "The values in the row, one per column.",
+ "type": "array",
+ "items": {
+ "$ref": "CellData"
+ }
+ }
+ },
+ "id": "RowData"
+ },
+ "Border": {
+ "description": "A border along a cell.",
+ "type": "object",
+ "properties": {
+ "style": {
+ "description": "The style of the border.",
+ "type": "string",
+ "enumDescriptions": [
+ "The style is not specified. Do not use this.",
+ "The border is dotted.",
+ "The border is dashed.",
+ "The border is a thin solid line.",
+ "The border is a medium solid line.",
+ "The border is a thick solid line.",
+ "No border.\nUsed only when updating a border in order to erase it.",
+ "The border is two solid lines."
+ ],
+ "enum": [
+ "STYLE_UNSPECIFIED",
+ "DOTTED",
+ "DASHED",
+ "SOLID",
+ "SOLID_MEDIUM",
+ "SOLID_THICK",
+ "NONE",
+ "DOUBLE"
+ ]
+ },
+ "color": {
+ "$ref": "Color",
+ "description": "The color of the border."
+ },
+ "width": {
+ "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Border"
+ },
+ "GridData": {
+ "description": "Data in the grid, as well as metadata about the dimensions.",
+ "type": "object",
+ "properties": {
+ "columnMetadata": {
+ "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionProperties"
+ }
+ },
+ "startColumn": {
+ "description": "The first column this GridData refers to, zero-based.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rowMetadata": {
+ "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionProperties"
+ }
+ },
+ "rowData": {
+ "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.",
+ "type": "array",
+ "items": {
+ "$ref": "RowData"
+ }
+ },
+ "startRow": {
+ "description": "The first row this GridData refers to, zero-based.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GridData"
+ },
+ "UpdateNamedRangeRequest": {
+ "id": "UpdateNamedRangeRequest",
+ "description": "Updates properties of the named range with the specified\nnamedRangeId.",
+ "type": "object",
+ "properties": {
+ "namedRange": {
+ "$ref": "NamedRange",
+ "description": "The named range to update with the new properties."
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `namedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to find/replace over."
+ },
+ "sheetId": {
+ "description": "The sheet to find/replace over.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "allSheets": {
+ "description": "True to find/replace over all sheets.",
+ "type": "boolean"
+ },
+ "matchCase": {
+ "description": "True if the search is case sensitive.",
+ "type": "boolean"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "AddSheetRequest"
+ },
+ "UpdateCellsRequest": {
+ "description": "Updates all cells in a range with new data.",
+ "type": "object",
+ "properties": {
+ "start": {
+ "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written.",
+ "$ref": "GridCoordinate"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to write data to.\n\nIf the data in rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared."
+ },
+ "rows": {
+ "description": "The data to write.",
+ "type": "array",
+ "items": {
+ "$ref": "RowData"
+ }
+ },
+ "fields": {
+ "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateCellsRequest"
+ },
+ "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": {
+ "id": "DeleteConditionalFormatRuleResponse",
+ "description": "The result of deleting a conditional format rule.",
+ "type": "object",
+ "properties": {
+ "rule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The rule that was deleted."
+ }
+ }
+ },
+ "DeleteRangeRequest": {
+ "description": "Deletes a range of cells, shifting other cells into the deleted area.",
+ "type": "object",
+ "properties": {
+ "shiftDimension": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace the deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells.",
+ "type": "string"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range of cells to delete."
+ }
+ },
+ "id": "DeleteRangeRequest"
+ },
+ "GridCoordinate": {
+ "description": "A coordinate in a sheet.\nAll indexes are zero-based.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "id": "UpdateSheetPropertiesRequest",
+ "description": "Updates properties of the sheet with the specified\nsheetId.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties to update."
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ }
+ },
+ "GridProperties": {
+ "id": "GridProperties",
+ "description": "Properties of a grid.",
+ "type": "object",
+ "properties": {
+ "rowCount": {
+ "description": "The number of rows in the grid.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "frozenRowCount": {
+ "description": "The number of rows that are frozen in the grid.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "hideGridlines": {
+ "description": "True if the grid isn't showing gridlines in the UI.",
+ "type": "boolean"
+ },
+ "columnCount": {
+ "description": "The number of columns in the grid.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "frozenColumnCount": {
+ "description": "The number of columns that are frozen in the grid.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "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": {
+ "id": "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": {
+ "description": "The order data should be sorted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort descending."
+ ],
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ]
+ }
+ }
+ },
+ "Sheet": {
+ "id": "Sheet",
+ "description": "A sheet in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "filterViews": {
+ "description": "The filter views in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "FilterView"
+ }
+ },
+ "developerMetadata": {
+ "description": "The developer metadata associated with a sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "protectedRanges": {
+ "description": "The protected ranges in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ProtectedRange"
+ }
+ },
+ "conditionalFormats": {
+ "description": "The conditional format rules in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ConditionalFormatRule"
+ }
+ },
+ "basicFilter": {
+ "description": "The filter on this sheet, if any.",
+ "$ref": "BasicFilter"
+ },
+ "merges": {
+ "description": "The ranges that are merged together.",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ },
+ "data": {
+ "description": "Data in the grid, if this is a grid sheet.\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D).",
+ "type": "array",
+ "items": {
+ "$ref": "GridData"
+ }
+ },
+ "bandedRanges": {
+ "description": "The banded (i.e. alternating colors) ranges on this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "BandedRange"
+ }
+ },
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties of the sheet."
+ },
+ "charts": {
+ "description": "The specifications of every chart on this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "EmbeddedChart"
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "BooleanRule": {
+ "description": "A rule that may or may not match, depending on the condition.",
+ "type": "object",
+ "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": {
+ "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied.",
+ "$ref": "BooleanCondition"
+ }
+ },
+ "id": "BooleanRule"
+ },
+ "FilterCriteria": {
+ "id": "FilterCriteria",
+ "description": "Criteria for showing/hiding rows in a filter or filter view.",
+ "type": "object",
+ "properties": {
+ "hiddenValues": {
+ "description": "Values that should be hidden.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "condition": {
+ "$ref": "BooleanCondition",
+ "description": "A condition that must be true for values to be shown.\n(This does not override hiddenValues -- if a value is listed there,\n it will still be hidden.)"
+ }
+ }
+ },
+ "PivotGroupValueMetadata": {
+ "description": "Metadata about a value in a pivot grouping.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)",
+ "$ref": "ExtendedValue"
+ },
+ "collapsed": {
+ "description": "True if the data corresponding to the value is collapsed.",
+ "type": "boolean"
+ }
+ },
+ "id": "PivotGroupValueMetadata"
+ },
+ "WaterfallChartSpec": {
+ "id": "WaterfallChartSpec",
+ "description": "A waterfall chart.",
+ "type": "object",
+ "properties": {
+ "domain": {
+ "description": "The domain data (horizontal axis) for the waterfall chart.",
+ "$ref": "WaterfallChartDomain"
+ },
+ "firstValueIsTotal": {
+ "description": "True to interpret the first value as a total.",
+ "type": "boolean"
+ },
+ "stackedType": {
+ "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": {
+ "description": "The line style for the connector lines.",
+ "$ref": "LineStyle"
+ }
+ }
+ },
+ "Editors": {
+ "description": "The editors of a protected range.",
+ "type": "object",
+ "properties": {
+ "users": {
+ "description": "The email addresses of users with edit access to the protected range.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "groups": {
+ "description": "The email addresses of groups with edit access to the protected range.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "domainUsersCanEdit": {
+ "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on documents within a domain.",
+ "type": "boolean"
+ }
+ },
+ "id": "Editors"
+ },
+ "UpdateConditionalFormatRuleRequest": {
+ "id": "UpdateConditionalFormatRuleRequest",
+ "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
+ "type": "object",
+ "properties": {
+ "sheetId": {
+ "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "newIndex": {
+ "description": "The zero-based new index the rule should end up at.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rule": {
+ "description": "The rule that should replace the rule at the given index.",
+ "$ref": "ConditionalFormatRule"
+ },
+ "index": {
+ "description": "The zero-based index of the rule that should be replaced or moved.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "BasicChartDomain": {
+ "id": "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"
+ }
+ }
+ },
+ "DataValidationRule": {
+ "id": "DataValidationRule",
+ "description": "A data validation rule.",
+ "type": "object",
+ "properties": {
+ "inputMessage": {
+ "description": "A message to show the user when adding data to the cell.",
+ "type": "string"
+ },
+ "condition": {
+ "description": "The condition that data in the cell must match.",
+ "$ref": "BooleanCondition"
+ },
+ "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"
+ }
+ }
+ },
+ "PasteDataRequest": {
+ "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "Paste values, formulas, formats, and merges.",
+ "Paste the values ONLY without formats, formulas, or merges.",
+ "Paste the format and data validation only.",
+ "Like PASTE_NORMAL but without borders.",
+ "Paste the formulas only.",
+ "Paste the data validation only.",
+ "Paste the conditional formatting rules only."
+ ],
+ "enum": [
+ "PASTE_NORMAL",
+ "PASTE_VALUES",
+ "PASTE_FORMAT",
+ "PASTE_NO_BORDERS",
+ "PASTE_FORMULA",
+ "PASTE_DATA_VALIDATION",
+ "PASTE_CONDITIONAL_FORMATTING"
+ ],
+ "description": "How the data should be pasted.",
+ "type": "string"
+ },
+ "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": {
+ "id": "UpdateDeveloperMetadataResponse",
+ "description": "The response from updating developer metadata.",
+ "type": "object",
+ "properties": {
+ "developerMetadata": {
+ "description": "The updated developer metadata.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ }
+ }
+ },
+ "AppendDimensionRequest": {
+ "description": "Appends rows or columns to the end of a sheet.",
+ "type": "object",
+ "properties": {
+ "sheetId": {
+ "description": "The sheet to append rows or columns to.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "dimension": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "Whether rows or columns should be appended.",
+ "type": "string"
+ },
+ "length": {
+ "description": "The number of rows or columns to append.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "AppendDimensionRequest"
+ },
+ "AddNamedRangeRequest": {
+ "description": "Adds a named range to the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "namedRange": {
+ "$ref": "NamedRange",
+ "description": "The named range to add. The namedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
+ }
+ },
+ "id": "AddNamedRangeRequest"
+ },
+ "CreateDeveloperMetadataResponse": {
+ "description": "The response from creating developer metadata.",
+ "type": "object",
+ "properties": {
+ "developerMetadata": {
+ "$ref": "DeveloperMetadata",
+ "description": "The developer metadata that was created."
+ }
+ },
+ "id": "CreateDeveloperMetadataResponse"
+ },
+ "UpdateEmbeddedObjectPositionRequest": {
+ "description": "Update an embedded object's position (such as a moving or resizing a\nchart or image).",
+ "type": "object",
+ "properties": {
+ "newPosition": {
+ "$ref": "EmbeddedObjectPosition",
+ "description": "An explicit position to move the embedded object to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be created.\nIf newPosition.newSheet is set to true,\na new sheet will be created with an ID that will be chosen for you."
+ },
+ "fields": {
+ "description": "The fields of OverlayPosition\nthat should be updated when setting a new position. Used only if\nnewPosition.overlayPosition\nis set, in which case at least one field must\nbe specified. The root `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "The ID of the object to moved.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "UpdateEmbeddedObjectPositionRequest"
+ },
+ "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": {
+ "id": "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"
+ }
+ }
+ },
+ "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": {
+ "developerMetadata": {
+ "$ref": "DeveloperMetadata",
+ "description": "The value that all metadata matched by the data filters will be updated to."
+ },
+ "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"
+ }
+ },
+ "id": "UpdateDeveloperMetadataRequest"
+ },
+ "WaterfallChartColumnStyle": {
+ "id": "WaterfallChartColumnStyle",
+ "description": "Styles for a waterfall chart column.",
+ "type": "object",
+ "properties": {
+ "label": {
+ "description": "The label of the column's legend.",
+ "type": "string"
+ },
+ "color": {
+ "$ref": "Color",
+ "description": "The color of the column."
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "id": "UpdateFilterViewRequest"
+ },
+ "ConditionalFormatRule": {
+ "description": "A rule describing a conditional format.",
+ "type": "object",
+ "properties": {
+ "ranges": {
+ "description": "The ranges that will be formatted if the condition is true.\nAll the ranges must be on the same grid.",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ },
+ "gradientRule": {
+ "$ref": "GradientRule",
+ "description": "The formatting will vary based on the gradients in the rule."
+ },
+ "booleanRule": {
+ "$ref": "BooleanRule",
+ "description": "The formatting is either \"on\" or \"off\" according to the rule."
+ }
+ },
+ "id": "ConditionalFormatRule"
+ },
+ "CopyPasteRequest": {
+ "id": "CopyPasteRequest",
+ "description": "Copies data from the source to the destination.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "GridRange",
+ "description": "The source range to copy."
+ },
+ "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": {
+ "enumDescriptions": [
+ "Paste normally.",
+ "Paste transposed, where all rows become columns and vice versa."
+ ],
+ "enum": [
+ "NORMAL",
+ "TRANSPOSE"
+ ],
+ "description": "How that data should be oriented when pasting.",
+ "type": "string"
+ }
+ }
+ },
+ "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": {
+ "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."
+ ],
+ "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"
+ ]
+ },
+ "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": {
+ "deleteRange": {
+ "description": "Deletes a range of cells from a sheet, shifting the remaining cells.",
+ "$ref": "DeleteRangeRequest"
+ },
+ "deleteBanding": {
+ "$ref": "DeleteBandingRequest",
+ "description": "Removes a banded range"
+ },
+ "addFilterView": {
+ "description": "Adds a filter view.",
+ "$ref": "AddFilterViewRequest"
+ },
+ "updateBorders": {
+ "description": "Updates the borders in a range of cells.",
+ "$ref": "UpdateBordersRequest"
+ },
+ "setDataValidation": {
+ "$ref": "SetDataValidationRequest",
+ "description": "Sets data validation for one or more cells."
+ },
+ "deleteConditionalFormatRule": {
+ "description": "Deletes an existing conditional format rule.",
+ "$ref": "DeleteConditionalFormatRuleRequest"
+ },
+ "clearBasicFilter": {
+ "description": "Clears the basic filter on a sheet.",
+ "$ref": "ClearBasicFilterRequest"
+ },
+ "repeatCell": {
+ "description": "Repeats a single cell across a range.",
+ "$ref": "RepeatCellRequest"
+ },
+ "appendDimension": {
+ "$ref": "AppendDimensionRequest",
+ "description": "Appends dimensions to the end of a sheet."
+ },
+ "createDeveloperMetadata": {
+ "description": "Creates new developer metadata",
+ "$ref": "CreateDeveloperMetadataRequest"
+ },
+ "updateConditionalFormatRule": {
+ "$ref": "UpdateConditionalFormatRuleRequest",
+ "description": "Updates an existing conditional format rule."
+ },
+ "insertRange": {
+ "description": "Inserts new cells in a sheet, shifting the existing cells.",
+ "$ref": "InsertRangeRequest"
+ },
+ "moveDimension": {
+ "description": "Moves rows or columns to another location in a sheet.",
+ "$ref": "MoveDimensionRequest"
+ },
+ "deleteDeveloperMetadata": {
+ "description": "Deletes developer metadata",
+ "$ref": "DeleteDeveloperMetadataRequest"
+ },
+ "randomizeRange": {
+ "$ref": "RandomizeRangeRequest",
+ "description": "Randomizes the order of the rows in a range."
+ },
+ "updateBanding": {
+ "$ref": "UpdateBandingRequest",
+ "description": "Updates a banded range"
+ },
+ "addProtectedRange": {
+ "$ref": "AddProtectedRangeRequest",
+ "description": "Adds a protected range."
+ },
+ "deleteNamedRange": {
+ "$ref": "DeleteNamedRangeRequest",
+ "description": "Deletes a named range."
+ },
+ "duplicateSheet": {
+ "description": "Duplicates a sheet.",
+ "$ref": "DuplicateSheetRequest"
+ },
+ "deleteSheet": {
+ "$ref": "DeleteSheetRequest",
+ "description": "Deletes a sheet."
+ },
+ "unmergeCells": {
+ "description": "Unmerges merged cells.",
+ "$ref": "UnmergeCellsRequest"
+ },
+ "updateEmbeddedObjectPosition": {
+ "$ref": "UpdateEmbeddedObjectPositionRequest",
+ "description": "Updates an embedded object's (e.g. chart, image) position."
+ },
+ "updateDimensionProperties": {
+ "description": "Updates dimensions' properties.",
+ "$ref": "UpdateDimensionPropertiesRequest"
+ },
+ "updateDeveloperMetadata": {
+ "$ref": "UpdateDeveloperMetadataRequest",
+ "description": "Updates an existing developer metadata entry"
+ },
+ "pasteData": {
+ "$ref": "PasteDataRequest",
+ "description": "Pastes data (HTML or delimited) into a sheet."
+ },
+ "setBasicFilter": {
+ "description": "Sets the basic filter on a sheet.",
+ "$ref": "SetBasicFilterRequest"
+ },
+ "addConditionalFormatRule": {
+ "$ref": "AddConditionalFormatRuleRequest",
+ "description": "Adds a new conditional format rule."
+ },
+ "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": {
+ "$ref": "DeleteEmbeddedObjectRequest",
+ "description": "Deletes an embedded object (e.g, chart, image) in a sheet."
+ },
+ "updateFilterView": {
+ "$ref": "UpdateFilterViewRequest",
+ "description": "Updates the properties of a filter view."
+ },
+ "addBanding": {
+ "$ref": "AddBandingRequest",
+ "description": "Adds a new banded range"
+ },
+ "autoResizeDimensions": {
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
+ "$ref": "AutoResizeDimensionsRequest"
+ },
+ "appendCells": {
+ "description": "Appends cells after the last row with data in a sheet.",
+ "$ref": "AppendCellsRequest"
+ },
+ "cutPaste": {
+ "$ref": "CutPasteRequest",
+ "description": "Cuts data from one area and pastes it to another."
+ },
+ "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": {
+ "$ref": "SortRangeRequest",
+ "description": "Sorts data in a range."
+ },
+ "deleteProtectedRange": {
+ "$ref": "DeleteProtectedRangeRequest",
+ "description": "Deletes a protected range."
+ },
+ "duplicateFilterView": {
+ "description": "Duplicates a filter view.",
+ "$ref": "DuplicateFilterViewRequest"
+ },
+ "addChart": {
+ "$ref": "AddChartRequest",
+ "description": "Adds a chart."
+ },
+ "findReplace": {
+ "$ref": "FindReplaceRequest",
+ "description": "Finds and replaces occurrences of some text with other text."
+ },
+ "textToColumns": {
+ "description": "Converts a column of text into many columns of text.",
+ "$ref": "TextToColumnsRequest"
+ },
+ "updateChartSpec": {
+ "description": "Updates a chart's specifications.",
+ "$ref": "UpdateChartSpecRequest"
+ },
+ "addSheet": {
+ "$ref": "AddSheetRequest",
+ "description": "Adds a sheet."
+ },
+ "updateProtectedRange": {
+ "description": "Updates a protected range.",
+ "$ref": "UpdateProtectedRangeRequest"
+ },
+ "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": {
+ "$ref": "InsertDimensionRequest",
+ "description": "Inserts new rows or columns in a sheet."
+ }
+ },
+ "id": "Request"
+ },
+ "WaterfallChartDomain": {
+ "id": "WaterfallChartDomain",
+ "description": "The domain of a waterfall chart.",
+ "type": "object",
+ "properties": {
+ "reversed": {
+ "description": "True to reverse the order of the domain values (horizontal axis).",
+ "type": "boolean"
+ },
+ "data": {
+ "$ref": "ChartData",
+ "description": "The data of the WaterfallChartDomain."
+ }
+ }
+ },
+ "GridRange": {
+ "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",
+ "properties": {
+ "startRowIndex": {
+ "description": "The start row (inclusive) of the range, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startColumnIndex": {
+ "description": "The start column (inclusive) of the range, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet this range is on.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ }
+ }
}
},
+ "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": "Sheets",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/drive.file": {
- "description": "View and manage Google Drive files and folders that you have opened or created with this app"
- },
"https://www.googleapis.com/auth/drive": {
"description": "View and manage the files in your Google Drive"
},
@@ -4826,6 +4819,9 @@
},
"https://www.googleapis.com/auth/spreadsheets": {
"description": "View and manage your spreadsheets in Google Drive"
+ },
+ "https://www.googleapis.com/auth/drive.file": {
+ "description": "View and manage Google Drive files and folders that you have opened or created with this app"
}
}
}
@@ -4839,6 +4835,55 @@
"resources": {
"spreadsheets": {
"methods": {
+ "create": {
+ "request": {
+ "$ref": "Spreadsheet"
+ },
+ "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets",
+ "path": "v4/spreadsheets",
+ "id": "sheets.spreadsheets.create"
+ },
+ "batchUpdate": {
+ "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
+ "id": "sheets.spreadsheets.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.",
+ "response": {
+ "$ref": "BatchUpdateSpreadsheetResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The spreadsheet to apply the updates to.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate"
+ },
"get": {
"response": {
"$ref": "Spreadsheet"
@@ -4848,22 +4893,22 @@
],
"httpMethod": "GET",
"parameters": {
- "ranges": {
- "description": "The ranges to retrieve from the spreadsheet.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "includeGridData": {
- "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
- "type": "boolean",
- "location": "query"
- },
"spreadsheetId": {
- "location": "path",
"description": "The spreadsheet to request.",
"required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "ranges": {
+ "repeated": true,
+ "location": "query",
+ "description": "The ranges to retrieve from the spreadsheet.",
"type": "string"
+ },
+ "includeGridData": {
+ "location": "query",
+ "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
+ "type": "boolean"
}
},
"scopes": [
@@ -4879,10 +4924,10 @@
"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"
},
+ "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nThis method differs from GetSpreadsheet in that it allows selecting\nwhich subsets of spreadsheet data to return by specifying a\ndataFilters parameter.\nMultiple DataFilters can be specified. Specifying one or\nmore data filters will return the portions of the spreadsheet that\nintersect ranges matched by any of the filters.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nparameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.",
"httpMethod": "POST",
"parameterOrder": [
"spreadsheetId"
@@ -4890,11 +4935,6 @@
"response": {
"$ref": "Spreadsheet"
},
- "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.",
@@ -4903,58 +4943,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}:getByDataFilter",
"id": "sheets.spreadsheets.getByDataFilter",
"path": "v4/spreadsheets/{spreadsheetId}:getByDataFilter"
- },
- "create": {
- "request": {
- "$ref": "Spreadsheet"
- },
- "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Spreadsheet"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets",
- "id": "sheets.spreadsheets.create",
- "path": "v4/spreadsheets"
- },
- "batchUpdate": {
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchUpdateSpreadsheetResponse"
- },
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The spreadsheet to apply the updates to.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
- "id": "sheets.spreadsheets.batchUpdate",
- "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
- "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."
}
},
"resources": {
@@ -4968,28 +4964,29 @@
"response": {
"$ref": "SearchDeveloperMetadataResponse"
},
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve metadata 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"
],
- "parameters": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to retrieve metadata from.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
"flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
"id": "sheets.spreadsheets.developerMetadata.search",
"path": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
- "description": "Returns all developer metadata matching the specified DataFilter.\nIf the provided DataFilter represents a DeveloperMetadataLookup object,\nthis will return all DeveloperMetadata entries selected by it. If the\nDataFilter represents a location in a spreadsheet, this will return all\ndeveloper metadata associated with locations intersecting that region.",
"request": {
"$ref": "SearchDeveloperMetadataRequest"
- }
+ },
+ "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."
},
"get": {
+ "description": "Returns the developer metadata with the specified ID.\nThe caller must specify the spreadsheet ID and the developer metadata's\nunique metadataId.",
"response": {
"$ref": "DeveloperMetadata"
},
@@ -4998,6 +4995,11 @@
"metadataId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
"parameters": {
"spreadsheetId": {
"location": "path",
@@ -5006,86 +5008,197 @@
"type": "string"
},
"metadataId": {
+ "location": "path",
"description": "The ID of the developer metadata to retrieve.",
"format": "int32",
"required": true,
- "type": "integer",
- "location": "path"
+ "type": "integer"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
"flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
"path": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
- "id": "sheets.spreadsheets.developerMetadata.get",
- "description": "Returns the developer metadata with the specified ID.\nThe caller must specify the spreadsheet ID and the developer metadata's\nunique metadataId."
+ "id": "sheets.spreadsheets.developerMetadata.get"
}
}
},
"values": {
"methods": {
- "batchClearByDataFilter": {
- "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges matching any of the specified data\nfilters will be cleared. Only values are cleared -- all other properties\nof the cell (such as formatting, data validation, etc..) are kept.",
- "request": {
- "$ref": "BatchClearValuesByDataFilterRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchClearValuesByDataFilterResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
+ "batchGetByDataFilter": {
"parameters": {
"spreadsheetId": {
- "description": "The ID of the spreadsheet to update.",
+ "description": "The ID of the spreadsheet to retrieve data from.",
"required": true,
"type": "string",
"location": "path"
}
},
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
- "id": "sheets.spreadsheets.values.batchClearByDataFilter",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter"
- },
- "append": {
- "description": "Appends values to a spreadsheet. The input range is used to search for\nexisting data and find a \"table\" within that range. Values will be\nappended to the next row of the table, starting with the first column of\nthe table. See the\n[guide](/sheets/api/guides/values#appending_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption` only\ncontrols how the input data will be added to the sheet (column-wise or\nrow-wise), it does not influence what cell the data starts being written\nto.",
- "request": {
- "$ref": "ValueRange"
- },
- "response": {
- "$ref": "AppendValuesResponse"
- },
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "httpMethod": "POST",
"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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "response": {
+ "$ref": "BatchGetValuesByDataFilterResponse"
+ }
+ },
+ "batchClear": {
"parameters": {
- "includeValuesInResponse": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values: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"
+ }
+ },
+ "get": {
+ "description": "Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "response": {
+ "$ref": "ValueRange"
+ },
+ "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",
- "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values.",
- "type": "boolean"
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ]
+ },
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "required": true,
+ "type": "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.",
+ "location": "path",
+ "description": "The A1 notation of the values to retrieve.",
+ "required": true,
+ "type": "string"
+ },
+ "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}",
+ "id": "sheets.spreadsheets.values.get",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}"
+ },
+ "batchUpdateByDataFilter": {
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
+ "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.",
+ "response": {
+ "$ref": "BatchUpdateValuesByDataFilterResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST"
+ },
+ "update": {
+ "request": {
+ "$ref": "ValueRange"
+ },
+ "description": "Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption.",
+ "response": {
+ "$ref": "UpdateValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "range": {
+ "description": "The A1 notation of the values to update.",
"required": true,
"type": "string",
"location": "path"
},
+ "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.\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",
+ "location": "query"
+ },
"spreadsheetId": {
"location": "path",
"description": "The ID of the spreadsheet to update.",
@@ -5102,6 +5215,242 @@
"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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "id": "sheets.spreadsheets.values.update"
+ },
+ "batchUpdate": {
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
+ "id": "sheets.spreadsheets.values.batchUpdate",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
+ "request": {
+ "$ref": "BatchUpdateValuesRequest"
+ },
+ "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nValueRanges.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "response": {
+ "$ref": "BatchUpdateValuesResponse"
+ }
+ },
+ "batchGet": {
+ "id": "sheets.spreadsheets.values.batchGet",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
+ "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "response": {
+ "$ref": "BatchGetValuesResponse"
+ },
+ "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": {
+ "ranges": {
+ "description": "The A1 notation of the values to retrieve.",
+ "type": "string",
+ "repeated": true,
+ "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"
+ ]
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "valueRenderOption": {
+ "location": "query",
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string"
+ },
+ "dateTimeRenderOption": {
+ "location": "query",
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ],
+ "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGet"
+ },
+ "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"
+ },
+ "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": {
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "range": {
+ "description": "The A1 notation of the values to clear.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
+ "id": "sheets.spreadsheets.values.clear"
+ },
+ "batchClearByDataFilter": {
+ "request": {
+ "$ref": "BatchClearValuesByDataFilterRequest"
+ },
+ "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges matching any of the specified data\nfilters will be cleared. Only values are cleared -- all other properties\nof the cell (such as formatting, data validation, etc..) are kept.",
+ "response": {
+ "$ref": "BatchClearValuesByDataFilterResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
+ "id": "sheets.spreadsheets.values.batchClearByDataFilter"
+ },
+ "append": {
+ "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"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "responseDateTimeRenderOption": {
+ "location": "query",
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ],
+ "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string"
+ },
+ "includeValuesInResponse": {
+ "location": "query",
+ "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values.",
+ "type": "boolean"
+ },
+ "range": {
+ "location": "path",
+ "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table.",
+ "required": true,
+ "type": "string"
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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": {
"description": "How the input data should be inserted.",
"type": "string",
@@ -5120,410 +5469,57 @@
"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"
}
},
+ "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}:append",
"path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
"id": "sheets.spreadsheets.values.append"
- },
- "batchGetByDataFilter": {
- "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.",
- "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"
- ]
- },
- "batchClear": {
- "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
- "request": {
- "$ref": "BatchClearValuesRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchClearValuesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
- "id": "sheets.spreadsheets.values.batchClear",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear"
- },
- "get": {
- "description": "Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ValueRange"
- },
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "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": {
- "description": "The ID of the spreadsheet to retrieve data from.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "id": "sheets.spreadsheets.values.get",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}"
- },
- "update": {
- "description": "Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption.",
- "request": {
- "$ref": "ValueRange"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "response": {
- "$ref": "UpdateValuesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "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.\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",
- "location": "query"
- },
- "range": {
- "description": "The A1 notation of the values to update.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string"
- },
- "responseValueRenderOption": {
- "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"
- ]
- },
- "valueInputOption": {
- "description": "How the input data should be interpreted.",
- "type": "string",
- "location": "query",
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ]
- },
- "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"
- ]
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "id": "sheets.spreadsheets.values.update",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}"
- },
- "batchUpdateByDataFilter": {
- "response": {
- "$ref": "BatchUpdateValuesByDataFilterResponse"
- },
- "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: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": {
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
- "id": "sheets.spreadsheets.values.batchUpdate",
- "request": {
- "$ref": "BatchUpdateValuesRequest"
- },
- "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nValueRanges.",
- "response": {
- "$ref": "BatchUpdateValuesResponse"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ]
- },
- "clear": {
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
- "id": "sheets.spreadsheets.values.clear",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
- "request": {
- "$ref": "ClearValuesRequest"
- },
- "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "response": {
- "$ref": "ClearValuesResponse"
- },
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string"
- },
- "range": {
- "description": "The A1 notation of the values to clear.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ]
- },
- "batchGet": {
- "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.",
- "httpMethod": "GET",
- "response": {
- "$ref": "BatchGetValuesResponse"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "parameters": {
- "ranges": {
- "location": "query",
- "description": "The A1 notation of the values to retrieve.",
- "type": "string",
- "repeated": true
- },
- "majorDimension": {
- "location": "query",
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
- "type": "string"
- },
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to retrieve data from.",
- "required": true,
- "type": "string"
- },
- "valueRenderOption": {
- "location": "query",
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string"
- },
- "dateTimeRenderOption": {
- "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string",
- "location": "query",
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ]
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
- "id": "sheets.spreadsheets.values.batchGet",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchGet"
}
}
},
"sheets": {
"methods": {
"copyTo": {
- "httpMethod": "POST",
+ "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet.",
+ "request": {
+ "$ref": "CopySheetToAnotherSpreadsheetRequest"
+ },
+ "response": {
+ "$ref": "SheetProperties"
+ },
"parameterOrder": [
"spreadsheetId",
"sheetId"
],
- "response": {
- "$ref": "SheetProperties"
- },
+ "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 containing the sheet to copy.",
+ "required": true,
+ "type": "string"
+ },
"sheetId": {
"location": "path",
"description": "The ID of the sheet to copy.",
"format": "int32",
"required": true,
"type": "integer"
- },
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet containing the sheet to copy.",
- "required": true,
- "type": "string"
}
},
"flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
- "id": "sheets.spreadsheets.sheets.copyTo",
"path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
- "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet.",
- "request": {
- "$ref": "CopySheetToAnotherSpreadsheetRequest"
- }
+ "id": "sheets.spreadsheets.sheets.copyTo"
}
}
}
@@ -5531,22 +5527,6 @@
}
},
"parameters": {
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
@@ -5558,22 +5538,19 @@
"type": "boolean",
"default": "true"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
+ "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"
@@ -5582,11 +5559,20 @@
"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": [
@@ -5594,18 +5580,12 @@
"media",
"proto"
],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
+ "type": "string"
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"key": {
"location": "query",
@@ -5616,7 +5596,27 @@
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
}
},
- "version": "v4"
+ "version": "v4",
+ "baseUrl": "https://sheets.googleapis.com/",
+ "servicePath": "",
+ "kind": "discovery#restDescription",
+ "description": "Reads and writes Google Sheets."
}
diff --git a/slides/v1/slides-api.json b/slides/v1/slides-api.json
index e276371..863044c 100644
--- a/slides/v1/slides-api.json
+++ b/slides/v1/slides-api.json
@@ -1,37 +1,4 @@
{
- "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": "Slides",
- "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"
- },
- "https://www.googleapis.com/auth/spreadsheets.readonly": {
- "description": "View your Google Spreadsheets"
- },
- "https://www.googleapis.com/auth/drive": {
- "description": "View and manage the files in your Google Drive"
- },
- "https://www.googleapis.com/auth/drive.readonly": {
- "description": "View the files in your Google Drive"
- },
- "https://www.googleapis.com/auth/spreadsheets": {
- "description": "View and manage your spreadsheets in Google Drive"
- }
- }
- }
- },
"rootUrl": "https://slides.googleapis.com/",
"ownerDomain": "google.com",
"name": "slides",
@@ -40,46 +7,93 @@
"ownerName": "Google",
"resources": {
"presentations": {
+ "methods": {
+ "get": {
+ "description": "Gets the latest version of the specified presentation.",
+ "response": {
+ "$ref": "Presentation"
+ },
+ "parameterOrder": [
+ "presentationId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "presentationId": {
+ "location": "path",
+ "description": "The ID of the presentation to retrieve.",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/presentations",
+ "https://www.googleapis.com/auth/presentations.readonly"
+ ],
+ "flatPath": "v1/presentations/{presentationsId}",
+ "path": "v1/presentations/{+presentationId}",
+ "id": "slides.presentations.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": {
+ "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.",
+ "response": {
+ "$ref": "BatchUpdatePresentationResponse"
+ },
+ "parameterOrder": [
+ "presentationId"
+ ],
+ "httpMethod": "POST",
+ "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",
+ "path": "v1/presentations/{presentationId}:batchUpdate",
+ "id": "slides.presentations.batchUpdate"
+ }
+ },
"resources": {
"pages": {
"methods": {
- "get": {
- "response": {
- "$ref": "Page"
- },
- "parameterOrder": [
- "presentationId",
- "pageObjectId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/presentations",
- "https://www.googleapis.com/auth/presentations.readonly"
- ],
- "parameters": {
- "presentationId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the presentation to retrieve."
- },
- "pageObjectId": {
- "location": "path",
- "description": "The object ID of the page 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."
- },
"getThumbnail": {
- "description": "Generates a thumbnail of the latest version of the specified page in the\npresentation and returns a URL to the thumbnail image.",
"response": {
"$ref": "Thumbnail"
},
@@ -90,10 +104,10 @@
"httpMethod": "GET",
"parameters": {
"pageObjectId": {
- "description": "The object ID of the page whose thumbnail to retrieve.",
"required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "The object ID of the page whose thumbnail to retrieve."
},
"thumbnailProperties.mimeType": {
"type": "string",
@@ -128,137 +142,56 @@
],
"flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
"path": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
- "id": "slides.presentations.pages.getThumbnail"
+ "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": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "presentationId",
+ "pageObjectId"
+ ],
+ "response": {
+ "$ref": "Page"
+ },
+ "parameters": {
+ "pageObjectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The object ID of the page to retrieve."
+ },
+ "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}",
+ "id": "slides.presentations.pages.get",
+ "path": "v1/presentations/{presentationId}/pages/{pageObjectId}",
+ "description": "Gets the latest version of the specified page in the presentation."
}
}
}
- },
- "methods": {
- "get": {
- "response": {
- "$ref": "Presentation"
- },
- "parameterOrder": [
- "presentationId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "presentationId": {
- "location": "path",
- "description": "The ID of the presentation to retrieve.",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/presentations",
- "https://www.googleapis.com/auth/presentations.readonly"
- ],
- "flatPath": "v1/presentations/{presentationsId}",
- "path": "v1/presentations/{+presentationId}",
- "id": "slides.presentations.get",
- "description": "Gets the latest version of the specified presentation."
- },
- "create": {
- "description": "Creates a new presentation using the title given in the request. Other\nfields in the request are ignored.\nReturns the created presentation.",
- "request": {
- "$ref": "Presentation"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Presentation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/presentations"
- ],
- "parameters": {},
- "flatPath": "v1/presentations",
- "id": "slides.presentations.create",
- "path": "v1/presentations"
- },
- "batchUpdate": {
- "response": {
- "$ref": "BatchUpdatePresentationResponse"
- },
- "parameterOrder": [
- "presentationId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "presentationId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The presentation to apply the updates to."
- }
- },
- "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",
- "path": "v1/presentations/{presentationId}:batchUpdate",
- "id": "slides.presentations.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",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -267,12 +200,7 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "default": "json"
},
"access_token": {
"location": "query",
@@ -280,14 +208,14 @@
"type": "string"
},
"key": {
+ "type": "string",
"location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "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"
+ "description": "Available 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",
@@ -301,55 +229,1168 @@
"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": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "uploadType": {
"type": "string",
"location": "query",
- "description": "OAuth bearer token."
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format."
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
}
},
"version": "v1",
"baseUrl": "https://slides.googleapis.com/",
- "servicePath": "",
- "description": "An API for creating and editing Google Slides presentations.",
"kind": "discovery#restDescription",
+ "description": "An API for creating and editing Google Slides presentations.",
+ "servicePath": "",
"basePath": "",
- "revision": "20180117",
- "documentationLink": "https://developers.google.com/slides/",
"id": "slides:v1",
+ "documentationLink": "https://developers.google.com/slides/",
+ "revision": "20180117",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "ThemeColorPair": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "enum": [
+ "THEME_COLOR_TYPE_UNSPECIFIED",
+ "DARK1",
+ "LIGHT1",
+ "DARK2",
+ "LIGHT2",
+ "ACCENT1",
+ "ACCENT2",
+ "ACCENT3",
+ "ACCENT4",
+ "ACCENT5",
+ "ACCENT6",
+ "HYPERLINK",
+ "FOLLOWED_HYPERLINK",
+ "TEXT1",
+ "BACKGROUND1",
+ "TEXT2",
+ "BACKGROUND2"
+ ],
+ "description": "The type of the theme color.",
+ "type": "string",
+ "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."
+ ]
+ },
+ "color": {
+ "$ref": "RgbColor",
+ "description": "The concrete color corresponding to the theme color type above."
+ }
+ },
+ "id": "ThemeColorPair",
+ "description": "A pair mapping a theme color type to the concrete color it represents."
+ },
+ "OptionalColor": {
+ "type": "object",
+ "properties": {
+ "opaqueColor": {
+ "$ref": "OpaqueColor",
+ "description": "If set, this will be used as an opaque color. If unset, this represents\na transparent color."
+ }
+ },
+ "id": "OptionalColor",
+ "description": "A color that can either be fully opaque or fully transparent."
+ },
+ "PageElementProperties": {
+ "type": "object",
+ "properties": {
+ "transform": {
+ "$ref": "AffineTransform",
+ "description": "The transform for the element."
+ },
+ "pageObjectId": {
+ "description": "The object ID of the page where the element is located.",
+ "type": "string"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "The size of the element."
+ }
+ },
+ "id": "PageElementProperties",
+ "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."
+ },
+ "SheetsChartProperties": {
+ "description": "The properties of the SheetsChart.",
+ "type": "object",
+ "properties": {
+ "chartImageProperties": {
+ "$ref": "ImageProperties",
+ "description": "The properties of the embedded chart image."
+ }
+ },
+ "id": "SheetsChartProperties"
+ },
+ "StretchedPictureFill": {
+ "type": "object",
+ "properties": {
+ "contentUrl": {
+ "description": "Reading the content_url:\n\nAn URL to a picture with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the picture as the original requester. Access to the\npicture may be lost if the presentation's sharing settings change.\n\nWriting the content_url:\n\nThe picture is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Pictures must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at most 2 kB in length.",
+ "type": "string"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "The original size of the picture fill. This field is read-only."
+ }
+ },
+ "id": "StretchedPictureFill",
+ "description": "The stretched picture fill. The page or page element is filled entirely with\nthe specified picture. The picture is stretched to fit its container."
+ },
+ "DeleteTableColumnRequest": {
+ "description": "Deletes a column from a table.",
+ "type": "object",
+ "properties": {
+ "tableObjectId": {
+ "type": "string",
+ "description": "The table to delete columns from."
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The reference table cell location from which a column will be deleted.\n\nThe column this cell spans will be deleted. If this is a merged cell,\nmultiple columns will be deleted. If no columns remain in the table after\nthis deletion, the whole table is deleted."
+ }
+ },
+ "id": "DeleteTableColumnRequest"
+ },
+ "UpdateTextStyleRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the shape or table with the text to be styled.",
+ "type": "string"
+ },
+ "textRange": {
+ "$ref": "Range",
+ "description": "The range of text to style.\n\nThe range may be extended to include adjacent newlines.\n\nIf the range fully contains a paragraph belonging to a list, the\nparagraph's bullet is also updated with the matching text style."
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The location of the cell in the table containing the text to style. If\n`object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not."
+ },
+ "style": {
+ "$ref": "TextStyle",
+ "description": "The style(s) to set on the text.\n\nIf the value for a particular style matches that of the parent, that style\nwill be set to inherit.\n\nCertain text style changes may cause other changes meant to mirror the\nbehavior of the Slides editor. See the documentation of\nTextStyle for more information."
+ },
+ "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",
+ "description": "Update the styling of text in a Shape or\nTable."
+ },
+ "List": {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "listId": {
+ "description": "The ID of the list.",
+ "type": "string"
+ }
+ },
+ "id": "List",
+ "description": "A List describes the look and feel of bullets belonging to paragraphs\nassociated with a list. A paragraph that is part of a list has an implicit\nreference to that list's ID."
+ },
+ "WeightedFontFamily": {
+ "description": "Represents a font family and weight used to style a TextRun.",
+ "type": "object",
+ "properties": {
+ "fontFamily": {
+ "type": "string",
+ "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`."
+ },
+ "weight": {
+ "type": "integer",
+ "description": "The rendered weight of the text. This field can have any value that is a\nmultiple of `100` between `100` and `900`, inclusive. This range\ncorresponds to the numerical values described in the CSS 2.1\nSpecification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),\nwith non-numerical values disallowed. Weights greater than or equal to\n`700` are considered bold, and weights less than `700`are not bold. The\ndefault value is `400` (\"normal\").",
+ "format": "int32"
+ }
+ },
+ "id": "WeightedFontFamily"
+ },
+ "PageElement": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "The title of the page element. Combined with description to display alt\ntext.",
+ "type": "string"
+ },
+ "sheetsChart": {
+ "$ref": "SheetsChart",
+ "description": "A linked chart embedded from Google Sheets. Unlinked charts are\nrepresented as images."
+ },
+ "video": {
+ "$ref": "Video",
+ "description": "A video page element."
+ },
+ "wordArt": {
+ "$ref": "WordArt",
+ "description": "A word art page element."
+ },
+ "table": {
+ "$ref": "Table",
+ "description": "A table page element."
+ },
+ "transform": {
+ "$ref": "AffineTransform",
+ "description": "The transform of the page element.\n\nThe visual appearance of the page element is determined by its absolute\ntransform. To compute the absolute transform, preconcatenate a page\nelement's transform with the transforms of all of its parent groups. If the\npage element is not in a group, its absolute transform is the same as the\nvalue in this field.\n\nThe initial transform for the newly created Group is always the identity transform."
+ },
+ "objectId": {
+ "description": "The object ID for this page element. Object IDs used by\ngoogle.apps.slides.v1.Page and\ngoogle.apps.slides.v1.PageElement share the same namespace.",
+ "type": "string"
+ },
+ "shape": {
+ "$ref": "Shape",
+ "description": "A generic shape."
+ },
+ "line": {
+ "$ref": "Line",
+ "description": "A line page element."
+ },
+ "description": {
+ "description": "The description of the page element. Combined with title to display alt\ntext.",
+ "type": "string"
+ },
+ "elementGroup": {
+ "$ref": "Group",
+ "description": "A collection of page elements joined as a single unit."
+ },
+ "image": {
+ "$ref": "Image",
+ "description": "An image page element."
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "The size of the page element."
+ }
+ },
+ "id": "PageElement",
+ "description": "A visual element rendered on a page."
+ },
+ "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."
+ },
+ "url": {
+ "type": "string",
+ "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at most 2 kB in length."
+ }
+ },
+ "id": "CreateImageRequest"
+ },
+ "CreateParagraphBulletsRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the shape or table containing the text to add bullets to."
+ },
+ "textRange": {
+ "$ref": "Range",
+ "description": "The range of text to apply the bullet presets to, based on TextElement indexes."
+ },
+ "bulletPreset": {
+ "type": "string",
+ "enumDescriptions": [
+ "A bulleted list with a `DISC`, `CIRCLE` and `SQUARE` bullet glyph for the\nfirst 3 list nesting levels.",
+ "A bulleted list with a `DIAMONDX`, `ARROW3D` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with `CHECKBOX` bullet glyphs for all list nesting levels.",
+ "A bulleted list with a `ARROW`, `DIAMOND` and `DISC` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with a `STAR`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with a `ARROW3D`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with a `LEFTTRIANGLE`, `DIAMOND` and `DISC` bullet glyph\nfor the first 3 list nesting levels.",
+ "A bulleted list with a `DIAMONDX`, `HOLLOWDIAMOND` and `SQUARE` bullet\nglyph for the first 3 list nesting levels.",
+ "A bulleted list with a `DIAMOND`, `CIRCLE` and `SQUARE` bullet glyph\nfor the first 3 list nesting levels.",
+ "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
+ "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by parenthesis.",
+ "A numbered list with `DIGIT` numeric glyphs separated by periods, where\neach nesting level uses the previous nesting level's glyph as a prefix.\nFor example: '1.', '1.1.', '2.', '2.2.'.",
+ "A numbered list with `UPPERALPHA`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
+ "A numbered list with `UPPERROMAN`, `UPPERALPHA` and `DIGIT` numeric glyphs\nfor the first 3 list nesting levels, followed by periods.",
+ "A numbered list with `ZERODIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods."
+ ],
+ "enum": [
+ "BULLET_DISC_CIRCLE_SQUARE",
+ "BULLET_DIAMONDX_ARROW3D_SQUARE",
+ "BULLET_CHECKBOX",
+ "BULLET_ARROW_DIAMOND_DISC",
+ "BULLET_STAR_CIRCLE_SQUARE",
+ "BULLET_ARROW3D_CIRCLE_SQUARE",
+ "BULLET_LEFTTRIANGLE_DIAMOND_DISC",
+ "BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE",
+ "BULLET_DIAMOND_CIRCLE_SQUARE",
+ "NUMBERED_DIGIT_ALPHA_ROMAN",
+ "NUMBERED_DIGIT_ALPHA_ROMAN_PARENS",
+ "NUMBERED_DIGIT_NESTED",
+ "NUMBERED_UPPERALPHA_ALPHA_ROMAN",
+ "NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT",
+ "NUMBERED_ZERODIGIT_ALPHA_ROMAN"
+ ],
+ "description": "The kinds of bullet glyphs to be used. Defaults to the\n`BULLET_DISC_CIRCLE_SQUARE` preset."
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table."
+ }
+ },
+ "id": "CreateParagraphBulletsRequest",
+ "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."
+ },
+ "Size": {
+ "description": "A width and height.",
+ "type": "object",
+ "properties": {
+ "height": {
+ "$ref": "Dimension",
+ "description": "The height of the object."
+ },
+ "width": {
+ "$ref": "Dimension",
+ "description": "The width of the object."
+ }
+ },
+ "id": "Size"
+ },
+ "TextStyle": {
+ "description": "Represents the styling that can be applied to a TextRun.\n\nIf this text is contained in a shape with a parent placeholder, then these text styles may be\ninherited from the parent. Which text styles are inherited depend on the\nnesting level of lists:\n\n* A text run in a paragraph that is not in a list will inherit its text style\n from the the newline character in the paragraph at the 0 nesting level of\n the list inside the parent placeholder.\n* A text run in a paragraph that is in a list will inherit its text style\n from the newline character in the paragraph at its corresponding nesting\n level of the list inside the parent placeholder.\n\nInherited text styles are represented as unset fields in this message. If\ntext is contained in a shape without a parent placeholder, unsetting these\nfields will revert the style to a value matching the defaults in the Slides\neditor.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "type": "boolean",
+ "description": "Whether or not the text is in small capital letters."
+ },
+ "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": {
+ "description": "Whether or not the text is underlined.",
+ "type": "boolean"
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "The hyperlink destination of the text. If unset, there is no link. Links\nare not inherited from parent text.\n\nChanging the link in an update request causes some other changes to the\ntext style of the range:\n\n* When setting a link, the text foreground color will be set to\n ThemeColorType.HYPERLINK and the text will\n be underlined. If these fields are modified in the same\n request, those values will be used instead of the link defaults.\n* Setting a link on a text range that overlaps with an existing link will\n also update the existing link to point to the new URL.\n* Links are not settable on newline characters. As a result, setting a link\n on a text range that crosses a paragraph boundary, such as `\"ABC\\n123\"`,\n will separate the newline character(s) into their own text runs. The\n link will be applied separately to the runs before and after the newline.\n* Removing a link will update the text style of the range to match the\n style of the preceding text (or the default text styles if the preceding\n text is another link) unless different styles are being set in the same\n request."
+ },
+ "bold": {
+ "type": "boolean",
+ "description": "Whether or not the text is rendered as bold."
+ },
+ "foregroundColor": {
+ "$ref": "OptionalColor",
+ "description": "The color of the text itself. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set."
+ },
+ "fontFamily": {
+ "type": "string",
+ "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`.\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."
+ },
+ "italic": {
+ "description": "Whether or not the text is italicized.",
+ "type": "boolean"
+ },
+ "strikethrough": {
+ "description": "Whether or not the text is struck through.",
+ "type": "boolean"
+ },
+ "fontSize": {
+ "$ref": "Dimension",
+ "description": "The size of the text's font. When read, the `font_size` will specified in\npoints."
+ },
+ "baselineOffset": {
+ "type": "string",
+ "enumDescriptions": [
+ "The text's baseline offset is inherited from the parent.",
+ "The text is not vertically offset.",
+ "The text is vertically offset upwards (superscript).",
+ "The text is vertically offset downwards (subscript)."
+ ],
+ "enum": [
+ "BASELINE_OFFSET_UNSPECIFIED",
+ "NONE",
+ "SUPERSCRIPT",
+ "SUBSCRIPT"
+ ],
+ "description": "The text's vertical offset from its normal position.\n\nText with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically\nrendered in a smaller font size, computed based on the `font_size` field.\nThe `font_size` itself is not affected by changes in this field."
+ }
+ },
+ "id": "TextStyle"
+ },
+ "UpdateVideoPropertiesRequest": {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "string",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `videoProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the video outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask"
+ },
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the video the updates are applied to."
+ },
+ "videoProperties": {
+ "$ref": "VideoProperties",
+ "description": "The video properties to update."
+ }
+ },
+ "id": "UpdateVideoPropertiesRequest",
+ "description": "Update the properties of a Video."
+ },
+ "Request": {
+ "description": "A single kind of update to apply to a presentation.",
+ "type": "object",
+ "properties": {
+ "deleteTableRow": {
+ "$ref": "DeleteTableRowRequest",
+ "description": "Deletes a row from a table."
+ },
+ "updateShapeProperties": {
+ "$ref": "UpdateShapePropertiesRequest",
+ "description": "Updates the properties of a Shape."
+ },
+ "groupObjects": {
+ "$ref": "GroupObjectsRequest",
+ "description": "Groups objects, such as page elements."
+ },
+ "ungroupObjects": {
+ "$ref": "UngroupObjectsRequest",
+ "description": "Ungroups objects, such as groups."
+ },
+ "insertText": {
+ "$ref": "InsertTextRequest",
+ "description": "Inserts text into a shape or table cell."
+ },
+ "updateTableColumnProperties": {
+ "$ref": "UpdateTableColumnPropertiesRequest",
+ "description": "Updates the properties of a Table\ncolumn."
+ },
+ "deleteText": {
+ "$ref": "DeleteTextRequest",
+ "description": "Deletes text from a shape or a table cell."
+ },
+ "updatePageProperties": {
+ "$ref": "UpdatePagePropertiesRequest",
+ "description": "Updates the properties of a Page."
+ },
+ "createShape": {
+ "$ref": "CreateShapeRequest",
+ "description": "Creates a new shape."
+ },
+ "deleteParagraphBullets": {
+ "$ref": "DeleteParagraphBulletsRequest",
+ "description": "Deletes bullets from paragraphs."
+ },
+ "updateTableBorderProperties": {
+ "$ref": "UpdateTableBorderPropertiesRequest",
+ "description": "Updates the properties of the table borders in a Table."
+ },
+ "updatePageElementAltText": {
+ "$ref": "UpdatePageElementAltTextRequest",
+ "description": "Updates the alt text title and/or description of a\npage element."
+ },
+ "insertTableColumns": {
+ "$ref": "InsertTableColumnsRequest",
+ "description": "Inserts columns into a table."
+ },
+ "mergeTableCells": {
+ "$ref": "MergeTableCellsRequest",
+ "description": "Merges cells in a Table."
+ },
+ "refreshSheetsChart": {
+ "$ref": "RefreshSheetsChartRequest",
+ "description": "Refreshes a Google Sheets chart."
+ },
+ "updateTableCellProperties": {
+ "$ref": "UpdateTableCellPropertiesRequest",
+ "description": "Updates the properties of a TableCell."
+ },
+ "createTable": {
+ "$ref": "CreateTableRequest",
+ "description": "Creates a new table."
+ },
+ "deleteObject": {
+ "$ref": "DeleteObjectRequest",
+ "description": "Deletes a page or page element from the presentation."
+ },
+ "updateParagraphStyle": {
+ "$ref": "UpdateParagraphStyleRequest",
+ "description": "Updates the styling of paragraphs within a Shape or Table."
+ },
+ "duplicateObject": {
+ "$ref": "DuplicateObjectRequest",
+ "description": "Duplicates a slide or page element."
+ },
+ "deleteTableColumn": {
+ "$ref": "DeleteTableColumnRequest",
+ "description": "Deletes a column from a table."
+ },
+ "createLine": {
+ "$ref": "CreateLineRequest",
+ "description": "Creates a line."
+ },
+ "updateVideoProperties": {
+ "$ref": "UpdateVideoPropertiesRequest",
+ "description": "Updates the properties of a Video."
+ },
+ "createImage": {
+ "$ref": "CreateImageRequest",
+ "description": "Creates an image."
+ },
+ "createParagraphBullets": {
+ "$ref": "CreateParagraphBulletsRequest",
+ "description": "Creates bullets for paragraphs."
+ },
+ "createVideo": {
+ "$ref": "CreateVideoRequest",
+ "description": "Creates a video."
+ },
+ "createSheetsChart": {
+ "$ref": "CreateSheetsChartRequest",
+ "description": "Creates an embedded Google Sheets chart."
+ },
+ "replaceAllShapesWithSheetsChart": {
+ "$ref": "ReplaceAllShapesWithSheetsChartRequest",
+ "description": "Replaces all shapes matching some criteria with a Google Sheets chart."
+ },
+ "unmergeTableCells": {
+ "$ref": "UnmergeTableCellsRequest",
+ "description": "Unmerges cells in a Table."
+ },
+ "updatePageElementTransform": {
+ "$ref": "UpdatePageElementTransformRequest",
+ "description": "Updates the transform of a page element."
+ },
+ "updateTextStyle": {
+ "$ref": "UpdateTextStyleRequest",
+ "description": "Updates the styling of text within a Shape or Table."
+ },
+ "updateTableRowProperties": {
+ "$ref": "UpdateTableRowPropertiesRequest",
+ "description": "Updates the properties of a Table row."
+ },
+ "replaceAllShapesWithImage": {
+ "$ref": "ReplaceAllShapesWithImageRequest",
+ "description": "Replaces all shapes matching some criteria with an image."
+ },
+ "replaceAllText": {
+ "$ref": "ReplaceAllTextRequest",
+ "description": "Replaces all instances of specified text."
+ },
+ "updateImageProperties": {
+ "$ref": "UpdateImagePropertiesRequest",
+ "description": "Updates the properties of an Image."
+ },
+ "createSlide": {
+ "$ref": "CreateSlideRequest",
+ "description": "Creates a new slide."
+ },
+ "insertTableRows": {
+ "$ref": "InsertTableRowsRequest",
+ "description": "Inserts rows into a table."
+ },
+ "updateLineProperties": {
+ "$ref": "UpdateLinePropertiesRequest",
+ "description": "Updates the properties of a Line."
+ },
+ "updateSlidesPosition": {
+ "$ref": "UpdateSlidesPositionRequest",
+ "description": "Updates the position of a set of slides in the presentation."
+ }
+ },
+ "id": "Request"
+ },
+ "UpdateImagePropertiesRequest": {
+ "description": "Update the properties of an Image.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the image the updates are applied to.",
+ "type": "string"
+ },
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `imageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the image outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "imageProperties": {
+ "$ref": "ImageProperties",
+ "description": "The image properties to update."
+ }
+ },
+ "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": {
+ "spaceBelow": {
+ "$ref": "Dimension",
+ "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent."
+ },
+ "direction": {
+ "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"
+ ],
+ "description": "The text direction of this paragraph. If unset, the value defaults to\nLEFT_TO_RIGHT since\ntext direction is not inherited."
+ },
+ "spacingMode": {
+ "enum": [
+ "SPACING_MODE_UNSPECIFIED",
+ "NEVER_COLLAPSE",
+ "COLLAPSE_LISTS"
+ ],
+ "description": "The spacing mode for the paragraph.",
+ "type": "string",
+ "enumDescriptions": [
+ "The spacing mode is inherited from the parent.",
+ "Paragraph spacing is always rendered.",
+ "Paragraph spacing is skipped between list elements."
+ ]
+ },
+ "indentEnd": {
+ "$ref": "Dimension",
+ "description": "The amount indentation for the paragraph on the side that corresponds to\nthe end of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent."
+ },
+ "indentStart": {
+ "$ref": "Dimension",
+ "description": "The amount indentation for the paragraph on the side that corresponds to\nthe start of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent."
+ },
+ "spaceAbove": {
+ "$ref": "Dimension",
+ "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent."
+ },
+ "alignment": {
+ "type": "string",
+ "enumDescriptions": [
+ "The paragraph alignment is inherited from the parent.",
+ "The paragraph is aligned to the start of the line. Left-aligned for\nLTR text, right-aligned otherwise.",
+ "The paragraph is centered.",
+ "The paragraph is aligned to the end of the line. Right-aligned for\nLTR text, left-aligned otherwise.",
+ "The paragraph is justified."
+ ],
+ "enum": [
+ "ALIGNMENT_UNSPECIFIED",
+ "START",
+ "CENTER",
+ "END",
+ "JUSTIFIED"
+ ],
+ "description": "The text alignment for this paragraph."
+ },
+ "lineSpacing": {
+ "type": "number",
+ "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"
+ },
+ "indentFirstLine": {
+ "$ref": "Dimension",
+ "description": "The amount of indentation for the start of the first line of the paragraph.\nIf unset, the value is inherited from the parent."
+ }
+ },
+ "id": "ParagraphStyle"
+ },
+ "UpdateTableRowPropertiesRequest": {
+ "description": "Updates the properties of a Table row.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableRowProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the minimum row height, set `fields` to\n`\"min_row_height\"`.\n\nIf '\"min_row_height\"' is included in the field mask but the property is\nleft unset, the minimum row height will default to 0.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "tableRowProperties": {
+ "$ref": "TableRowProperties",
+ "description": "The table row properties to update."
+ },
+ "objectId": {
+ "description": "The object ID of the table.",
+ "type": "string"
+ },
+ "rowIndices": {
+ "description": "The list of zero-based indices specifying which rows to update. If no\nindices are provided, all rows in the table will be updated.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "id": "UpdateTableRowPropertiesRequest"
+ },
+ "ReplaceAllShapesWithSheetsChartResponse": {
+ "description": "The result of replacing shapes with a Google Sheets chart.",
+ "type": "object",
+ "properties": {
+ "occurrencesChanged": {
+ "type": "integer",
+ "description": "The number of shapes replaced with charts.",
+ "format": "int32"
+ }
+ },
+ "id": "ReplaceAllShapesWithSheetsChartResponse"
+ },
+ "TableCellProperties": {
+ "description": "The properties of the TableCell.",
+ "type": "object",
+ "properties": {
+ "tableCellBackgroundFill": {
+ "$ref": "TableCellBackgroundFill",
+ "description": "The background fill of the table cell. The default fill matches the fill\nfor newly created table cells in the Slides editor."
+ },
+ "contentAlignment": {
+ "enum": [
+ "CONTENT_ALIGNMENT_UNSPECIFIED",
+ "CONTENT_ALIGNMENT_UNSUPPORTED",
+ "TOP",
+ "MIDDLE",
+ "BOTTOM"
+ ],
+ "description": "The alignment of the content in the table cell. The default alignment\nmatches the alignment for newly created table cells in the Slides editor.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified content alignment. The content alignment is inherited from\nthe parent if it exists.",
+ "An unsupported content alignment.",
+ "An alignment that aligns the content to the top of the content holder.\nCorresponds to ECMA-376 ST_TextAnchoringType 't'.",
+ "An alignment that aligns the content to the middle of the content\nholder. Corresponds to ECMA-376 ST_TextAnchoringType 'ctr'.",
+ "An alignment that aligns the content to the bottom of the content\nholder. Corresponds to ECMA-376 ST_TextAnchoringType 'b'."
+ ]
+ }
+ },
+ "id": "TableCellProperties"
+ },
+ "Outline": {
+ "type": "object",
+ "properties": {
+ "outlineFill": {
+ "$ref": "OutlineFill",
+ "description": "The fill of the outline."
+ },
+ "weight": {
+ "$ref": "Dimension",
+ "description": "The thickness of the outline."
+ },
+ "dashStyle": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified dash style.",
+ "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
+ "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
+ "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
+ "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
+ "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
+ "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
+ ],
+ "enum": [
+ "DASH_STYLE_UNSPECIFIED",
+ "SOLID",
+ "DOT",
+ "DASH",
+ "DASH_DOT",
+ "LONG_DASH",
+ "LONG_DASH_DOT"
+ ],
+ "description": "The dash style of the outline."
+ },
+ "propertyState": {
+ "type": "string",
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ],
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ],
+ "description": "The outline property state.\n\nUpdating the outline on a page element will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no outline on a page element, set this field to `NOT_RENDERED`. In\nthis case, any other outline fields set in the same request will be\nignored."
+ }
+ },
+ "id": "Outline",
+ "description": "The outline of a PageElement.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind."
+ },
+ "RefreshSheetsChartRequest": {
+ "description": "Refreshes an embedded Google Sheets chart by replacing it with the latest\nversion of the chart from Google Sheets.\n\nNOTE: Refreshing charts requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the chart to refresh.",
+ "type": "string"
+ }
+ },
+ "id": "RefreshSheetsChartRequest"
+ },
+ "ShapeProperties": {
+ "type": "object",
+ "properties": {
+ "outline": {
+ "$ref": "Outline",
+ "description": "The outline of the shape. If unset, the outline is inherited from a\nparent placeholder if it exists. If the shape has no parent, then the\ndefault outline depends on the shape type, matching the defaults for\nnew shapes created in the Slides editor."
+ },
+ "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": {
+ "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",
+ "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."
+ },
+ "TableColumnProperties": {
+ "type": "object",
+ "properties": {
+ "columnWidth": {
+ "$ref": "Dimension",
+ "description": "Width of a column."
+ }
+ },
+ "id": "TableColumnProperties",
+ "description": "Properties of each column in a table."
+ },
+ "NotesProperties": {
+ "type": "object",
+ "properties": {
+ "speakerNotesObjectId": {
+ "type": "string",
+ "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."
+ }
+ },
+ "id": "NotesProperties",
+ "description": "The properties of Page that are only\nrelevant for pages with page_type NOTES."
+ },
+ "TableRow": {
+ "type": "object",
+ "properties": {
+ "tableRowProperties": {
+ "$ref": "TableRowProperties",
+ "description": "Properties of the row."
+ },
+ "rowHeight": {
+ "$ref": "Dimension",
+ "description": "Height of a row."
+ },
+ "tableCells": {
+ "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",
+ "description": "Properties and contents of each row in a table."
+ },
+ "UpdateTableCellPropertiesRequest": {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "string",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableCellProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table cell background solid fill color, set\n`fields` to `\"tableCellBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask"
+ },
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the table."
+ },
+ "tableRange": {
+ "$ref": "TableRange",
+ "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table."
+ },
+ "tableCellProperties": {
+ "$ref": "TableCellProperties",
+ "description": "The table cell properties to update."
+ }
+ },
+ "id": "UpdateTableCellPropertiesRequest",
+ "description": "Update the properties of a TableCell."
+ },
+ "CreateSlideRequest": {
+ "description": "Creates a new slide.",
+ "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"
+ },
+ "insertionIndex": {
+ "type": "integer",
+ "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"
+ },
+ "placeholderIdMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "LayoutPlaceholderIdMapping"
+ },
+ "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."
+ },
+ "slideLayoutReference": {
+ "$ref": "LayoutReference",
+ "description": "Layout reference of the slide to be inserted, based on the *current\nmaster*, which is one of the following:\n\n- The master of the previous slide index.\n- The master of the first slide, if the insertion_index is zero.\n- The first master in the presentation, if there are no slides.\n\nIf the LayoutReference is not found in the current master, a 400 bad\nrequest error is returned.\n\nIf you don't specify a layout reference, then the new slide will use the\npredefined layout `BLANK`."
+ }
+ },
+ "id": "CreateSlideRequest"
+ },
+ "TableRowProperties": {
+ "description": "Properties of each row in a table.",
+ "type": "object",
+ "properties": {
+ "minRowHeight": {
+ "$ref": "Dimension",
+ "description": "Minimum height of the row. The row will be rendered in the Slides editor at\na height equal to or greater than this value in order to show all the text\nin the row's cell(s)."
+ }
+ },
+ "id": "TableRowProperties"
+ },
+ "BatchUpdatePresentationRequest": {
+ "description": "Request message for PresentationsService.BatchUpdatePresentation.",
+ "type": "object",
+ "properties": {
+ "writeControl": {
+ "$ref": "WriteControl",
+ "description": "Provides control over how write requests are executed."
+ },
+ "requests": {
+ "type": "array",
+ "items": {
+ "$ref": "Request"
+ },
+ "description": "A list of updates to apply to the presentation."
+ }
+ },
+ "id": "BatchUpdatePresentationRequest"
+ },
+ "GroupObjectsResponse": {
+ "description": "The result of grouping objects.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created group.",
+ "type": "string"
+ }
+ },
+ "id": "GroupObjectsResponse"
+ },
+ "TextContent": {
+ "description": "The general text content. The text must reside in a compatible shape (e.g.\ntext box or rectangle) or a table cell in a page.",
+ "type": "object",
+ "properties": {
+ "textElements": {
+ "type": "array",
+ "items": {
+ "$ref": "TextElement"
+ },
+ "description": "The text contents broken down into its component parts, including styling\ninformation. This property is read-only."
+ },
+ "lists": {
+ "additionalProperties": {
+ "$ref": "List"
+ },
+ "description": "The bulleted lists contained in this text, keyed by list ID.",
+ "type": "object"
+ }
+ },
+ "id": "TextContent"
+ },
+ "TableBorderCell": {
+ "type": "object",
+ "properties": {
+ "location": {
+ "$ref": "TableCellLocation",
+ "description": "The location of the border within the border table."
+ },
+ "tableBorderProperties": {
+ "$ref": "TableBorderProperties",
+ "description": "The border properties."
+ }
+ },
+ "id": "TableBorderCell",
+ "description": "The properties of each border cell."
+ },
+ "TableBorderProperties": {
+ "description": "The border styling properties of the\nTableBorderCell.",
+ "type": "object",
+ "properties": {
+ "weight": {
+ "$ref": "Dimension",
+ "description": "The thickness of the border."
+ },
+ "tableBorderFill": {
+ "$ref": "TableBorderFill",
+ "description": "The fill of the table border."
+ },
+ "dashStyle": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified dash style.",
+ "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
+ "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
+ "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
+ "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
+ "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
+ "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
+ ],
+ "enum": [
+ "DASH_STYLE_UNSPECIFIED",
+ "SOLID",
+ "DOT",
+ "DASH",
+ "DASH_DOT",
+ "LONG_DASH",
+ "LONG_DASH_DOT"
+ ],
+ "description": "The dash style of the border."
+ }
+ },
+ "id": "TableBorderProperties"
+ },
+ "CreateSheetsChartResponse": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the created chart."
+ }
+ },
+ "id": "CreateSheetsChartResponse",
+ "description": "The result of creating an embedded Google Sheets chart."
+ },
"WriteControl": {
"description": "Provides control over how write requests are executed.",
"type": "object",
"properties": {
"requiredRevisionId": {
- "description": "The revision ID of the presentation required for the write request. If\nspecified and the `required_revision_id` doesn't exactly match the\npresentation's current `revision_id`, the request will not be processed and\nwill return a 400 bad request error.",
- "type": "string"
+ "type": "string",
+ "description": "The revision ID of the presentation required for the write request. If\nspecified and the `required_revision_id` doesn't exactly match the\npresentation's current `revision_id`, the request will not be processed and\nwill return a 400 bad request error."
}
},
"id": "WriteControl"
},
"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": {
+ "type": "string",
+ "description": "The object ID of the shape or table containing the text to delete bullets\nfrom."
+ },
+ "textRange": {
+ "$ref": "Range",
+ "description": "The range of text to delete bullets from, based on TextElement indexes."
+ },
"cellLocation": {
"$ref": "TableCellLocation",
"description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table."
- },
- "objectId": {
- "description": "The object ID of the shape or table containing the text to delete bullets\nfrom.",
- "type": "string"
- },
- "textRange": {
- "description": "The range of text to delete bullets from, based on TextElement indexes.",
- "$ref": "Range"
}
},
- "id": "DeleteParagraphBulletsRequest"
+ "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."
},
"ParagraphMarker": {
- "description": "A TextElement kind that represents the beginning of a new paragraph.",
"type": "object",
"properties": {
"style": {
@@ -361,24 +1402,46 @@
"description": "The bullet for this paragraph. If not present, the paragraph does not\nbelong to a list."
}
},
- "id": "ParagraphMarker"
+ "id": "ParagraphMarker",
+ "description": "A TextElement kind that represents the beginning of a new paragraph."
+ },
+ "Thumbnail": {
+ "description": "The thumbnail of a page.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "The positive width in pixels of the thumbnail image.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "height": {
+ "type": "integer",
+ "description": "The positive height in pixels of the thumbnail image.",
+ "format": "int32"
+ }
+ },
+ "id": "Thumbnail"
},
"InsertTableColumnsRequest": {
"description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column.",
"type": "object",
"properties": {
"number": {
+ "type": "integer",
"description": "The number of columns to be inserted. Maximum 20 per request.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"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"
+ "$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"
+ "type": "boolean",
+ "description": "Whether to insert new columns to the right of the reference cell location.\n\n- `True`: insert to the right.\n- `False`: insert to the left."
},
"tableObjectId": {
"description": "The table to insert columns into.",
@@ -387,45 +1450,24 @@
},
"id": "InsertTableColumnsRequest"
},
- "Thumbnail": {
- "description": "The thumbnail of a page.",
+ "LayoutPlaceholderIdMapping": {
+ "description": "The user-specified ID mapping for a placeholder that will be created on a\nslide from a specified layout.",
"type": "object",
"properties": {
- "width": {
- "description": "The positive width in pixels of the thumbnail image.",
- "format": "int32",
- "type": "integer"
+ "layoutPlaceholderObjectId": {
+ "type": "string",
+ "description": "The object ID of the placeholder on a layout that will be applied\nto a slide."
},
- "height": {
- "description": "The positive height in pixels of the thumbnail image.",
- "format": "int32",
- "type": "integer"
- },
- "contentUrl": {
- "description": "The content URL of the thumbnail image.\n\nThe URL to the image has a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the image as the original requester. Access to the\nimage may be lost if the presentation's sharing settings change.\nThe mime type of the thumbnail image is the same as specified in the\n`GetPageThumbnailRequest`.",
- "type": "string"
- }
- },
- "id": "Thumbnail"
- },
- "LayoutPlaceholderIdMapping": {
- "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": {
- "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.",
- "$ref": "Placeholder"
- },
- "layoutPlaceholderObjectId": {
- "description": "The object ID of the placeholder on a layout that will be applied\nto a slide.",
- "type": "string"
+ "$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."
}
},
- "id": "LayoutPlaceholderIdMapping",
- "description": "The user-specified ID mapping for a placeholder that will be created on a\nslide from a specified layout.",
- "type": "object"
+ "id": "LayoutPlaceholderIdMapping"
},
"UpdateTableBorderPropertiesRequest": {
"description": "Updates the properties of the table borders in a Table.",
@@ -436,26 +1478,14 @@
"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"
+ "$ref": "TableRange",
+ "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table."
},
"tableBorderProperties": {
"$ref": "TableBorderProperties",
"description": "The table border properties to update."
},
"borderPosition": {
- "enum": [
- "ALL",
- "BOTTOM",
- "INNER",
- "INNER_HORIZONTAL",
- "INNER_VERTICAL",
- "LEFT",
- "OUTER",
- "RIGHT",
- "TOP"
- ],
- "description": "The border position in the table range the updates should apply to. If a\nborder position is not specified, the updates will apply to all borders in\nthe table range.",
"type": "string",
"enumDescriptions": [
"All borders in the range.",
@@ -467,12 +1497,24 @@
"Borders along the outside of the range.",
"Borders at the right of the range.",
"Borders at the top of the range."
- ]
+ ],
+ "enum": [
+ "ALL",
+ "BOTTOM",
+ "INNER",
+ "INNER_HORIZONTAL",
+ "INNER_VERTICAL",
+ "LEFT",
+ "OUTER",
+ "RIGHT",
+ "TOP"
+ ],
+ "description": "The border position in the table range the updates should apply to. If a\nborder position is not specified, the updates will apply to all borders in\nthe table range."
},
"fields": {
+ "type": "string",
"description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableBorderProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table border solid fill color, set\n`fields` to `\"tableBorderFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "format": "google-fieldmask",
- "type": "string"
+ "format": "google-fieldmask"
}
},
"id": "UpdateTableBorderPropertiesRequest"
@@ -480,11 +1522,6 @@
"UpdateShapePropertiesRequest": {
"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"
@@ -492,30 +1529,20 @@
"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."
},
- "WordArt": {
- "description": "A PageElement kind representing\nword art.",
- "type": "object",
- "properties": {
- "renderedText": {
- "description": "The text rendered as word art.",
- "type": "string"
- }
- },
- "id": "WordArt"
- },
"UpdateTableColumnPropertiesRequest": {
+ "description": "Updates the properties of a Table column.",
"type": "object",
"properties": {
- "fields": {
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableColumnProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the column width, set `fields` to `\"column_width\"`.\n\nIf '\"column_width\"' is included in the field mask but the property is left\nunset, the column width will default to 406,400 EMU (32 points).",
- "format": "google-fieldmask",
- "type": "string"
- },
"objectId": {
"description": "The object ID of the table.",
"type": "string"
@@ -524,20 +1551,34 @@
"description": "The list of zero-based indices specifying which columns to update. If no\nindices are provided, all columns in the table will be updated.",
"type": "array",
"items": {
- "format": "int32",
- "type": "integer"
+ "type": "integer",
+ "format": "int32"
}
},
"tableColumnProperties": {
"$ref": "TableColumnProperties",
"description": "The table column properties to update.\n\nIf the value of `table_column_properties#column_width` in the request is\nless than 406,400 EMU (32 points), a 400 bad request error is returned."
+ },
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableColumnProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the column width, set `fields` to `\"column_width\"`.\n\nIf '\"column_width\"' is included in the field mask but the property is left\nunset, the column width will default to 406,400 EMU (32 points).",
+ "format": "google-fieldmask",
+ "type": "string"
}
},
- "id": "UpdateTableColumnPropertiesRequest",
- "description": "Updates the properties of a Table column."
+ "id": "UpdateTableColumnPropertiesRequest"
+ },
+ "WordArt": {
+ "description": "A PageElement kind representing\nword art.",
+ "type": "object",
+ "properties": {
+ "renderedText": {
+ "type": "string",
+ "description": "The text rendered as word art."
+ }
+ },
+ "id": "WordArt"
},
"Recolor": {
- "description": "A recolor effect applied on an image.",
"type": "object",
"properties": {
"recolorStops": {
@@ -548,34 +1589,6 @@
"description": "The recolor effect is represented by a gradient, which is a list of color\nstops.\n\nThe colors in the gradient will replace the corresponding colors at\nthe same position in the color palette and apply to the image. This\nproperty is read-only."
},
"name": {
- "type": "string",
- "enumDescriptions": [
- "No recolor effect. The default value.",
- "A recolor effect that lightens the image using the page's first available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's second\navailable color from its color scheme.",
- "A recolor effect that lightens the image using the page's third available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's forth available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's fifth available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's sixth available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's seventh\navailable color from its color scheme.e.",
- "A recolor effect that lightens the image using the page's eighth\navailable color from its color scheme.",
- "A recolor effect that lightens the image using the page's ninth available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's tenth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's first available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's second available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's third available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's fourth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's fifth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's sixth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's seventh\navailable color from its color scheme.",
- "A recolor effect that darkens the image using the page's eighth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's ninth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's tenth available\ncolor from its color scheme.",
- "A recolor effect that recolors the image to grayscale.",
- "A recolor effect that recolors the image to negative grayscale.",
- "A recolor effect that recolors the image using the sepia color.",
- "Custom recolor effect. Refer to `recolor_stops` for the concrete\ngradient."
- ],
"enum": [
"NONE",
"LIGHT1",
@@ -603,17 +1616,46 @@
"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",
+ "enumDescriptions": [
+ "No recolor effect. The default value.",
+ "A recolor effect that lightens the image using the page's first available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's second\navailable color from its color scheme.",
+ "A recolor effect that lightens the image using the page's third available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's forth available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's fifth available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's sixth available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's seventh\navailable color from its color scheme.e.",
+ "A recolor effect that lightens the image using the page's eighth\navailable color from its color scheme.",
+ "A recolor effect that lightens the image using the page's ninth available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's tenth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's first available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's second available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's third available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's fourth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's fifth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's sixth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's seventh\navailable color from its color scheme.",
+ "A recolor effect that darkens the image using the page's eighth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's ninth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's tenth available\ncolor from its color scheme.",
+ "A recolor effect that recolors the image to grayscale.",
+ "A recolor effect that recolors the image to negative grayscale.",
+ "A recolor effect that recolors the image using the sepia color.",
+ "Custom recolor effect. Refer to `recolor_stops` for the concrete\ngradient."
+ ]
}
},
- "id": "Recolor"
+ "id": "Recolor",
+ "description": "A recolor effect applied on an image."
},
"Link": {
"type": "object",
"properties": {
"pageObjectId": {
- "description": "If set, indicates this is a link to the specific page in this\npresentation with this ID. A page with this ID may not exist.",
- "type": "string"
+ "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."
},
"url": {
"description": "If set, indicates this is a link to the external web page at this URL.",
@@ -646,29 +1688,8 @@
"id": "Link",
"description": "A hypertext link."
},
- "RgbColor": {
- "description": "An RGB color.",
- "type": "object",
- "properties": {
- "red": {
- "description": "The red component of the color, from 0.0 to 1.0.",
- "format": "float",
- "type": "number"
- },
- "green": {
- "description": "The green component of the color, from 0.0 to 1.0.",
- "format": "float",
- "type": "number"
- },
- "blue": {
- "description": "The blue component of the color, from 0.0 to 1.0.",
- "format": "float",
- "type": "number"
- }
- },
- "id": "RgbColor"
- },
"CreateShapeResponse": {
+ "description": "The result of creating a shape.",
"type": "object",
"properties": {
"objectId": {
@@ -676,58 +1697,223 @@
"type": "string"
}
},
- "id": "CreateShapeResponse",
- "description": "The result of creating a shape."
+ "id": "CreateShapeResponse"
+ },
+ "RgbColor": {
+ "description": "An RGB color.",
+ "type": "object",
+ "properties": {
+ "green": {
+ "type": "number",
+ "description": "The green component of the color, from 0.0 to 1.0.",
+ "format": "float"
+ },
+ "blue": {
+ "description": "The blue component of the color, from 0.0 to 1.0.",
+ "format": "float",
+ "type": "number"
+ },
+ "red": {
+ "type": "number",
+ "description": "The red component of the color, from 0.0 to 1.0.",
+ "format": "float"
+ }
+ },
+ "id": "RgbColor"
},
"CreateLineRequest": {
"description": "Creates a line.",
"type": "object",
"properties": {
+ "objectId": {
+ "type": "string",
+ "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated."
+ },
+ "elementProperties": {
+ "$ref": "PageElementProperties",
+ "description": "The element properties for the line."
+ },
"lineCategory": {
- "enum": [
- "STRAIGHT",
- "BENT",
- "CURVED"
- ],
- "description": "The category of line to be created.",
"type": "string",
"enumDescriptions": [
"Straight connectors, including straight connector 1. The is the default\ncategory when one is not specified.",
"Bent connectors, including bent connector 2 to 5.",
"Curved connectors, including curved connector 2 to 5."
- ]
- },
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
- "type": "string"
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "description": "The element properties for the line."
+ ],
+ "enum": [
+ "STRAIGHT",
+ "BENT",
+ "CURVED"
+ ],
+ "description": "The category of line to be created."
}
},
"id": "CreateLineRequest"
},
"CreateSlideResponse": {
- "id": "CreateSlideResponse",
- "description": "The result of creating a slide.",
"type": "object",
"properties": {
"objectId": {
"type": "string",
"description": "The object ID of the created slide."
}
- }
+ },
+ "id": "CreateSlideResponse",
+ "description": "The result of creating a slide."
},
"CreateShapeRequest": {
- "description": "Creates a new shape.",
"type": "object",
"properties": {
"objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\nIf empty, a unique identifier will be generated.",
- "type": "string"
+ "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.\nIf empty, a unique identifier will be generated."
},
"shapeType": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TEXT_BOX",
+ "RECTANGLE",
+ "ROUND_RECTANGLE",
+ "ELLIPSE",
+ "ARC",
+ "BENT_ARROW",
+ "BENT_UP_ARROW",
+ "BEVEL",
+ "BLOCK_ARC",
+ "BRACE_PAIR",
+ "BRACKET_PAIR",
+ "CAN",
+ "CHEVRON",
+ "CHORD",
+ "CLOUD",
+ "CORNER",
+ "CUBE",
+ "CURVED_DOWN_ARROW",
+ "CURVED_LEFT_ARROW",
+ "CURVED_RIGHT_ARROW",
+ "CURVED_UP_ARROW",
+ "DECAGON",
+ "DIAGONAL_STRIPE",
+ "DIAMOND",
+ "DODECAGON",
+ "DONUT",
+ "DOUBLE_WAVE",
+ "DOWN_ARROW",
+ "DOWN_ARROW_CALLOUT",
+ "FOLDED_CORNER",
+ "FRAME",
+ "HALF_FRAME",
+ "HEART",
+ "HEPTAGON",
+ "HEXAGON",
+ "HOME_PLATE",
+ "HORIZONTAL_SCROLL",
+ "IRREGULAR_SEAL_1",
+ "IRREGULAR_SEAL_2",
+ "LEFT_ARROW",
+ "LEFT_ARROW_CALLOUT",
+ "LEFT_BRACE",
+ "LEFT_BRACKET",
+ "LEFT_RIGHT_ARROW",
+ "LEFT_RIGHT_ARROW_CALLOUT",
+ "LEFT_RIGHT_UP_ARROW",
+ "LEFT_UP_ARROW",
+ "LIGHTNING_BOLT",
+ "MATH_DIVIDE",
+ "MATH_EQUAL",
+ "MATH_MINUS",
+ "MATH_MULTIPLY",
+ "MATH_NOT_EQUAL",
+ "MATH_PLUS",
+ "MOON",
+ "NO_SMOKING",
+ "NOTCHED_RIGHT_ARROW",
+ "OCTAGON",
+ "PARALLELOGRAM",
+ "PENTAGON",
+ "PIE",
+ "PLAQUE",
+ "PLUS",
+ "QUAD_ARROW",
+ "QUAD_ARROW_CALLOUT",
+ "RIBBON",
+ "RIBBON_2",
+ "RIGHT_ARROW",
+ "RIGHT_ARROW_CALLOUT",
+ "RIGHT_BRACE",
+ "RIGHT_BRACKET",
+ "ROUND_1_RECTANGLE",
+ "ROUND_2_DIAGONAL_RECTANGLE",
+ "ROUND_2_SAME_RECTANGLE",
+ "RIGHT_TRIANGLE",
+ "SMILEY_FACE",
+ "SNIP_1_RECTANGLE",
+ "SNIP_2_DIAGONAL_RECTANGLE",
+ "SNIP_2_SAME_RECTANGLE",
+ "SNIP_ROUND_RECTANGLE",
+ "STAR_10",
+ "STAR_12",
+ "STAR_16",
+ "STAR_24",
+ "STAR_32",
+ "STAR_4",
+ "STAR_5",
+ "STAR_6",
+ "STAR_7",
+ "STAR_8",
+ "STRIPED_RIGHT_ARROW",
+ "SUN",
+ "TRAPEZOID",
+ "TRIANGLE",
+ "UP_ARROW",
+ "UP_ARROW_CALLOUT",
+ "UP_DOWN_ARROW",
+ "UTURN_ARROW",
+ "VERTICAL_SCROLL",
+ "WAVE",
+ "WEDGE_ELLIPSE_CALLOUT",
+ "WEDGE_RECTANGLE_CALLOUT",
+ "WEDGE_ROUND_RECTANGLE_CALLOUT",
+ "FLOW_CHART_ALTERNATE_PROCESS",
+ "FLOW_CHART_COLLATE",
+ "FLOW_CHART_CONNECTOR",
+ "FLOW_CHART_DECISION",
+ "FLOW_CHART_DELAY",
+ "FLOW_CHART_DISPLAY",
+ "FLOW_CHART_DOCUMENT",
+ "FLOW_CHART_EXTRACT",
+ "FLOW_CHART_INPUT_OUTPUT",
+ "FLOW_CHART_INTERNAL_STORAGE",
+ "FLOW_CHART_MAGNETIC_DISK",
+ "FLOW_CHART_MAGNETIC_DRUM",
+ "FLOW_CHART_MAGNETIC_TAPE",
+ "FLOW_CHART_MANUAL_INPUT",
+ "FLOW_CHART_MANUAL_OPERATION",
+ "FLOW_CHART_MERGE",
+ "FLOW_CHART_MULTIDOCUMENT",
+ "FLOW_CHART_OFFLINE_STORAGE",
+ "FLOW_CHART_OFFPAGE_CONNECTOR",
+ "FLOW_CHART_ONLINE_STORAGE",
+ "FLOW_CHART_OR",
+ "FLOW_CHART_PREDEFINED_PROCESS",
+ "FLOW_CHART_PREPARATION",
+ "FLOW_CHART_PROCESS",
+ "FLOW_CHART_PUNCHED_CARD",
+ "FLOW_CHART_PUNCHED_TAPE",
+ "FLOW_CHART_SORT",
+ "FLOW_CHART_SUMMING_JUNCTION",
+ "FLOW_CHART_TERMINATOR",
+ "ARROW_EAST",
+ "ARROW_NORTH_EAST",
+ "ARROW_NORTH",
+ "SPEECH",
+ "STARBURST",
+ "TEARDROP",
+ "ELLIPSE_RIBBON",
+ "ELLIPSE_RIBBON_2",
+ "CLOUD_CALLOUT",
+ "CUSTOM"
+ ],
"description": "The shape type.",
"type": "string",
"enumDescriptions": [
@@ -874,8 +2060,878 @@
"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."
+ }
+ },
+ "id": "CreateShapeRequest",
+ "description": "Creates a new shape."
+ },
+ "Video": {
+ "description": "A PageElement kind representing a\nvideo.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "type": "string",
+ "enumDescriptions": [
+ "The video source is unspecified.",
+ "The video source is YouTube."
],
"enum": [
+ "SOURCE_UNSPECIFIED",
+ "YOUTUBE"
+ ],
+ "description": "The video source."
+ },
+ "url": {
+ "type": "string",
+ "description": "An URL to a video. The URL is valid as long as the source video\nexists and sharing settings do not change."
+ },
+ "id": {
+ "type": "string",
+ "description": "The video source's unique identifier for this video."
+ },
+ "videoProperties": {
+ "$ref": "VideoProperties",
+ "description": "The properties of the video."
+ }
+ },
+ "id": "Video"
+ },
+ "PageProperties": {
+ "type": "object",
+ "properties": {
+ "pageBackgroundFill": {
+ "$ref": "PageBackgroundFill",
+ "description": "The background fill of the page. If unset, the background fill is inherited\nfrom a parent page if it exists. If the page has no parent, then the\nbackground fill defaults to the corresponding fill in the Slides editor."
+ },
+ "colorScheme": {
+ "$ref": "ColorScheme",
+ "description": "The color scheme of the page. If unset, the color scheme is inherited from\na parent page. If the page has no parent, the color scheme uses a default\nSlides color scheme. This field is read-only."
+ }
+ },
+ "id": "PageProperties",
+ "description": "The properties of the Page.\n\nThe page will inherit properties from the parent page. Depending on the page\ntype the hierarchy is defined in either\nSlideProperties or\nLayoutProperties."
+ },
+ "TableCell": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "$ref": "TextContent",
+ "description": "The text content of the cell."
+ },
+ "tableCellProperties": {
+ "$ref": "TableCellProperties",
+ "description": "The properties of the table cell."
+ },
+ "location": {
+ "$ref": "TableCellLocation",
+ "description": "The location of the cell within the table."
+ },
+ "rowSpan": {
+ "type": "integer",
+ "description": "Row span of the cell.",
+ "format": "int32"
+ },
+ "columnSpan": {
+ "description": "Column span of the cell.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TableCell",
+ "description": "Properties and contents of each table cell."
+ },
+ "NestingLevel": {
+ "description": "Contains properties describing the look and feel of a list bullet at a given\nlevel of nesting.",
+ "type": "object",
+ "properties": {
+ "bulletStyle": {
+ "$ref": "TextStyle",
+ "description": "The style of a bullet at this level of nesting."
+ }
+ },
+ "id": "NestingLevel"
+ },
+ "UpdateLinePropertiesRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the line the update is applied to."
+ },
+ "lineProperties": {
+ "$ref": "LineProperties",
+ "description": "The line properties to update."
+ },
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `lineProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the line solid fill color, set `fields` to\n`\"lineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateLinePropertiesRequest",
+ "description": "Updates the properties of a Line."
+ },
+ "UpdatePageElementAltTextRequest": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "The updated alt text title of the page element. If unset the\nexisting value will be maintained. The title is exposed to screen readers\nand other accessibility interfaces. Only use human readable values related\nto the content of the page element.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The updated alt text description of the page element. If unset the existing\nvalue will be maintained. The description is exposed to screen readers\nand other accessibility interfaces. Only use human readable values related\nto the content of the page element.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "The object ID of the page element the updates are applied to.",
+ "type": "string"
+ }
+ },
+ "id": "UpdatePageElementAltTextRequest",
+ "description": "Updates the alt text title and/or description of a\npage element."
+ },
+ "UpdateSlidesPositionRequest": {
+ "type": "object",
+ "properties": {
+ "insertionIndex": {
+ "type": "integer",
+ "description": "The index where the slides should be inserted, based on the slide\narrangement before the move takes place. Must be between zero and the\nnumber of slides in the presentation, inclusive.",
+ "format": "int32"
+ },
+ "slideObjectIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The IDs of the slides in the presentation that should be moved.\nThe slides in this list must be in existing presentation order, without\nduplicates."
+ }
+ },
+ "id": "UpdateSlidesPositionRequest",
+ "description": "Updates the position of slides in the presentation."
+ },
+ "TableCellBackgroundFill": {
+ "type": "object",
+ "properties": {
+ "propertyState": {
+ "type": "string",
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ],
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ],
+ "description": "The background fill property state.\n\nUpdating the fill on a table cell will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no fill on a table cell, set this field to `NOT_RENDERED`. In this\ncase, any other fill fields set in the same request will be ignored."
+ },
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
+ }
+ },
+ "id": "TableCellBackgroundFill",
+ "description": "The table cell background fill."
+ },
+ "UpdatePagePropertiesRequest": {
+ "description": "Updates the properties of a Page.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `pageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the page background solid fill color, set `fields`\nto `\"pageBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the page the update is applied to."
+ },
+ "pageProperties": {
+ "$ref": "PageProperties",
+ "description": "The page properties to update."
+ }
+ },
+ "id": "UpdatePagePropertiesRequest"
+ },
+ "Group": {
+ "type": "object",
+ "properties": {
+ "children": {
+ "type": "array",
+ "items": {
+ "$ref": "PageElement"
+ },
+ "description": "The collection of elements in the group. The minimum size of a group is 2."
+ }
+ },
+ "id": "Group",
+ "description": "A PageElement kind representing a\njoined collection of PageElements."
+ },
+ "Placeholder": {
+ "description": "The placeholder information that uniquely identifies a placeholder shape.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enum": [
+ "NONE",
+ "BODY",
+ "CHART",
+ "CLIP_ART",
+ "CENTERED_TITLE",
+ "DIAGRAM",
+ "DATE_AND_TIME",
+ "FOOTER",
+ "HEADER",
+ "MEDIA",
+ "OBJECT",
+ "PICTURE",
+ "SLIDE_NUMBER",
+ "SUBTITLE",
+ "TABLE",
+ "TITLE",
+ "SLIDE_IMAGE"
+ ],
+ "description": "The type of the placeholder.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, signifies it is not a placeholder.",
+ "Body text.",
+ "Chart or graph.",
+ "Clip art image.",
+ "Title centered.",
+ "Diagram.",
+ "Date and time.",
+ "Footer text.",
+ "Header text.",
+ "Multimedia.",
+ "Any content type.",
+ "Picture.",
+ "Number of a slide.",
+ "Subtitle.",
+ "Table.",
+ "Slide title.",
+ "Slide image."
+ ]
+ },
+ "parentObjectId": {
+ "type": "string",
+ "description": "The object ID of this shape's parent placeholder.\nIf unset, the parent placeholder shape does not exist, so the shape does\nnot inherit properties from any other shape."
+ },
+ "index": {
+ "description": "The index of the placeholder. If the same placeholder types are present in\nthe same page, they would have different index values.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Placeholder"
+ },
+ "DuplicateObjectRequest": {
+ "description": "Duplicates a slide or page element.\n\nWhen duplicating a slide, the duplicate slide will be created immediately\nfollowing the specified slide. When duplicating a page element, the duplicate\nwill be placed on the same page at the same position as the original.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The ID of the object to duplicate."
+ },
+ "objectIds": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The object being duplicated may contain other objects, for example when\nduplicating a slide or a group page element. This map defines how the IDs\nof duplicated objects are generated: the keys are the IDs of the original\nobjects and its values are the IDs that will be assigned to the\ncorresponding duplicate object. The ID of the source object's duplicate\nmay be specified in this map as well, using the same value of the\n`object_id` field as a key and the newly desired ID as the value.\n\nAll keys must correspond to existing IDs in the presentation. All values\nmust be unique in the presentation and must start with an alphanumeric\ncharacter or an underscore (matches regex `[a-zA-Z0-9_]`); remaining\ncharacters may include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or\ngreater than 50.\n\nIf any IDs of source objects are omitted from the map, a new random ID will\nbe assigned. If the map is empty or unset, all duplicate objects will\nreceive a new random ID.",
+ "type": "object"
+ }
+ },
+ "id": "DuplicateObjectRequest"
+ },
+ "ReplaceAllTextRequest": {
+ "type": "object",
+ "properties": {
+ "replaceText": {
+ "type": "string",
+ "description": "The text that will replace the matched text."
+ },
+ "pageObjectIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes master,\nor if a page with that object ID doesn't exist in the presentation."
+ },
+ "containsText": {
+ "$ref": "SubstringMatchCriteria",
+ "description": "Finds text in a shape matching this substring."
+ }
+ },
+ "id": "ReplaceAllTextRequest",
+ "description": "Replaces all instances of text matching a criteria with replace text."
+ },
+ "Page": {
+ "description": "A page in a presentation.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID for this page. Object IDs used by\nPage and\nPageElement share the same namespace.",
+ "type": "string"
+ },
+ "revisionId": {
+ "description": "The revision ID of the presentation containing this page. Can be used in\nupdate requests to assert that the presentation revision hasn't changed\nsince the last read operation. Only populated if the user has edit access\nto the presentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.",
+ "type": "string"
+ },
+ "layoutProperties": {
+ "$ref": "LayoutProperties",
+ "description": "Layout specific properties. Only set if page_type = LAYOUT."
+ },
+ "pageElements": {
+ "type": "array",
+ "items": {
+ "$ref": "PageElement"
+ },
+ "description": "The page elements rendered on the page."
+ },
+ "notesProperties": {
+ "$ref": "NotesProperties",
+ "description": "Notes specific properties. Only set if page_type = NOTES."
+ },
+ "pageType": {
+ "type": "string",
+ "enumDescriptions": [
+ "A slide page.",
+ "A master slide page.",
+ "A layout page.",
+ "A notes page.",
+ "A notes master page."
+ ],
+ "enum": [
+ "SLIDE",
+ "MASTER",
+ "LAYOUT",
+ "NOTES",
+ "NOTES_MASTER"
+ ],
+ "description": "The type of the page."
+ },
+ "slideProperties": {
+ "$ref": "SlideProperties",
+ "description": "Slide specific properties. Only set if page_type = SLIDE."
+ },
+ "pageProperties": {
+ "$ref": "PageProperties",
+ "description": "The properties of the page."
+ },
+ "masterProperties": {
+ "$ref": "MasterProperties",
+ "description": "Master specific properties. Only set if page_type = MASTER."
+ }
+ },
+ "id": "Page"
+ },
+ "UnmergeTableCellsRequest": {
+ "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 unmerge.\n\nAll merged cells in this range will be unmerged, and cells that are already\nunmerged will not be affected. If the range has no merged cells, the\nrequest will do nothing. If there is text in any of the merged cells, the\ntext will remain in the upper-left (\"head\") cell of the resulting block of\nunmerged cells."
+ }
+ },
+ "id": "UnmergeTableCellsRequest",
+ "description": "Unmerges cells in a Table."
+ },
+ "ShapeBackgroundFill": {
+ "type": "object",
+ "properties": {
+ "propertyState": {
+ "type": "string",
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ],
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ],
+ "description": "The background fill property state.\n\nUpdating the fill on a 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."
+ },
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
+ }
+ },
+ "id": "ShapeBackgroundFill",
+ "description": "The shape background fill."
+ },
+ "CropProperties": {
+ "type": "object",
+ "properties": {
+ "angle": {
+ "type": "number",
+ "description": "The rotation angle of the crop window around its center, in radians.\nRotation angle is applied after the offset.",
+ "format": "float"
+ },
+ "topOffset": {
+ "type": "number",
+ "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"
+ },
+ "leftOffset": {
+ "type": "number",
+ "description": "The offset specifies the left edge of the crop rectangle that is located to\nthe right of the original bounding rectangle left edge, relative to the\nobject's original width.",
+ "format": "float"
+ },
+ "rightOffset": {
+ "description": "The offset specifies the right edge of the crop rectangle that is located\nto the left of the original bounding rectangle right edge, relative to the\nobject's original width.",
+ "format": "float",
+ "type": "number"
+ },
+ "bottomOffset": {
+ "description": "The offset specifies the bottom edge of the crop rectangle that is located\nabove the original bounding rectangle bottom edge, relative to the object's\noriginal height.",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "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."
+ },
+ "ReplaceAllShapesWithSheetsChartRequest": {
+ "description": "Replaces all shapes that match the given criteria with the provided Google\nSheets chart. The chart will be scaled and centered to fit within the bounds\nof the original shape.\n\nNOTE: Replacing shapes with a chart requires at least one of the\nspreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.",
+ "type": "object",
+ "properties": {
+ "spreadsheetId": {
+ "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
+ "type": "string"
+ },
+ "linkingMode": {
+ "enum": [
+ "NOT_LINKED_IMAGE",
+ "LINKED"
+ ],
+ "description": "The mode with which the chart is linked to the source spreadsheet. When\nnot specified, the chart will be an image that is not linked.",
+ "type": "string",
+ "enumDescriptions": [
+ "The chart is not associated with the source spreadsheet and cannot be\nupdated. A chart that is not linked will be inserted as an image.",
+ "Linking the chart allows it to be updated, and other collaborators will\nsee a link to the spreadsheet."
+ ]
+ },
+ "containsText": {
+ "$ref": "SubstringMatchCriteria",
+ "description": "The criteria that the shapes must match in order to be replaced. The\nrequest will replace all of the shapes that contain the given text."
+ },
+ "chartId": {
+ "type": "integer",
+ "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
+ "format": "int32"
+ },
+ "pageObjectIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation."
+ }
+ },
+ "id": "ReplaceAllShapesWithSheetsChartRequest"
+ },
+ "Range": {
+ "type": "object",
+ "properties": {
+ "startIndex": {
+ "description": "The optional zero-based index of the beginning of the collection.\nRequired for `FIXED_RANGE` and `FROM_START_INDEX` ranges.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "endIndex": {
+ "description": "The optional zero-based index of the end of the collection.\nRequired for `FIXED_RANGE` ranges.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": {
+ "enum": [
+ "RANGE_TYPE_UNSPECIFIED",
+ "FIXED_RANGE",
+ "FROM_START_INDEX",
+ "ALL"
+ ],
+ "description": "The type of range.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified range type. This value must not be used.",
+ "A fixed range. Both the `start_index` and\n`end_index` must be specified.",
+ "Starts the range at `start_index` and continues until the\nend of the collection. The `end_index` must not be specified.",
+ "Sets the range to be the whole length of the collection. Both the\n`start_index` and the `end_index` must not be\nspecified."
+ ]
+ }
+ },
+ "id": "Range",
+ "description": "Specifies a contiguous range of an indexed collection, such as characters in\ntext."
+ },
+ "ColorStop": {
+ "type": "object",
+ "properties": {
+ "alpha": {
+ "description": "The alpha value of this color in the gradient band. Defaults to 1.0,\nfully opaque.",
+ "format": "float",
+ "type": "number"
+ },
+ "position": {
+ "type": "number",
+ "description": "The relative position of the color stop in the gradient band measured\nin percentage. The value should be in the interval [0.0, 1.0].",
+ "format": "float"
+ },
+ "color": {
+ "$ref": "OpaqueColor",
+ "description": "The color of the gradient stop."
+ }
+ },
+ "id": "ColorStop",
+ "description": "A color and position in a gradient band."
+ },
+ "CreateVideoRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
+ "type": "string"
+ },
+ "source": {
+ "enum": [
+ "SOURCE_UNSPECIFIED",
+ "YOUTUBE"
+ ],
+ "description": "The video source.",
+ "type": "string",
+ "enumDescriptions": [
+ "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",
+ "description": "Creates a video."
+ },
+ "DuplicateObjectResponse": {
+ "description": "The response of duplicating an object.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The ID of the new duplicate object."
+ }
+ },
+ "id": "DuplicateObjectResponse"
+ },
+ "ReplaceAllShapesWithImageRequest": {
+ "type": "object",
+ "properties": {
+ "imageUrl": {
+ "type": "string",
+ "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at most 2 kB in length."
+ },
+ "replaceMethod": {
+ "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": {
+ "$ref": "SubstringMatchCriteria",
+ "description": "If set, this request will replace all of the shapes that contain the\ngiven text."
+ },
+ "pageObjectIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation."
+ }
+ },
+ "id": "ReplaceAllShapesWithImageRequest",
+ "description": "Replaces all shapes that match the given criteria with the provided image."
+ },
+ "MergeTableCellsRequest": {
+ "description": "Merges cells in a Table.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the table.",
+ "type": "string"
+ },
+ "tableRange": {
+ "$ref": "TableRange",
+ "description": "The table range specifying which cells of the table to merge.\n\nAny text in the cells being merged will be concatenated and stored in the\nupper-left (\"head\") cell of the range. If the range is non-rectangular\n(which can occur in some cases where the range covers cells that are\nalready merged), a 400 bad request error is returned."
+ }
+ },
+ "id": "MergeTableCellsRequest"
+ },
+ "Shadow": {
+ "type": "object",
+ "properties": {
+ "blurRadius": {
+ "$ref": "Dimension",
+ "description": "The radius of the shadow blur. The larger the radius, the more diffuse the\nshadow becomes."
+ },
+ "transform": {
+ "$ref": "AffineTransform",
+ "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position."
+ },
+ "type": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified shadow type.",
+ "Outer shadow."
+ ],
+ "enum": [
+ "SHADOW_TYPE_UNSPECIFIED",
+ "OUTER"
+ ],
+ "description": "The type of the shadow."
+ },
+ "alignment": {
+ "enum": [
+ "RECTANGLE_POSITION_UNSPECIFIED",
+ "TOP_LEFT",
+ "TOP_CENTER",
+ "TOP_RIGHT",
+ "LEFT_CENTER",
+ "CENTER",
+ "RIGHT_CENTER",
+ "BOTTOM_LEFT",
+ "BOTTOM_CENTER",
+ "BOTTOM_RIGHT"
+ ],
+ "description": "The alignment point of the shadow, that sets the origin for translate,\nscale and skew of the shadow.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Top left.",
+ "Top center.",
+ "Top right.",
+ "Left center.",
+ "Center.",
+ "Right center.",
+ "Bottom left.",
+ "Bottom center.",
+ "Bottom right."
+ ]
+ },
+ "alpha": {
+ "type": "number",
+ "description": "The alpha of the shadow's color, from 0.0 to 1.0.",
+ "format": "float"
+ },
+ "color": {
+ "$ref": "OpaqueColor",
+ "description": "The shadow color value."
+ },
+ "rotateWithShape": {
+ "description": "Whether the shadow should rotate with the shape.",
+ "type": "boolean"
+ },
+ "propertyState": {
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ],
+ "description": "The shadow property state.\n\nUpdating the shadow on a page element will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To have\nno shadow on a page element, set this field to `NOT_RENDERED`. In this\ncase, any other shadow fields set in the same request will be ignored.",
+ "type": "string",
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ]
+ }
+ },
+ "id": "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."
+ },
+ "UngroupObjectsRequest": {
+ "description": "Ungroups objects, such as groups.",
+ "type": "object",
+ "properties": {
+ "objectIds": {
+ "description": "The object IDs of the objects to ungroup.\n\nOnly groups that are not inside other\ngroups can be ungrouped. All the groups\nshould be on the same page. The group itself is deleted. The visual sizes\nand positions of all the children are preserved.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "UngroupObjectsRequest"
+ },
+ "DeleteTableRowRequest": {
+ "type": "object",
+ "properties": {
+ "tableObjectId": {
+ "description": "The table to delete rows from.",
+ "type": "string"
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The reference table cell location from which a row will be deleted.\n\nThe row this cell spans will be deleted. If this is a merged cell, multiple\nrows will be deleted. If no rows remain in the table after this deletion,\nthe whole table is deleted."
+ }
+ },
+ "id": "DeleteTableRowRequest",
+ "description": "Deletes a row from a table."
+ },
+ "Bullet": {
+ "type": "object",
+ "properties": {
+ "glyph": {
+ "description": "The rendered bullet glyph for this paragraph.",
+ "type": "string"
+ },
+ "nestingLevel": {
+ "description": "The nesting level of this paragraph in the list.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "bulletStyle": {
+ "$ref": "TextStyle",
+ "description": "The paragraph specific text style applied to this bullet."
+ },
+ "listId": {
+ "type": "string",
+ "description": "The ID of the list this paragraph belongs to."
+ }
+ },
+ "id": "Bullet",
+ "description": "Describes the bullet of a paragraph."
+ },
+ "OutlineFill": {
+ "type": "object",
+ "properties": {
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
+ }
+ },
+ "id": "OutlineFill",
+ "description": "The fill of the outline."
+ },
+ "TableCellLocation": {
+ "type": "object",
+ "properties": {
+ "rowIndex": {
+ "type": "integer",
+ "description": "The 0-based row index.",
+ "format": "int32"
+ },
+ "columnIndex": {
+ "description": "The 0-based column index.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TableCellLocation",
+ "description": "A location of a single table cell within a table."
+ },
+ "CreateLineResponse": {
+ "description": "The result of creating a line.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created line.",
+ "type": "string"
+ }
+ },
+ "id": "CreateLineResponse"
+ },
+ "ReplaceAllTextResponse": {
+ "description": "The result of replacing text.",
+ "type": "object",
+ "properties": {
+ "occurrencesChanged": {
+ "type": "integer",
+ "description": "The number of occurrences changed by replacing all text.",
+ "format": "int32"
+ }
+ },
+ "id": "ReplaceAllTextResponse"
+ },
+ "TableBorderFill": {
+ "description": "The fill of the border.",
+ "type": "object",
+ "properties": {
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid fill."
+ }
+ },
+ "id": "TableBorderFill"
+ },
+ "UpdateParagraphStyleRequest": {
+ "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 paragraph alignment, set `fields` to\n`\"alignment\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "The object ID of the shape or table with the text to be styled.",
+ "type": "string"
+ },
+ "textRange": {
+ "$ref": "Range",
+ "description": "The range of text containing the paragraph(s) to style."
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The location of the cell in the table containing the paragraph(s) to\nstyle. If `object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not."
+ },
+ "style": {
+ "$ref": "ParagraphStyle",
+ "description": "The paragraph's style."
+ }
+ },
+ "id": "UpdateParagraphStyleRequest",
+ "description": "Updates the styling for all of the paragraphs within a Shape or Table that\noverlap with the given text index range."
+ },
+ "ColorScheme": {
+ "description": "The palette of predefined colors for a page.",
+ "type": "object",
+ "properties": {
+ "colors": {
+ "description": "The ThemeColorType and corresponding concrete color pairs.",
+ "type": "array",
+ "items": {
+ "$ref": "ThemeColorPair"
+ }
+ }
+ },
+ "id": "ColorScheme"
+ },
+ "Shape": {
+ "description": "A PageElement kind representing a\ngeneric shape that does not have a more specific classification.",
+ "type": "object",
+ "properties": {
+ "shapeType": {
+ "enum": [
"TYPE_UNSPECIFIED",
"TEXT_BOX",
"RECTANGLE",
@@ -1019,876 +3075,8 @@
"ELLIPSE_RIBBON_2",
"CLOUD_CALLOUT",
"CUSTOM"
- ]
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "description": "The element properties for the shape."
- }
- },
- "id": "CreateShapeRequest"
- },
- "Video": {
- "id": "Video",
- "description": "A PageElement kind representing a\nvideo.",
- "type": "object",
- "properties": {
- "source": {
- "description": "The video source.",
- "type": "string",
- "enumDescriptions": [
- "The video source is unspecified.",
- "The video source is YouTube."
],
- "enum": [
- "SOURCE_UNSPECIFIED",
- "YOUTUBE"
- ]
- },
- "url": {
- "description": "An URL to a video. The URL is valid as long as the source video\nexists and sharing settings do not change.",
- "type": "string"
- },
- "id": {
- "description": "The video source's unique identifier for this video.",
- "type": "string"
- },
- "videoProperties": {
- "$ref": "VideoProperties",
- "description": "The properties of the 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": {
- "pageBackgroundFill": {
- "$ref": "PageBackgroundFill",
- "description": "The background fill of the page. If unset, the background fill is inherited\nfrom a parent page if it exists. If the page has no parent, then the\nbackground fill defaults to the corresponding fill in the Slides editor."
- },
- "colorScheme": {
- "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"
- },
- "NestingLevel": {
- "description": "Contains properties describing the look and feel of a list bullet at a given\nlevel of nesting.",
- "type": "object",
- "properties": {
- "bulletStyle": {
- "$ref": "TextStyle",
- "description": "The style of a bullet at this level of nesting."
- }
- },
- "id": "NestingLevel"
- },
- "TableCell": {
- "description": "Properties and contents of each table cell.",
- "type": "object",
- "properties": {
- "text": {
- "description": "The text content of the cell.",
- "$ref": "TextContent"
- },
- "tableCellProperties": {
- "description": "The properties of the table cell.",
- "$ref": "TableCellProperties"
- },
- "location": {
- "$ref": "TableCellLocation",
- "description": "The location of the cell within the table."
- },
- "rowSpan": {
- "description": "Row span of the cell.",
- "format": "int32",
- "type": "integer"
- },
- "columnSpan": {
- "description": "Column span of the cell.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TableCell"
- },
- "UpdateLinePropertiesRequest": {
- "description": "Updates the properties of a Line.",
- "type": "object",
- "properties": {
- "lineProperties": {
- "$ref": "LineProperties",
- "description": "The line properties to update."
- },
- "fields": {
- "type": "string",
- "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"
- },
- "objectId": {
- "description": "The object ID of the line the update is applied to.",
- "type": "string"
- }
- },
- "id": "UpdateLinePropertiesRequest"
- },
- "UpdatePageElementAltTextRequest": {
- "description": "Updates the alt text title and/or description of a\npage element.",
- "type": "object",
- "properties": {
- "title": {
- "description": "The updated alt text title of the page element. If unset the\nexisting value will be maintained. The title is exposed to screen readers\nand other accessibility interfaces. Only use human readable values related\nto the content of the page element.",
- "type": "string"
- },
- "description": {
- "description": "The updated alt text description of the page element. If unset the existing\nvalue will be maintained. The description is exposed to screen readers\nand other accessibility interfaces. Only use human readable values related\nto the content of the page element.",
- "type": "string"
- },
- "objectId": {
- "description": "The object ID of the page element the updates are applied to.",
- "type": "string"
- }
- },
- "id": "UpdatePageElementAltTextRequest"
- },
- "TableCellBackgroundFill": {
- "type": "object",
- "properties": {
- "propertyState": {
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ],
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The background fill property state.\n\nUpdating the fill on a 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"
- },
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
- }
- },
- "id": "TableCellBackgroundFill",
- "description": "The table cell background fill."
- },
- "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"
- }
- },
- "insertionIndex": {
- "description": "The index where the slides should be inserted, based on the slide\narrangement before the move takes place. Must be between zero and the\nnumber of slides in the presentation, inclusive.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "UpdateSlidesPositionRequest"
- },
- "UpdatePagePropertiesRequest": {
- "description": "Updates the properties of a Page.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the page the update is applied to.",
- "type": "string"
- },
- "pageProperties": {
- "description": "The page properties to update.",
- "$ref": "PageProperties"
- },
- "fields": {
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `pageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the page background solid fill color, set `fields`\nto `\"pageBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdatePagePropertiesRequest"
- },
- "Group": {
- "description": "A PageElement kind representing a\njoined collection of PageElements.",
- "type": "object",
- "properties": {
- "children": {
- "description": "The collection of elements in the group. The minimum size of a group is 2.",
- "type": "array",
- "items": {
- "$ref": "PageElement"
- }
- }
- },
- "id": "Group"
- },
- "Placeholder": {
- "type": "object",
- "properties": {
- "parentObjectId": {
- "description": "The object ID of this shape's parent placeholder.\nIf unset, the parent placeholder shape does not exist, so the shape does\nnot inherit properties from any other shape.",
- "type": "string"
- },
- "index": {
- "description": "The index of the placeholder. If the same placeholder types are present in\nthe same page, they would have different index values.",
- "format": "int32",
- "type": "integer"
- },
- "type": {
- "enumDescriptions": [
- "Default value, signifies it is not a placeholder.",
- "Body text.",
- "Chart or graph.",
- "Clip art image.",
- "Title centered.",
- "Diagram.",
- "Date and time.",
- "Footer text.",
- "Header text.",
- "Multimedia.",
- "Any content type.",
- "Picture.",
- "Number of a slide.",
- "Subtitle.",
- "Table.",
- "Slide title.",
- "Slide image."
- ],
- "enum": [
- "NONE",
- "BODY",
- "CHART",
- "CLIP_ART",
- "CENTERED_TITLE",
- "DIAGRAM",
- "DATE_AND_TIME",
- "FOOTER",
- "HEADER",
- "MEDIA",
- "OBJECT",
- "PICTURE",
- "SLIDE_NUMBER",
- "SUBTITLE",
- "TABLE",
- "TITLE",
- "SLIDE_IMAGE"
- ],
- "description": "The type of the placeholder.",
- "type": "string"
- }
- },
- "id": "Placeholder",
- "description": "The placeholder information that uniquely identifies a placeholder shape."
- },
- "DuplicateObjectRequest": {
- "description": "Duplicates a slide or page element.\n\nWhen duplicating a slide, the duplicate slide will be created immediately\nfollowing the specified slide. When duplicating a page element, the duplicate\nwill be placed on the same page at the same position as the original.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The ID of the object to duplicate.",
- "type": "string"
- },
- "objectIds": {
- "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"
- }
- }
- },
- "id": "DuplicateObjectRequest"
- },
- "ReplaceAllTextRequest": {
- "id": "ReplaceAllTextRequest",
- "description": "Replaces all instances of text matching a criteria with replace text.",
- "type": "object",
- "properties": {
- "replaceText": {
- "description": "The text that will replace the matched text.",
- "type": "string"
- },
- "pageObjectIds": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes master,\nor if a page with that object ID doesn't exist in the presentation."
- },
- "containsText": {
- "$ref": "SubstringMatchCriteria",
- "description": "Finds text in a shape matching this substring."
- }
- }
- },
- "UnmergeTableCellsRequest": {
- "properties": {
- "objectId": {
- "type": "string",
- "description": "The object ID of the table."
- },
- "tableRange": {
- "$ref": "TableRange",
- "description": "The table range specifying which cells of the table to unmerge.\n\nAll merged cells in this range will be unmerged, and cells that are already\nunmerged will not be affected. If the range has no merged cells, the\nrequest will do nothing. If there is text in any of the merged cells, the\ntext will remain in the upper-left (\"head\") cell of the resulting block of\nunmerged cells."
- }
- },
- "id": "UnmergeTableCellsRequest",
- "description": "Unmerges cells in a Table.",
- "type": "object"
- },
- "Page": {
- "id": "Page",
- "description": "A page in a presentation.",
- "type": "object",
- "properties": {
- "layoutProperties": {
- "$ref": "LayoutProperties",
- "description": "Layout specific properties. Only set if page_type = LAYOUT."
- },
- "pageElements": {
- "description": "The page elements rendered on the page.",
- "type": "array",
- "items": {
- "$ref": "PageElement"
- }
- },
- "pageType": {
- "enum": [
- "SLIDE",
- "MASTER",
- "LAYOUT",
- "NOTES",
- "NOTES_MASTER"
- ],
- "description": "The type of the page.",
- "type": "string",
- "enumDescriptions": [
- "A slide page.",
- "A master slide page.",
- "A layout page.",
- "A notes page.",
- "A notes master page."
- ]
- },
- "notesProperties": {
- "$ref": "NotesProperties",
- "description": "Notes specific properties. Only set if page_type = NOTES."
- },
- "slideProperties": {
- "$ref": "SlideProperties",
- "description": "Slide specific properties. Only set if page_type = SLIDE."
- },
- "pageProperties": {
- "$ref": "PageProperties",
- "description": "The properties of the page."
- },
- "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"
- }
- }
- },
- "ShapeBackgroundFill": {
- "description": "The shape background fill.",
- "type": "object",
- "properties": {
- "solidFill": {
- "description": "Solid color fill.",
- "$ref": "SolidFill"
- },
- "propertyState": {
- "description": "The background fill property state.\n\nUpdating the fill on a 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."
- ],
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ]
- }
- },
- "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": {
- "type": "number",
- "description": "The rotation angle of the crop window around its center, in radians.\nRotation angle is applied after the offset.",
- "format": "float"
- },
- "topOffset": {
- "description": "The offset specifies the top edge of the crop rectangle that is located\nbelow the original bounding rectangle top edge, relative to the object's\noriginal height.",
- "format": "float",
- "type": "number"
- },
- "leftOffset": {
- "description": "The offset specifies the left edge of the crop rectangle that is located to\nthe right of the original bounding rectangle left edge, relative to the\nobject's original width.",
- "format": "float",
- "type": "number"
- },
- "rightOffset": {
- "description": "The offset specifies the right edge of the crop rectangle that is located\nto the left of the original bounding rectangle right edge, relative to the\nobject's original width.",
- "format": "float",
- "type": "number"
- }
- },
- "id": "CropProperties"
- },
- "ReplaceAllShapesWithSheetsChartRequest": {
- "description": "Replaces all shapes that match the given criteria with the provided Google\nSheets chart. The chart will be scaled and centered to fit within the bounds\nof the original shape.\n\nNOTE: Replacing shapes with a chart requires at least one of the\nspreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.",
- "type": "object",
- "properties": {
- "spreadsheetId": {
- "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
- "type": "string"
- },
- "linkingMode": {
- "type": "string",
- "enumDescriptions": [
- "The chart is not associated with the source spreadsheet and cannot be\nupdated. A chart that is not linked will be inserted as an image.",
- "Linking the chart allows it to be updated, and other collaborators will\nsee a link to the spreadsheet."
- ],
- "enum": [
- "NOT_LINKED_IMAGE",
- "LINKED"
- ],
- "description": "The mode with which the chart is linked to the source spreadsheet. When\nnot specified, the chart will be an image that is not linked."
- },
- "containsText": {
- "$ref": "SubstringMatchCriteria",
- "description": "The criteria that the shapes must match in order to be replaced. The\nrequest will replace all of the shapes that contain the given text."
- },
- "chartId": {
- "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
- "format": "int32",
- "type": "integer"
- },
- "pageObjectIds": {
- "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ReplaceAllShapesWithSheetsChartRequest"
- },
- "ColorStop": {
- "description": "A color and position in a gradient band.",
- "type": "object",
- "properties": {
- "alpha": {
- "description": "The alpha value of this color in the gradient band. Defaults to 1.0,\nfully opaque.",
- "format": "float",
- "type": "number"
- },
- "position": {
- "description": "The relative position of the color stop in the gradient band measured\nin percentage. The value should be in the interval [0.0, 1.0].",
- "format": "float",
- "type": "number"
- },
- "color": {
- "$ref": "OpaqueColor",
- "description": "The color of the gradient stop."
- }
- },
- "id": "ColorStop"
- },
- "Range": {
- "description": "Specifies a contiguous range of an indexed collection, such as characters in\ntext.",
- "type": "object",
- "properties": {
- "type": {
- "enumDescriptions": [
- "Unspecified range type. This value must not be used.",
- "A fixed range. Both the `start_index` and\n`end_index` must be specified.",
- "Starts the range at `start_index` and continues until the\nend of the collection. The `end_index` must not be specified.",
- "Sets the range to be the whole length of the collection. Both the\n`start_index` and the `end_index` must not be\nspecified."
- ],
- "enum": [
- "RANGE_TYPE_UNSPECIFIED",
- "FIXED_RANGE",
- "FROM_START_INDEX",
- "ALL"
- ],
- "description": "The type of range.",
- "type": "string"
- },
- "startIndex": {
- "description": "The optional zero-based index of the beginning of the collection.\nRequired for `FIXED_RANGE` and `FROM_START_INDEX` ranges.",
- "format": "int32",
- "type": "integer"
- },
- "endIndex": {
- "description": "The optional zero-based index of the end of the collection.\nRequired for `FIXED_RANGE` ranges.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Range"
- },
- "CreateVideoRequest": {
- "description": "Creates a video.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
- "type": "string"
- },
- "source": {
- "enum": [
- "SOURCE_UNSPECIFIED",
- "YOUTUBE"
- ],
- "description": "The video source.",
- "type": "string",
- "enumDescriptions": [
- "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"
- },
- "DuplicateObjectResponse": {
- "description": "The response of duplicating an object.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The ID of the new duplicate object.",
- "type": "string"
- }
- },
- "id": "DuplicateObjectResponse"
- },
- "ReplaceAllShapesWithImageRequest": {
- "properties": {
- "imageUrl": {
- "type": "string",
- "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at most 2 kB in length."
- },
- "replaceMethod": {
- "type": "string",
- "enumDescriptions": [
- "Scales and centers the image to fit within the bounds of the original\nshape and maintains the image's aspect ratio. The rendered size of the\nimage may be smaller than the size of the shape. This is the default\nmethod when one is not specified.",
- "Scales and centers the image to fill the bounds of the original shape.\nThe image may be cropped in order to fill the shape. The rendered size of\nthe image will be the same as that of the original shape."
- ],
- "enum": [
- "CENTER_INSIDE",
- "CENTER_CROP"
- ],
- "description": "The replace method."
- },
- "containsText": {
- "description": "If set, this request will replace all of the shapes that contain the\ngiven text.",
- "$ref": "SubstringMatchCriteria"
- },
- "pageObjectIds": {
- "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ReplaceAllShapesWithImageRequest",
- "description": "Replaces all shapes that match the given criteria with the provided image.",
- "type": "object"
- },
- "MergeTableCellsRequest": {
- "description": "Merges cells in a Table.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the table.",
- "type": "string"
- },
- "tableRange": {
- "description": "The table range specifying which cells of the table to merge.\n\nAny text in the cells being merged will be concatenated and stored in the\nupper-left (\"head\") cell of the range. If the range is non-rectangular\n(which can occur in some cases where the range covers cells that are\nalready merged), a 400 bad request error is returned.",
- "$ref": "TableRange"
- }
- },
- "id": "MergeTableCellsRequest"
- },
- "UngroupObjectsRequest": {
- "id": "UngroupObjectsRequest",
- "description": "Ungroups objects, such as groups.",
- "type": "object",
- "properties": {
- "objectIds": {
- "description": "The object IDs of the objects to ungroup.\n\nOnly groups that are not inside other\ngroups can be ungrouped. All the groups\nshould be on the same page. The group itself is deleted. The visual sizes\nand positions of all the children are preserved.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Shadow": {
- "description": "The shadow properties of a page element.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified shadow type.",
- "Outer shadow."
- ],
- "enum": [
- "SHADOW_TYPE_UNSPECIFIED",
- "OUTER"
- ],
- "description": "The type of the shadow."
- },
- "transform": {
- "$ref": "AffineTransform",
- "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position."
- },
- "alignment": {
- "enumDescriptions": [
- "Unspecified.",
- "Top left.",
- "Top center.",
- "Top right.",
- "Left center.",
- "Center.",
- "Right center.",
- "Bottom left.",
- "Bottom center.",
- "Bottom right."
- ],
- "enum": [
- "RECTANGLE_POSITION_UNSPECIFIED",
- "TOP_LEFT",
- "TOP_CENTER",
- "TOP_RIGHT",
- "LEFT_CENTER",
- "CENTER",
- "RIGHT_CENTER",
- "BOTTOM_LEFT",
- "BOTTOM_CENTER",
- "BOTTOM_RIGHT"
- ],
- "description": "The alignment point of the shadow, that sets the origin for translate,\nscale and skew of the shadow.",
- "type": "string"
- },
- "alpha": {
- "description": "The alpha of the shadow's color, from 0.0 to 1.0.",
- "format": "float",
- "type": "number"
- },
- "color": {
- "$ref": "OpaqueColor",
- "description": "The shadow color value."
- },
- "rotateWithShape": {
- "type": "boolean",
- "description": "Whether the shadow should rotate with the shape."
- },
- "propertyState": {
- "description": "The shadow property state.\n\nUpdating the shadow on a page element will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To have\nno shadow on a page element, set this field to `NOT_RENDERED`. In this\ncase, any other shadow fields set in the same request will be ignored.",
- "type": "string",
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ],
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ]
- },
- "blurRadius": {
- "$ref": "Dimension",
- "description": "The radius of the shadow blur. The larger the radius, the more diffuse the\nshadow becomes."
- }
- },
- "id": "Shadow"
- },
- "DeleteTableRowRequest": {
- "description": "Deletes a row from a table.",
- "type": "object",
- "properties": {
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The reference table cell location from which a row will be deleted.\n\nThe row this cell spans will be deleted. If this is a merged cell, multiple\nrows will be deleted. If no rows remain in the table after this deletion,\nthe whole table is deleted."
- },
- "tableObjectId": {
- "description": "The table to delete rows from.",
- "type": "string"
- }
- },
- "id": "DeleteTableRowRequest"
- },
- "Bullet": {
- "properties": {
- "bulletStyle": {
- "description": "The paragraph specific text style applied to this bullet.",
- "$ref": "TextStyle"
- },
- "listId": {
- "description": "The ID of the list this paragraph belongs to.",
- "type": "string"
- },
- "glyph": {
- "type": "string",
- "description": "The rendered bullet glyph for this paragraph."
- },
- "nestingLevel": {
- "description": "The nesting level of this paragraph in the list.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Bullet",
- "description": "Describes the bullet of a paragraph.",
- "type": "object"
- },
- "OutlineFill": {
- "description": "The fill of the outline.",
- "type": "object",
- "properties": {
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
- }
- },
- "id": "OutlineFill"
- },
- "CreateLineResponse": {
- "description": "The result of creating a line.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created line.",
- "type": "string"
- }
- },
- "id": "CreateLineResponse"
- },
- "TableCellLocation": {
- "description": "A location of a single table cell within a table.",
- "type": "object",
- "properties": {
- "rowIndex": {
- "description": "The 0-based row index.",
- "format": "int32",
- "type": "integer"
- },
- "columnIndex": {
- "description": "The 0-based column index.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TableCellLocation"
- },
- "ReplaceAllTextResponse": {
- "description": "The result of replacing text.",
- "type": "object",
- "properties": {
- "occurrencesChanged": {
- "type": "integer",
- "description": "The number of occurrences changed by replacing all text.",
- "format": "int32"
- }
- },
- "id": "ReplaceAllTextResponse"
- },
- "TableBorderFill": {
- "description": "The fill of the border.",
- "type": "object",
- "properties": {
- "solidFill": {
- "description": "Solid fill.",
- "$ref": "SolidFill"
- }
- },
- "id": "TableBorderFill"
- },
- "UpdateParagraphStyleRequest": {
- "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",
- "type": "string"
- },
- "objectId": {
- "description": "The object ID of the shape or table with the text to be styled.",
- "type": "string"
- },
- "textRange": {
- "$ref": "Range",
- "description": "The range of text containing the paragraph(s) to style."
- }
- },
- "id": "UpdateParagraphStyleRequest",
- "description": "Updates the styling for all of the paragraphs within a Shape or Table that\noverlap with the given text index range."
- },
- "ColorScheme": {
- "id": "ColorScheme",
- "description": "The palette of predefined colors for a page.",
- "type": "object",
- "properties": {
- "colors": {
- "description": "The ThemeColorType and corresponding concrete color pairs.",
- "type": "array",
- "items": {
- "$ref": "ThemeColorPair"
- }
- }
- }
- },
- "Shape": {
- "description": "A PageElement kind representing a\ngeneric shape that does not have a more specific classification.",
- "type": "object",
- "properties": {
- "shapeType": {
+ "description": "The type of the shape.",
"type": "string",
"enumDescriptions": [
"The shape type that is not predefined.",
@@ -2034,161 +3222,15 @@
"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",
- "RECTANGLE",
- "ROUND_RECTANGLE",
- "ELLIPSE",
- "ARC",
- "BENT_ARROW",
- "BENT_UP_ARROW",
- "BEVEL",
- "BLOCK_ARC",
- "BRACE_PAIR",
- "BRACKET_PAIR",
- "CAN",
- "CHEVRON",
- "CHORD",
- "CLOUD",
- "CORNER",
- "CUBE",
- "CURVED_DOWN_ARROW",
- "CURVED_LEFT_ARROW",
- "CURVED_RIGHT_ARROW",
- "CURVED_UP_ARROW",
- "DECAGON",
- "DIAGONAL_STRIPE",
- "DIAMOND",
- "DODECAGON",
- "DONUT",
- "DOUBLE_WAVE",
- "DOWN_ARROW",
- "DOWN_ARROW_CALLOUT",
- "FOLDED_CORNER",
- "FRAME",
- "HALF_FRAME",
- "HEART",
- "HEPTAGON",
- "HEXAGON",
- "HOME_PLATE",
- "HORIZONTAL_SCROLL",
- "IRREGULAR_SEAL_1",
- "IRREGULAR_SEAL_2",
- "LEFT_ARROW",
- "LEFT_ARROW_CALLOUT",
- "LEFT_BRACE",
- "LEFT_BRACKET",
- "LEFT_RIGHT_ARROW",
- "LEFT_RIGHT_ARROW_CALLOUT",
- "LEFT_RIGHT_UP_ARROW",
- "LEFT_UP_ARROW",
- "LIGHTNING_BOLT",
- "MATH_DIVIDE",
- "MATH_EQUAL",
- "MATH_MINUS",
- "MATH_MULTIPLY",
- "MATH_NOT_EQUAL",
- "MATH_PLUS",
- "MOON",
- "NO_SMOKING",
- "NOTCHED_RIGHT_ARROW",
- "OCTAGON",
- "PARALLELOGRAM",
- "PENTAGON",
- "PIE",
- "PLAQUE",
- "PLUS",
- "QUAD_ARROW",
- "QUAD_ARROW_CALLOUT",
- "RIBBON",
- "RIBBON_2",
- "RIGHT_ARROW",
- "RIGHT_ARROW_CALLOUT",
- "RIGHT_BRACE",
- "RIGHT_BRACKET",
- "ROUND_1_RECTANGLE",
- "ROUND_2_DIAGONAL_RECTANGLE",
- "ROUND_2_SAME_RECTANGLE",
- "RIGHT_TRIANGLE",
- "SMILEY_FACE",
- "SNIP_1_RECTANGLE",
- "SNIP_2_DIAGONAL_RECTANGLE",
- "SNIP_2_SAME_RECTANGLE",
- "SNIP_ROUND_RECTANGLE",
- "STAR_10",
- "STAR_12",
- "STAR_16",
- "STAR_24",
- "STAR_32",
- "STAR_4",
- "STAR_5",
- "STAR_6",
- "STAR_7",
- "STAR_8",
- "STRIPED_RIGHT_ARROW",
- "SUN",
- "TRAPEZOID",
- "TRIANGLE",
- "UP_ARROW",
- "UP_ARROW_CALLOUT",
- "UP_DOWN_ARROW",
- "UTURN_ARROW",
- "VERTICAL_SCROLL",
- "WAVE",
- "WEDGE_ELLIPSE_CALLOUT",
- "WEDGE_RECTANGLE_CALLOUT",
- "WEDGE_ROUND_RECTANGLE_CALLOUT",
- "FLOW_CHART_ALTERNATE_PROCESS",
- "FLOW_CHART_COLLATE",
- "FLOW_CHART_CONNECTOR",
- "FLOW_CHART_DECISION",
- "FLOW_CHART_DELAY",
- "FLOW_CHART_DISPLAY",
- "FLOW_CHART_DOCUMENT",
- "FLOW_CHART_EXTRACT",
- "FLOW_CHART_INPUT_OUTPUT",
- "FLOW_CHART_INTERNAL_STORAGE",
- "FLOW_CHART_MAGNETIC_DISK",
- "FLOW_CHART_MAGNETIC_DRUM",
- "FLOW_CHART_MAGNETIC_TAPE",
- "FLOW_CHART_MANUAL_INPUT",
- "FLOW_CHART_MANUAL_OPERATION",
- "FLOW_CHART_MERGE",
- "FLOW_CHART_MULTIDOCUMENT",
- "FLOW_CHART_OFFLINE_STORAGE",
- "FLOW_CHART_OFFPAGE_CONNECTOR",
- "FLOW_CHART_ONLINE_STORAGE",
- "FLOW_CHART_OR",
- "FLOW_CHART_PREDEFINED_PROCESS",
- "FLOW_CHART_PREPARATION",
- "FLOW_CHART_PROCESS",
- "FLOW_CHART_PUNCHED_CARD",
- "FLOW_CHART_PUNCHED_TAPE",
- "FLOW_CHART_SORT",
- "FLOW_CHART_SUMMING_JUNCTION",
- "FLOW_CHART_TERMINATOR",
- "ARROW_EAST",
- "ARROW_NORTH_EAST",
- "ARROW_NORTH",
- "SPEECH",
- "STARBURST",
- "TEARDROP",
- "ELLIPSE_RIBBON",
- "ELLIPSE_RIBBON_2",
- "CLOUD_CALLOUT",
- "CUSTOM"
- ],
- "description": "The type of the shape."
+ ]
},
"text": {
- "description": "The text content of the shape.",
- "$ref": "TextContent"
+ "$ref": "TextContent",
+ "description": "The text content of the shape."
},
"placeholder": {
- "description": "Placeholders are shapes that are inherit from corresponding placeholders on\nlayouts and masters.\n\nIf set, the shape is a placeholder shape and any inherited properties\ncan be resolved by looking at the parent placeholder identified by the\nPlaceholder.parent_object_id field.",
- "$ref": "Placeholder"
+ "$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."
},
"shapeProperties": {
"$ref": "ShapeProperties",
@@ -2198,49 +3240,28 @@
"id": "Shape"
},
"Image": {
- "id": "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": {
"type": "string",
"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."
}
- }
+ },
+ "id": "Image"
},
"AffineTransform": {
- "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",
"properties": {
- "scaleX": {
- "description": "The X coordinate scaling element.",
- "format": "double",
- "type": "number"
- },
- "shearX": {
- "type": "number",
- "description": "The X coordinate shearing element.",
- "format": "double"
- },
- "scaleY": {
- "description": "The Y coordinate scaling element.",
- "format": "double",
- "type": "number"
- },
- "translateY": {
- "description": "The Y coordinate translation element.",
- "format": "double",
- "type": "number"
- },
"translateX": {
+ "type": "number",
"description": "The X coordinate translation element.",
- "format": "double",
- "type": "number"
+ "format": "double"
},
"shearY": {
"description": "The Y coordinate shearing element.",
@@ -2248,6 +3269,7 @@
"type": "number"
},
"unit": {
+ "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.",
@@ -2258,20 +3280,38 @@
"EMU",
"PT"
],
- "description": "The units for translate elements.",
- "type": "string"
+ "description": "The units for translate elements."
+ },
+ "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": {
+ "type": "number",
+ "description": "The Y coordinate translation element.",
+ "format": "double"
}
- }
+ },
+ "id": "AffineTransform"
},
"InsertTextRequest": {
+ "description": "Inserts text into a shape or a table cell.",
+ "type": "object",
"properties": {
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The optional table cell location if the text is to be inserted into a table\ncell. If present, the object_id must refer to a table."
- },
"objectId": {
- "description": "The object ID of the shape or table where the text will be inserted.",
- "type": "string"
+ "type": "string",
+ "description": "The object ID of the shape or table where the text will be inserted."
},
"text": {
"description": "The text to be inserted.\n\nInserting a newline character will implicitly create a new\nParagraphMarker at that index.\nThe paragraph style of the new paragraph will be copied from the paragraph\nat the current insertion index, including lists and bullets.\n\nText styles for inserted text will be determined automatically, generally\npreserving the styling of neighboring text. In most cases, the text will be\nadded to the TextRun that exists at the\ninsertion index.\n\nSome control characters (U+0000-U+0008, U+000C-U+001F) and characters\nfrom the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF)\nwill be stripped out of the inserted text.",
@@ -2281,11 +3321,13 @@
"description": "The index where the text will be inserted, in Unicode code units, based\non TextElement indexes.\n\nThe index is zero-based and is computed from the start of the string.\nThe index may be adjusted to prevent insertions inside Unicode grapheme\nclusters. In these cases, the text will be inserted immediately after the\ngrapheme cluster.",
"format": "int32",
"type": "integer"
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The optional table cell location if the text is to be inserted into a table\ncell. If present, the object_id must refer to a table."
}
},
- "id": "InsertTextRequest",
- "description": "Inserts text into a shape or a table cell.",
- "type": "object"
+ "id": "InsertTextRequest"
},
"AutoText": {
"description": "A TextElement kind that represents auto text.",
@@ -2304,8 +3346,8 @@
]
},
"content": {
- "description": "The rendered content of this auto text, if available.",
- "type": "string"
+ "type": "string",
+ "description": "The rendered content of this auto text, if available."
},
"style": {
"$ref": "TextStyle",
@@ -2315,7 +3357,6 @@
"id": "AutoText"
},
"CreateVideoResponse": {
- "description": "The result of creating a video.",
"type": "object",
"properties": {
"objectId": {
@@ -2323,9 +3364,30 @@
"type": "string"
}
},
- "id": "CreateVideoResponse"
+ "id": "CreateVideoResponse",
+ "description": "The result of creating a video."
+ },
+ "DeleteTextRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the shape or table from which the text will be deleted."
+ },
+ "textRange": {
+ "$ref": "Range",
+ "description": "The range of text to delete, based on TextElement indexes.\n\nThere is always an implicit newline character at the end of a shape's or\ntable cell's text that cannot be deleted. `Range.Type.ALL` will use the\ncorrect bounds, but care must be taken when specifying explicit bounds for\nrange types `FROM_START_INDEX` and `FIXED_RANGE`. For example, if the text\nis \"ABC\", followed by an implicit newline, then the maximum value is 2 for\n`text_range.start_index` and 3 for `text_range.end_index`.\n\nDeleting text that crosses a paragraph boundary may result in changes\nto paragraph styles and lists as the two paragraphs are merged.\n\nRanges that include only one code unit of a surrogate pair are expanded to\ninclude both code units."
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The optional table cell location if the text is to be deleted from a table\ncell. If present, the object_id must refer to a table."
+ }
+ },
+ "id": "DeleteTextRequest",
+ "description": "Deletes text from a shape or a table cell."
},
"UpdatePageElementTransformRequest": {
+ "type": "object",
"properties": {
"objectId": {
"description": "The object ID of the page element to update.",
@@ -2336,85 +3398,35 @@
"description": "The input transform matrix used to update the page element."
},
"applyMode": {
+ "enum": [
+ "APPLY_MODE_UNSPECIFIED",
+ "RELATIVE",
+ "ABSOLUTE"
+ ],
"description": "The apply mode of the transform update.",
"type": "string",
"enumDescriptions": [
"Unspecified mode.",
"Applies the new AffineTransform matrix to the existing one, and\nreplaces the existing one with the resulting concatenation.",
"Replaces the existing AffineTransform matrix with the new one."
- ],
- "enum": [
- "APPLY_MODE_UNSPECIFIED",
- "RELATIVE",
- "ABSOLUTE"
]
}
},
"id": "UpdatePageElementTransformRequest",
- "description": "Updates the transform of a page element.\n\nUpdating the transform of a group will change the absolute transform of the\npage elements in that group, which can change their visual appearance. See\nthe documentation for PageElement.transform for more details.",
- "type": "object"
- },
- "DeleteTextRequest": {
- "description": "Deletes text from a shape or a table cell.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the shape or table from which the text will be deleted.",
- "type": "string"
- },
- "textRange": {
- "$ref": "Range",
- "description": "The range of text to delete, based on TextElement indexes.\n\nThere is always an implicit newline character at the end of a shape's or\ntable cell's text that cannot be deleted. `Range.Type.ALL` will use the\ncorrect bounds, but care must be taken when specifying explicit bounds for\nrange types `FROM_START_INDEX` and `FIXED_RANGE`. For example, if the text\nis \"ABC\", followed by an implicit newline, then the maximum value is 2 for\n`text_range.start_index` and 3 for `text_range.end_index`.\n\nDeleting text that crosses a paragraph boundary may result in changes\nto paragraph styles and lists as the two paragraphs are merged.\n\nRanges that include only one code unit of a surrogate pair are expanded to\ninclude both code units."
- },
- "cellLocation": {
- "description": "The optional table cell location if the text is to be deleted from a table\ncell. If present, the object_id must refer to a table.",
- "$ref": "TableCellLocation"
- }
- },
- "id": "DeleteTextRequest"
+ "description": "Updates the transform of a page element.\n\nUpdating the transform of a group will change the absolute transform of the\npage elements in that group, which can change their visual appearance. See\nthe documentation for PageElement.transform for more details."
},
"DeleteObjectRequest": {
"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"
+ "type": "string",
+ "description": "The object ID of the page or page element to delete.\n\nIf after a delete operation a group contains\nonly 1 or no page elements, the group is also deleted.\n\nIf a placeholder is deleted on a layout, any empty inheriting shapes are\nalso deleted."
}
},
"id": "DeleteObjectRequest"
},
- "TextElement": {
- "id": "TextElement",
- "description": "A TextElement describes the content of a range of indices in the text content\nof a Shape or TableCell.",
- "type": "object",
- "properties": {
- "textRun": {
- "$ref": "TextRun",
- "description": "A TextElement representing a run of text where all of the characters\nin the run have the same TextStyle.\n\nThe `start_index` and `end_index` of TextRuns will always be fully\ncontained in the index range of a single `paragraph_marker` TextElement.\nIn other words, a TextRun will never span multiple paragraphs."
- },
- "autoText": {
- "$ref": "AutoText",
- "description": "A TextElement representing a spot in the text that is dynamically\nreplaced with content that can change over time."
- },
- "paragraphMarker": {
- "$ref": "ParagraphMarker",
- "description": "A marker representing the beginning of a new paragraph.\n\nThe `start_index` and `end_index` of this TextElement represent the\nrange of the paragraph. Other TextElements with an index range contained\ninside this paragraph's range are considered to be part of this\nparagraph. The range of indices of two separate paragraphs will never\noverlap."
- },
- "startIndex": {
- "description": "The zero-based start index of this text element, in Unicode code units.",
- "format": "int32",
- "type": "integer"
- },
- "endIndex": {
- "type": "integer",
- "description": "The zero-based end index of this text element, exclusive, in Unicode code\nunits.",
- "format": "int32"
- }
- }
- },
"Dimension": {
- "id": "Dimension",
"description": "A magnitude in a single direction in the specified units.",
"type": "object",
"properties": {
@@ -2437,7 +3449,37 @@
],
"description": "The units for magnitude."
}
- }
+ },
+ "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": {
+ "textRun": {
+ "$ref": "TextRun",
+ "description": "A TextElement representing a run of text where all of the characters\nin the run have the same TextStyle.\n\nThe `start_index` and `end_index` of TextRuns will always be fully\ncontained in the index range of a single `paragraph_marker` TextElement.\nIn other words, a TextRun will never span multiple paragraphs."
+ },
+ "autoText": {
+ "$ref": "AutoText",
+ "description": "A TextElement representing a spot in the text that is dynamically\nreplaced with content that can change over time."
+ },
+ "paragraphMarker": {
+ "$ref": "ParagraphMarker",
+ "description": "A marker representing the beginning of a new paragraph.\n\nThe `start_index` and `end_index` of this TextElement represent the\nrange of the paragraph. Other TextElements with an index range contained\ninside this paragraph's range are considered to be part of this\nparagraph. The range of indices of two separate paragraphs will never\noverlap."
+ },
+ "startIndex": {
+ "type": "integer",
+ "description": "The zero-based start index of this text element, in Unicode code units.",
+ "format": "int32"
+ },
+ "endIndex": {
+ "type": "integer",
+ "description": "The zero-based end index of this text element, exclusive, in Unicode code\nunits.",
+ "format": "int32"
+ }
+ },
+ "id": "TextElement"
},
"LineFill": {
"description": "The fill of the line.",
@@ -2451,7 +3493,6 @@
"id": "LineFill"
},
"VideoProperties": {
- "id": "VideoProperties",
"description": "The properties of the Video.",
"type": "object",
"properties": {
@@ -2459,10 +3500,10 @@
"$ref": "Outline",
"description": "The outline of the video. The default outline matches the defaults for new\nvideos created in the Slides editor."
}
- }
+ },
+ "id": "VideoProperties"
},
"InsertTableRowsRequest": {
- "description": "Inserts rows into a table.",
"type": "object",
"properties": {
"tableObjectId": {
@@ -2470,8 +3511,8 @@
"type": "string"
},
"insertBelow": {
- "description": "Whether to insert new rows below the reference cell location.\n\n- `True`: insert below the cell.\n- `False`: insert above the cell.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether to insert new rows below the reference cell location.\n\n- `True`: insert below the cell.\n- `False`: insert above the cell."
},
"number": {
"description": "The number of rows to be inserted. Maximum 20 per request.",
@@ -2479,27 +3520,28 @@
"type": "integer"
},
"cellLocation": {
- "description": "The reference table cell location from which rows will be inserted.\n\nA new row will be inserted above (or below) the row where the reference\ncell is. If the reference cell is a merged cell, a new row will be\ninserted above (or below) the merged cell.",
- "$ref": "TableCellLocation"
+ "$ref": "TableCellLocation",
+ "description": "The reference table cell location from which rows will be inserted.\n\nA new row will be inserted above (or below) the row where the reference\ncell is. If the reference cell is a merged cell, a new row will be\ninserted above (or below) the merged cell."
}
},
- "id": "InsertTableRowsRequest"
+ "id": "InsertTableRowsRequest",
+ "description": "Inserts rows into a table."
},
"LayoutProperties": {
"description": "The properties of Page are only\nrelevant for pages with page_type LAYOUT.",
"type": "object",
"properties": {
- "name": {
- "description": "The name of the layout.",
- "type": "string"
- },
- "displayName": {
- "description": "The human-readable name of the layout.",
- "type": "string"
- },
"masterObjectId": {
"description": "The object ID of the master that this layout is based on.",
"type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the layout."
+ },
+ "displayName": {
+ "type": "string",
+ "description": "The human-readable name of the layout."
}
},
"id": "LayoutProperties"
@@ -2512,23 +3554,14 @@
"description": "The thickness of the line."
},
"lineFill": {
- "description": "The fill of the line. The default line fill matches the defaults for new\nlines created in the Slides editor.",
- "$ref": "LineFill"
+ "$ref": "LineFill",
+ "description": "The fill of the line. The default line fill matches the defaults for new\nlines created in the Slides editor."
},
"link": {
"$ref": "Link",
"description": "The hyperlink destination of the line. If unset, there is no link."
},
"dashStyle": {
- "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",
@@ -2539,9 +3572,31 @@
"LONG_DASH_DOT"
],
"description": "The dash style of the line.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified dash style.",
+ "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
+ "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
+ "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
+ "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
+ "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
+ "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
+ ]
},
"startArrow": {
+ "enum": [
+ "ARROW_STYLE_UNSPECIFIED",
+ "NONE",
+ "STEALTH_ARROW",
+ "FILL_ARROW",
+ "FILL_CIRCLE",
+ "FILL_SQUARE",
+ "FILL_DIAMOND",
+ "OPEN_ARROW",
+ "OPEN_CIRCLE",
+ "OPEN_SQUARE",
+ "OPEN_DIAMOND"
+ ],
"description": "The style of the arrow at the beginning of the line.",
"type": "string",
"enumDescriptions": [
@@ -2556,36 +3611,9 @@
"Hollow circle.",
"Hollow square.",
"Hollow diamond."
- ],
- "enum": [
- "ARROW_STYLE_UNSPECIFIED",
- "NONE",
- "STEALTH_ARROW",
- "FILL_ARROW",
- "FILL_CIRCLE",
- "FILL_SQUARE",
- "FILL_DIAMOND",
- "OPEN_ARROW",
- "OPEN_CIRCLE",
- "OPEN_SQUARE",
- "OPEN_DIAMOND"
]
},
"endArrow": {
- "enum": [
- "ARROW_STYLE_UNSPECIFIED",
- "NONE",
- "STEALTH_ARROW",
- "FILL_ARROW",
- "FILL_CIRCLE",
- "FILL_SQUARE",
- "FILL_DIAMOND",
- "OPEN_ARROW",
- "OPEN_CIRCLE",
- "OPEN_SQUARE",
- "OPEN_DIAMOND"
- ],
- "description": "The style of the arrow at the end of the line.",
"type": "string",
"enumDescriptions": [
"An unspecified arrow style.",
@@ -2599,27 +3627,65 @@
"Hollow circle.",
"Hollow square.",
"Hollow diamond."
- ]
+ ],
+ "enum": [
+ "ARROW_STYLE_UNSPECIFIED",
+ "NONE",
+ "STEALTH_ARROW",
+ "FILL_ARROW",
+ "FILL_CIRCLE",
+ "FILL_SQUARE",
+ "FILL_DIAMOND",
+ "OPEN_ARROW",
+ "OPEN_CIRCLE",
+ "OPEN_SQUARE",
+ "OPEN_DIAMOND"
+ ],
+ "description": "The style of the arrow at the end of the line."
}
},
"id": "LineProperties",
"description": "The properties of the Line.\n\nWhen unset, these fields default to values that match the appearance of\nnew lines created in the Slides editor."
},
"Presentation": {
- "id": "Presentation",
- "description": "A Google Slides presentation.",
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the presentation."
+ },
+ "layouts": {
+ "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."
+ },
+ "masters": {
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ },
+ "description": "The slide masters in the presentation. A slide master contains all common\npage elements and the common properties for a set of layouts. They serve\nthree purposes:\n\n- Placeholder shapes on a master contain the default text styles and shape\n properties of all placeholder shapes on pages that use that master.\n- The master page properties define the common page properties inherited by\n its layouts.\n- Any other shapes on the master slide will appear on all slides using that\n master, regardless of their layout."
+ },
+ "locale": {
+ "type": "string",
+ "description": "The locale of the presentation, as an IETF BCP 47 language tag."
+ },
+ "pageSize": {
+ "$ref": "Size",
+ "description": "The size of pages in the presentation."
+ },
"presentationId": {
"description": "The ID of the presentation.",
"type": "string"
},
"slides": {
- "description": "The slides in the presentation.\nA slide inherits properties from a slide layout.",
"type": "array",
"items": {
"$ref": "Page"
- }
+ },
+ "description": "The slides in the presentation.\nA slide inherits properties from a slide layout."
},
"revisionId": {
"type": "string",
@@ -2628,42 +3694,20 @@
"notesMaster": {
"$ref": "Page",
"description": "The notes master in the presentation. It serves three purposes:\n\n- Placeholder shapes on a notes master contain the default text styles and\n shape properties of all placeholder shapes on notes pages. Specifically,\n a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a\n `BODY` placeholder shape contains the speaker notes.\n- The notes master page properties define the common page properties\n inherited by all notes pages.\n- Any other shapes on the notes master will appear on all notes pages.\n\nThe notes master is read-only."
- },
- "title": {
- "description": "The title of the presentation.",
- "type": "string"
- },
- "layouts": {
- "description": "The layouts in the presentation. A layout is a template that determines\nhow content is arranged and styled on the slides that inherit from that\nlayout.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- },
- "masters": {
- "description": "The slide masters in the presentation. A slide master contains all common\npage elements and the common properties for a set of layouts. They serve\nthree purposes:\n\n- Placeholder shapes on a master contain the default text styles and shape\n properties of all placeholder shapes on pages that use that master.\n- The master page properties define the common page properties inherited by\n its layouts.\n- Any other shapes on the master slide will appear on all slides using that\n master, regardless of their layout.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- },
- "locale": {
- "description": "The locale of the presentation, as an IETF BCP 47 language tag.",
- "type": "string"
- },
- "pageSize": {
- "$ref": "Size",
- "description": "The size of pages in the presentation."
}
- }
+ },
+ "id": "Presentation",
+ "description": "A Google Slides presentation."
},
"OpaqueColor": {
+ "type": "object",
"properties": {
"rgbColor": {
- "description": "An opaque RGB color.",
- "$ref": "RgbColor"
+ "$ref": "RgbColor",
+ "description": "An opaque RGB color."
},
"themeColor": {
+ "type": "string",
"enumDescriptions": [
"Unspecified theme color. This value should not be used.",
"Represents the first dark color.",
@@ -2702,57 +3746,56 @@
"TEXT2",
"BACKGROUND2"
],
- "description": "An opaque theme color.",
- "type": "string"
+ "description": "An opaque theme color."
}
},
"id": "OpaqueColor",
- "description": "A themeable solid color value.",
- "type": "object"
+ "description": "A themeable solid color value."
},
"ImageProperties": {
- "description": "The properties of the Image.",
"type": "object",
"properties": {
- "transparency": {
- "description": "The transparency effect of the image. The value should be in the interval\n[0.0, 1.0], where 0 means no effect and 1 means completely transparent.\nThis property is read-only.",
- "format": "float",
- "type": "number"
- },
"shadow": {
- "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."
},
"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"
},
- "link": {
- "description": "The hyperlink destination of the image. If unset, there is no link.",
- "$ref": "Link"
+ "cropProperties": {
+ "$ref": "CropProperties",
+ "description": "The crop properties of the image. If not set, the image is not cropped.\nThis property is read-only."
},
"recolor": {
"$ref": "Recolor",
"description": "The recolor effect of the image. If not set, the image is not recolored.\nThis property is read-only."
},
- "cropProperties": {
- "description": "The crop properties of the image. If not set, the image is not cropped.\nThis property is read-only.",
- "$ref": "CropProperties"
- },
"outline": {
"$ref": "Outline",
"description": "The outline of the image. If not set, the image has no outline."
},
"brightness": {
+ "type": "number",
"description": "The brightness effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.",
- "format": "float",
- "type": "number"
+ "format": "float"
+ },
+ "transparency": {
+ "type": "number",
+ "description": "The transparency effect of the image. The value should be in the interval\n[0.0, 1.0], where 0 means no effect and 1 means completely transparent.\nThis property is read-only.",
+ "format": "float"
}
},
- "id": "ImageProperties"
+ "id": "ImageProperties",
+ "description": "The properties of the Image."
},
"ReplaceAllShapesWithImageResponse": {
+ "type": "object",
"properties": {
"occurrencesChanged": {
"description": "The number of shapes replaced with images.",
@@ -2761,11 +3804,9 @@
}
},
"id": "ReplaceAllShapesWithImageResponse",
- "description": "The result of replacing shapes with an image.",
- "type": "object"
+ "description": "The result of replacing shapes with an image."
},
"Line": {
- "description": "A PageElement kind representing a\nline, curved connector, or bent connector.",
"type": "object",
"properties": {
"lineProperties": {
@@ -2773,19 +3814,6 @@
"description": "The properties of the line."
},
"lineType": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "STRAIGHT_CONNECTOR_1",
- "BENT_CONNECTOR_2",
- "BENT_CONNECTOR_3",
- "BENT_CONNECTOR_4",
- "BENT_CONNECTOR_5",
- "CURVED_CONNECTOR_2",
- "CURVED_CONNECTOR_3",
- "CURVED_CONNECTOR_4",
- "CURVED_CONNECTOR_5"
- ],
- "description": "The type of the line.",
"type": "string",
"enumDescriptions": [
"An unspecified line type.",
@@ -2798,10 +3826,42 @@
"Curved connector 3 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector3'.",
"Curved connector 4 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector4'.",
"Curved connector 5 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector5'."
- ]
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "STRAIGHT_CONNECTOR_1",
+ "BENT_CONNECTOR_2",
+ "BENT_CONNECTOR_3",
+ "BENT_CONNECTOR_4",
+ "BENT_CONNECTOR_5",
+ "CURVED_CONNECTOR_2",
+ "CURVED_CONNECTOR_3",
+ "CURVED_CONNECTOR_4",
+ "CURVED_CONNECTOR_5"
+ ],
+ "description": "The type of the line."
}
},
- "id": "Line"
+ "id": "Line",
+ "description": "A PageElement kind representing a\nline, curved connector, or bent connector."
+ },
+ "BatchUpdatePresentationResponse": {
+ "description": "Response message from a batch update.",
+ "type": "object",
+ "properties": {
+ "replies": {
+ "type": "array",
+ "items": {
+ "$ref": "Response"
+ },
+ "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty."
+ },
+ "presentationId": {
+ "description": "The presentation the updates were applied to.",
+ "type": "string"
+ }
+ },
+ "id": "BatchUpdatePresentationResponse"
},
"CreateSheetsChartRequest": {
"description": "Creates an embedded Google Sheets chart.\n\nNOTE: Chart creation requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes.",
@@ -2812,8 +3872,8 @@
"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"
+ "$ref": "PageElementProperties",
+ "description": "The element properties for the chart.\n\nWhen the aspect ratio of the provided size does not match the chart aspect\nratio, the chart is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation."
},
"spreadsheetId": {
"description": "The ID of the Google Sheets spreadsheet that contains the chart.",
@@ -2832,31 +3892,13 @@
]
},
"chartId": {
+ "type": "integer",
"description": "The ID of the specific chart in the Google Sheets spreadsheet.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
}
},
"id": "CreateSheetsChartRequest"
},
- "BatchUpdatePresentationResponse": {
- "description": "Response message from a batch update.",
- "type": "object",
- "properties": {
- "presentationId": {
- "description": "The presentation the updates were applied to.",
- "type": "string"
- },
- "replies": {
- "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
- "type": "array",
- "items": {
- "$ref": "Response"
- }
- }
- },
- "id": "BatchUpdatePresentationResponse"
- },
"CreateImageResponse": {
"description": "The result of creating an image.",
"type": "object",
@@ -2869,52 +3911,65 @@
"id": "CreateImageResponse"
},
"SlideProperties": {
+ "type": "object",
"properties": {
- "notesPage": {
- "$ref": "Page",
- "description": "The notes page that this slide is associated with. It defines the visual\nappearance of a notes page when printing or exporting slides with speaker\nnotes. A notes page inherits properties from the\nnotes master.\nThe placeholder shape with type BODY on the notes page contains the speaker\nnotes for this slide. The ID of this shape is identified by the\nspeakerNotesObjectId field.\nThe notes page is read-only except for the text content and styles of the\nspeaker notes shape."
- },
"layoutObjectId": {
"description": "The object ID of the layout that this slide is based on.",
"type": "string"
},
"masterObjectId": {
- "description": "The object ID of the master that this slide is based on.",
- "type": "string"
+ "type": "string",
+ "description": "The object ID of the master that this slide is based on."
+ },
+ "notesPage": {
+ "$ref": "Page",
+ "description": "The notes page that this slide is associated with. It defines the visual\nappearance of a notes page when printing or exporting slides with speaker\nnotes. A notes page inherits properties from the\nnotes master.\nThe placeholder shape with type BODY on the notes page contains the speaker\nnotes for this slide. The ID of this shape is identified by the\nspeakerNotesObjectId field.\nThe notes page is read-only except for the text content and styles of the\nspeaker notes shape."
}
},
"id": "SlideProperties",
- "description": "The properties of Page that are only\nrelevant for pages with page_type SLIDE.",
- "type": "object"
+ "description": "The properties of Page that are only\nrelevant for pages with page_type SLIDE."
},
"MasterProperties": {
- "id": "MasterProperties",
"description": "The properties of Page that are only\nrelevant for pages with page_type MASTER.",
"type": "object",
"properties": {
"displayName": {
- "description": "The human-readable name of the master.",
- "type": "string"
+ "type": "string",
+ "description": "The human-readable name of the master."
}
- }
+ },
+ "id": "MasterProperties"
},
"Response": {
+ "type": "object",
"properties": {
+ "replaceAllShapesWithSheetsChart": {
+ "$ref": "ReplaceAllShapesWithSheetsChartResponse",
+ "description": "The result of replacing all shapes matching some criteria with a Google\nSheets chart."
+ },
+ "createSheetsChart": {
+ "$ref": "CreateSheetsChartResponse",
+ "description": "The result of creating a Google Sheets chart."
+ },
+ "groupObjects": {
+ "$ref": "GroupObjectsResponse",
+ "description": "The result of grouping objects."
+ },
"createShape": {
"$ref": "CreateShapeResponse",
"description": "The result of creating a shape."
},
"replaceAllShapesWithImage": {
- "description": "The result of replacing all shapes matching some criteria with an\nimage.",
- "$ref": "ReplaceAllShapesWithImageResponse"
+ "$ref": "ReplaceAllShapesWithImageResponse",
+ "description": "The result of replacing all shapes matching some criteria with an\nimage."
},
"createTable": {
"$ref": "CreateTableResponse",
"description": "The result of creating a table."
},
"replaceAllText": {
- "description": "The result of replacing text.",
- "$ref": "ReplaceAllTextResponse"
+ "$ref": "ReplaceAllTextResponse",
+ "description": "The result of replacing text."
},
"createSlide": {
"$ref": "CreateSlideResponse",
@@ -2925,36 +3980,22 @@
"description": "The result of duplicating an object."
},
"createLine": {
- "description": "The result of creating a line.",
- "$ref": "CreateLineResponse"
+ "$ref": "CreateLineResponse",
+ "description": "The result of creating a line."
},
"createImage": {
- "description": "The result of creating an image.",
- "$ref": "CreateImageResponse"
+ "$ref": "CreateImageResponse",
+ "description": "The result of creating an image."
},
"createVideo": {
"$ref": "CreateVideoResponse",
"description": "The result of creating a video."
- },
- "createSheetsChart": {
- "description": "The result of creating a Google Sheets chart.",
- "$ref": "CreateSheetsChartResponse"
- },
- "replaceAllShapesWithSheetsChart": {
- "$ref": "ReplaceAllShapesWithSheetsChartResponse",
- "description": "The result of replacing all shapes matching some criteria with a Google\nSheets chart."
- },
- "groupObjects": {
- "$ref": "GroupObjectsResponse",
- "description": "The result of grouping objects."
}
},
"id": "Response",
- "description": "A single response from an update.",
- "type": "object"
+ "description": "A single response from an update."
},
"SubstringMatchCriteria": {
- "description": "A criteria that matches a specific string of text in a shape or table.",
"type": "object",
"properties": {
"text": {
@@ -2966,30 +4007,13 @@
"type": "boolean"
}
},
- "id": "SubstringMatchCriteria"
+ "id": "SubstringMatchCriteria",
+ "description": "A criteria that matches a specific string of text in a shape or table."
},
"LayoutReference": {
"type": "object",
"properties": {
- "layoutId": {
- "description": "Layout ID: the object ID of one of the layouts in the presentation.",
- "type": "string"
- },
"predefinedLayout": {
- "enumDescriptions": [
- "Unspecified layout.",
- "Blank layout, with no placeholders.",
- "Layout with a caption at the bottom.",
- "Layout with a title and a subtitle.",
- "Layout with a title and body.",
- "Layout with a title and two columns.",
- "Layout with only a title.",
- "Layout with a section title.",
- "Layout with a title and subtitle on one side and description on the other.",
- "Layout with one title and one body, arranged in a single column.",
- "Layout with a main point.",
- "Layout with a big number heading."
- ],
"enum": [
"PREDEFINED_LAYOUT_UNSPECIFIED",
"BLANK",
@@ -3005,6 +4029,24 @@
"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."
+ ]
+ },
+ "layoutId": {
+ "description": "Layout ID: the object ID of one of the layouts in the presentation.",
"type": "string"
}
},
@@ -3014,13 +4056,13 @@
"TextRun": {
"type": "object",
"properties": {
- "style": {
- "description": "The styling applied to this run.",
- "$ref": "TextStyle"
- },
"content": {
- "type": "string",
- "description": "The text of this run."
+ "description": "The text of this run.",
+ "type": "string"
+ },
+ "style": {
+ "$ref": "TextStyle",
+ "description": "The styling applied to this run."
}
},
"id": "TextRun",
@@ -3048,15 +4090,9 @@
"id": "TableRange"
},
"CreateTableRequest": {
- "id": "CreateTableRequest",
"description": "Creates a new table.",
"type": "object",
"properties": {
- "rows": {
- "description": "Number of rows in the table.",
- "format": "int32",
- "type": "integer"
- },
"objectId": {
"description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
"type": "string"
@@ -3069,16 +4105,22 @@
"elementProperties": {
"$ref": "PageElementProperties",
"description": "The element properties for the table.\n\nThe table will be created at the provided size, subject to a minimum size.\nIf no size is provided, the table will be automatically sized.\n\nTable transforms must have a scale of 1 and no shear components. If no\ntransform is provided, the table will be centered on the page."
+ },
+ "rows": {
+ "type": "integer",
+ "description": "Number of rows in the table.",
+ "format": "int32"
}
- }
+ },
+ "id": "CreateTableRequest"
},
"CreateTableResponse": {
"description": "The result of creating a table.",
"type": "object",
"properties": {
"objectId": {
- "description": "The object ID of the created table.",
- "type": "string"
+ "type": "string",
+ "description": "The object ID of the created table."
}
},
"id": "CreateTableResponse"
@@ -3086,31 +4128,17 @@
"Table": {
"type": "object",
"properties": {
- "tableRows": {
- "description": "Properties and contents of each row.\n\nCells that span multiple rows are contained in only one of these rows and\nhave a row_span greater\nthan 1.",
- "type": "array",
- "items": {
- "$ref": "TableRow"
- }
- },
- "horizontalBorderRows": {
- "description": "Properties of horizontal cell borders.\n\nA table's horizontal cell borders are represented as a grid. The grid has\none more row than the number of rows in the table and the same number of\ncolumns as the table. For example, if the table is 3 x 3, its horizontal\nborders will be represented as a grid with 4 rows and 3 columns.",
- "type": "array",
- "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"
- }
+ },
+ "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."
},
"rows": {
+ "type": "integer",
"description": "Number of rows in the table.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"tableColumns": {
"description": "Properties of each column.",
@@ -3123,31 +4151,44 @@
"description": "Number of columns in the table.",
"format": "int32",
"type": "integer"
+ },
+ "tableRows": {
+ "type": "array",
+ "items": {
+ "$ref": "TableRow"
+ },
+ "description": "Properties and contents of each row.\n\nCells that span multiple rows are contained in only one of these rows and\nhave a row_span greater\nthan 1."
+ },
+ "horizontalBorderRows": {
+ "description": "Properties of horizontal cell borders.\n\nA table's horizontal cell borders are represented as a grid. The grid has\none more row than the number of rows in the table and the same number of\ncolumns as the table. For example, if the table is 3 x 3, its horizontal\nborders will be represented as a grid with 4 rows and 3 columns.",
+ "type": "array",
+ "items": {
+ "$ref": "TableBorderRow"
+ }
}
},
"id": "Table",
"description": "A PageElement kind representing a\ntable."
},
"GroupObjectsRequest": {
- "id": "GroupObjectsRequest",
"description": "Groups objects to create an object group. For example, groups PageElements to create a Group on the same page as all the children.",
"type": "object",
"properties": {
"groupObjectId": {
- "description": "A user-supplied object ID for the group to be created.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
- "type": "string"
+ "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"
- }
+ },
+ "description": "The object IDs of the objects to group.\n\nOnly page elements can be grouped. There should be at least two page\nelements on the same page that are not already in another group. Some page\nelements, such as videos, tables and placeholder shapes cannot be grouped."
}
- }
+ },
+ "id": "GroupObjectsRequest"
},
"TableBorderRow": {
- "description": "Contents of each border row in a table.",
"type": "object",
"properties": {
"tableBorderCells": {
@@ -3158,18 +4199,13 @@
}
}
},
- "id": "TableBorderRow"
+ "id": "TableBorderRow",
+ "description": "Contents of each border row in a table."
},
"PageBackgroundFill": {
- "description": "The page background fill.",
"type": "object",
"properties": {
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
- },
"propertyState": {
- "description": "The background fill property state.\n\nUpdating the fill on a page will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To\nhave no fill on a page, set this field to `NOT_RENDERED`. In this case,\nany other fill fields set in the same request will be ignored.",
"type": "string",
"enumDescriptions": [
"If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
@@ -3180,25 +4216,24 @@
"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."
},
"stretchedPictureFill": {
- "description": "Stretched picture fill.",
- "$ref": "StretchedPictureFill"
+ "$ref": "StretchedPictureFill",
+ "description": "Stretched picture fill."
+ },
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
}
},
- "id": "PageBackgroundFill"
+ "id": "PageBackgroundFill",
+ "description": "The page background fill."
},
"SheetsChart": {
- "id": "SheetsChart",
- "description": "A PageElement kind representing\na linked chart embedded from Google Sheets.",
"type": "object",
"properties": {
- "chartId": {
- "description": "The ID of the specific chart in the Google Sheets spreadsheet that is\nembedded.",
- "format": "int32",
- "type": "integer"
- },
"sheetsChartProperties": {
"$ref": "SheetsChartProperties",
"description": "The properties of the Sheets chart."
@@ -3208,12 +4243,20 @@
"type": "string"
},
"spreadsheetId": {
- "description": "The ID of the Google Sheets spreadsheet that contains the source chart.",
- "type": "string"
+ "type": "string",
+ "description": "The ID of the Google Sheets spreadsheet that contains the source chart."
+ },
+ "chartId": {
+ "description": "The ID of the specific chart in the Google Sheets spreadsheet that is\nembedded.",
+ "format": "int32",
+ "type": "integer"
}
- }
+ },
+ "id": "SheetsChart",
+ "description": "A PageElement kind representing\na linked chart embedded from Google Sheets."
},
"SolidFill": {
+ "description": "A solid color fill. The page or page element is filled entirely with the\nspecified color value.\n\nIf any field is unset, its value may be inherited from a parent placeholder\nif it exists.",
"type": "object",
"properties": {
"alpha": {
@@ -3226,1083 +4269,40 @@
"description": "The color value of the solid fill."
}
},
- "id": "SolidFill",
- "description": "A solid color fill. The page or page element is filled entirely with the\nspecified color value.\n\nIf any field is unset, its value may be inherited from a parent placeholder\nif it exists."
- },
- "ThemeColorPair": {
- "description": "A pair mapping a theme color type to the concrete color it represents.",
- "type": "object",
- "properties": {
- "color": {
- "$ref": "RgbColor",
- "description": "The concrete color corresponding to the theme color type above."
+ "id": "SolidFill"
+ }
+ },
+ "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": "Slides",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "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"
},
- "type": {
- "enumDescriptions": [
- "Unspecified theme color. This value should not be used.",
- "Represents the first dark color.",
- "Represents the first light color.",
- "Represents the second dark color.",
- "Represents the second light color.",
- "Represents the first accent color.",
- "Represents the second accent color.",
- "Represents the third accent color.",
- "Represents the fourth accent color.",
- "Represents the fifth accent color.",
- "Represents the sixth accent color.",
- "Represents the color to use for hyperlinks.",
- "Represents the color to use for visited hyperlinks.",
- "Represents the first text color.",
- "Represents the first background color.",
- "Represents the second text color.",
- "Represents the second background color."
- ],
- "enum": [
- "THEME_COLOR_TYPE_UNSPECIFIED",
- "DARK1",
- "LIGHT1",
- "DARK2",
- "LIGHT2",
- "ACCENT1",
- "ACCENT2",
- "ACCENT3",
- "ACCENT4",
- "ACCENT5",
- "ACCENT6",
- "HYPERLINK",
- "FOLLOWED_HYPERLINK",
- "TEXT1",
- "BACKGROUND1",
- "TEXT2",
- "BACKGROUND2"
- ],
- "description": "The type of the theme color.",
- "type": "string"
- }
- },
- "id": "ThemeColorPair"
- },
- "OptionalColor": {
- "id": "OptionalColor",
- "description": "A color that can either be fully opaque or fully transparent.",
- "type": "object",
- "properties": {
- "opaqueColor": {
- "$ref": "OpaqueColor",
- "description": "If set, this will be used as an opaque color. If unset, this represents\na transparent color."
+ "https://www.googleapis.com/auth/drive.readonly": {
+ "description": "View the files in your Google Drive"
+ },
+ "https://www.googleapis.com/auth/spreadsheets.readonly": {
+ "description": "View your Google Spreadsheets"
+ },
+ "https://www.googleapis.com/auth/drive": {
+ "description": "View and manage the files in your Google Drive"
+ },
+ "https://www.googleapis.com/auth/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"
}
}
- },
- "PageElementProperties": {
- "description": "Common properties for a page element.\n\nNote: When you initially create a\nPageElement, the API may modify\nthe values of both `size` and `transform`, but the\nvisual size will be unchanged.",
- "type": "object",
- "properties": {
- "transform": {
- "$ref": "AffineTransform",
- "description": "The transform for the element."
- },
- "pageObjectId": {
- "description": "The object ID of the page where the element is located.",
- "type": "string"
- },
- "size": {
- "$ref": "Size",
- "description": "The size of the element."
- }
- },
- "id": "PageElementProperties"
- },
- "SheetsChartProperties": {
- "description": "The properties of the SheetsChart.",
- "type": "object",
- "properties": {
- "chartImageProperties": {
- "description": "The properties of the embedded chart image.",
- "$ref": "ImageProperties"
- }
- },
- "id": "SheetsChartProperties"
- },
- "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": {
- "contentUrl": {
- "description": "Reading the content_url:\n\nAn URL to a picture with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the picture as the original requester. Access to the\npicture may be lost if the presentation's sharing settings change.\n\nWriting the content_url:\n\nThe picture is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Pictures must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at most 2 kB in length.",
- "type": "string"
- },
- "size": {
- "$ref": "Size",
- "description": "The original size of the picture fill. This field is read-only."
- }
- },
- "id": "StretchedPictureFill"
- },
- "DeleteTableColumnRequest": {
- "description": "Deletes a column from a table.",
- "type": "object",
- "properties": {
- "tableObjectId": {
- "description": "The table to delete columns from.",
- "type": "string"
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The reference table cell location from which a column will be deleted.\n\nThe column this cell spans will be deleted. If this is a merged cell,\nmultiple columns will be deleted. If no columns remain in the table after\nthis deletion, the whole table is deleted."
- }
- },
- "id": "DeleteTableColumnRequest"
- },
- "UpdateTextStyleRequest": {
- "description": "Update the styling of text in a Shape or\nTable.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the shape or table with the text to be styled.",
- "type": "string"
- },
- "textRange": {
- "description": "The range of text to style.\n\nThe range may be extended to include adjacent newlines.\n\nIf the range fully contains a paragraph belonging to a list, the\nparagraph's bullet is also updated with the matching text style.",
- "$ref": "Range"
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The location of the cell in the table containing the text to style. If\n`object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not."
- },
- "style": {
- "$ref": "TextStyle",
- "description": "The style(s) to set on the text.\n\nIf the value for a particular style matches that of the parent, that style\nwill be set to inherit.\n\nCertain text style changes may cause other changes meant to mirror the\nbehavior of the Slides editor. See the documentation of\nTextStyle for more information."
- },
- "fields": {
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the text style to bold, set `fields` to `\"bold\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateTextStyleRequest"
- },
- "List": {
- "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",
- "properties": {
- "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"
- },
- "listId": {
- "description": "The ID of the list.",
- "type": "string"
- }
- }
- },
- "WeightedFontFamily": {
- "description": "Represents a font family and weight used to style a TextRun.",
- "type": "object",
- "properties": {
- "fontFamily": {
- "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`.",
- "type": "string"
- },
- "weight": {
- "description": "The rendered weight of the text. This field can have any value that is a\nmultiple of `100` between `100` and `900`, inclusive. This range\ncorresponds to the numerical values described in the CSS 2.1\nSpecification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),\nwith non-numerical values disallowed. Weights greater than or equal to\n`700` are considered bold, and weights less than `700`are not bold. The\ndefault value is `400` (\"normal\").",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "WeightedFontFamily"
- },
- "PageElement": {
- "description": "A visual element rendered on a page.",
- "type": "object",
- "properties": {
- "size": {
- "$ref": "Size",
- "description": "The size of the page element."
- },
- "title": {
- "type": "string",
- "description": "The title of the page element. Combined with description to display alt\ntext."
- },
- "sheetsChart": {
- "description": "A linked chart embedded from Google Sheets. Unlinked charts are\nrepresented as images.",
- "$ref": "SheetsChart"
- },
- "video": {
- "description": "A video page element.",
- "$ref": "Video"
- },
- "wordArt": {
- "description": "A word art page element.",
- "$ref": "WordArt"
- },
- "table": {
- "$ref": "Table",
- "description": "A table page element."
- },
- "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"
- },
- "shape": {
- "description": "A generic shape.",
- "$ref": "Shape"
- },
- "line": {
- "description": "A line page element.",
- "$ref": "Line"
- },
- "description": {
- "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."
- },
- "image": {
- "$ref": "Image",
- "description": "An image page element."
- }
- },
- "id": "PageElement"
- },
- "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."
- },
- "url": {
- "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at most 2 kB in length.",
- "type": "string"
- }
- },
- "id": "CreateImageRequest"
- },
- "CreateParagraphBulletsRequest": {
- "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": [
- "A bulleted list with a `DISC`, `CIRCLE` and `SQUARE` bullet glyph for the\nfirst 3 list nesting levels.",
- "A bulleted list with a `DIAMONDX`, `ARROW3D` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with `CHECKBOX` bullet glyphs for all list nesting levels.",
- "A bulleted list with a `ARROW`, `DIAMOND` and `DISC` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with a `STAR`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with a `ARROW3D`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with a `LEFTTRIANGLE`, `DIAMOND` and `DISC` bullet glyph\nfor the first 3 list nesting levels.",
- "A bulleted list with a `DIAMONDX`, `HOLLOWDIAMOND` and `SQUARE` bullet\nglyph for the first 3 list nesting levels.",
- "A bulleted list with a `DIAMOND`, `CIRCLE` and `SQUARE` bullet glyph\nfor the first 3 list nesting levels.",
- "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
- "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by parenthesis.",
- "A numbered list with `DIGIT` numeric glyphs separated by periods, where\neach nesting level uses the previous nesting level's glyph as a prefix.\nFor example: '1.', '1.1.', '2.', '2.2.'.",
- "A numbered list with `UPPERALPHA`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
- "A numbered list with `UPPERROMAN`, `UPPERALPHA` and `DIGIT` numeric glyphs\nfor the first 3 list nesting levels, followed by periods.",
- "A numbered list with `ZERODIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods."
- ]
- },
- "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": "CreateParagraphBulletsRequest"
- },
- "Size": {
- "type": "object",
- "properties": {
- "height": {
- "$ref": "Dimension",
- "description": "The height of the object."
- },
- "width": {
- "$ref": "Dimension",
- "description": "The width of the object."
- }
- },
- "id": "Size",
- "description": "A width and height."
- },
- "TextStyle": {
- "description": "Represents the styling that can be applied to a TextRun.\n\nIf this text is contained in a shape with a parent placeholder, then these text styles may be\ninherited from the parent. Which text styles are inherited depend on the\nnesting level of lists:\n\n* A text run in a paragraph that is not in a list will inherit its text style\n from the the newline character in the paragraph at the 0 nesting level of\n the list inside the parent placeholder.\n* A text run in a paragraph that is in a list will inherit its text style\n from the newline character in the paragraph at its corresponding nesting\n level of the list inside the parent placeholder.\n\nInherited text styles are represented as unset fields in this message. If\ntext is contained in a shape without a parent placeholder, unsetting these\nfields will revert the style to a value matching the defaults in the Slides\neditor.",
- "type": "object",
- "properties": {
- "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": {
- "description": "Whether or not the text is underlined.",
- "type": "boolean"
- },
- "link": {
- "$ref": "Link",
- "description": "The hyperlink destination of the text. If unset, there is no link. Links\nare not inherited from parent text.\n\nChanging the link in an update request causes some other changes to the\ntext style of the range:\n\n* When setting a link, the text foreground color will be set to\n ThemeColorType.HYPERLINK and the text will\n be underlined. If these fields are modified in the same\n request, those values will be used instead of the link defaults.\n* Setting a link on a text range that overlaps with an existing link will\n also update the existing link to point to the new URL.\n* Links are not settable on newline characters. As a result, setting a link\n on a text range that crosses a paragraph boundary, such as `\"ABC\\n123\"`,\n will separate the newline character(s) into their own text runs. The\n link will be applied separately to the runs before and after the newline.\n* Removing a link will update the text style of the range to match the\n style of the preceding text (or the default text styles if the preceding\n text is another link) unless different styles are being set in the same\n request."
- },
- "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": {
- "type": "boolean",
- "description": "Whether or not the text is rendered as bold."
- },
- "fontFamily": {
- "type": "string",
- "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`.\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."
- },
- "strikethrough": {
- "description": "Whether or not the text is struck through.",
- "type": "boolean"
- },
- "italic": {
- "type": "boolean",
- "description": "Whether or not the text is italicized."
- },
- "fontSize": {
- "$ref": "Dimension",
- "description": "The size of the text's font. When read, the `font_size` will specified in\npoints."
- },
- "baselineOffset": {
- "enum": [
- "BASELINE_OFFSET_UNSPECIFIED",
- "NONE",
- "SUPERSCRIPT",
- "SUBSCRIPT"
- ],
- "description": "The text's vertical offset from its normal position.\n\nText with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically\nrendered in a smaller font size, computed based on the `font_size` field.\nThe `font_size` itself is not affected by changes in this field.",
- "type": "string",
- "enumDescriptions": [
- "The text's baseline offset is inherited from the parent.",
- "The text is not vertically offset.",
- "The text is vertically offset upwards (superscript).",
- "The text is vertically offset downwards (subscript)."
- ]
- },
- "weightedFontFamily": {
- "$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"
- }
- },
- "id": "TextStyle"
- },
- "UpdateVideoPropertiesRequest": {
- "id": "UpdateVideoPropertiesRequest",
- "description": "Update the properties of a Video.",
- "type": "object",
- "properties": {
- "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"
- },
- "videoProperties": {
- "description": "The video properties to update.",
- "$ref": "VideoProperties"
- }
- }
- },
- "Request": {
- "description": "A single kind of update to apply to a presentation.",
- "type": "object",
- "properties": {
- "updateParagraphStyle": {
- "$ref": "UpdateParagraphStyleRequest",
- "description": "Updates the styling of paragraphs within a Shape or Table."
- },
- "duplicateObject": {
- "$ref": "DuplicateObjectRequest",
- "description": "Duplicates a slide or page element."
- },
- "deleteTableColumn": {
- "description": "Deletes a column from a table.",
- "$ref": "DeleteTableColumnRequest"
- },
- "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": {
- "$ref": "CreateParagraphBulletsRequest",
- "description": "Creates bullets for paragraphs."
- },
- "createVideo": {
- "description": "Creates a video.",
- "$ref": "CreateVideoRequest"
- },
- "createSheetsChart": {
- "$ref": "CreateSheetsChartRequest",
- "description": "Creates an embedded Google Sheets chart."
- },
- "replaceAllShapesWithSheetsChart": {
- "$ref": "ReplaceAllShapesWithSheetsChartRequest",
- "description": "Replaces all shapes matching some criteria with a Google Sheets chart."
- },
- "unmergeTableCells": {
- "$ref": "UnmergeTableCellsRequest",
- "description": "Unmerges cells in a Table."
- },
- "updatePageElementTransform": {
- "$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": {
- "description": "Updates the properties of a Line.",
- "$ref": "UpdateLinePropertiesRequest"
- },
- "updateSlidesPosition": {
- "$ref": "UpdateSlidesPositionRequest",
- "description": "Updates the position of a set of slides in the presentation."
- },
- "deleteTableRow": {
- "$ref": "DeleteTableRowRequest",
- "description": "Deletes a row from a table."
- },
- "updateShapeProperties": {
- "$ref": "UpdateShapePropertiesRequest",
- "description": "Updates the properties of a Shape."
- },
- "groupObjects": {
- "description": "Groups objects, such as page elements.",
- "$ref": "GroupObjectsRequest"
- },
- "ungroupObjects": {
- "$ref": "UngroupObjectsRequest",
- "description": "Ungroups objects, such as groups."
- },
- "insertText": {
- "description": "Inserts text into a shape or table cell.",
- "$ref": "InsertTextRequest"
- },
- "updateTableColumnProperties": {
- "$ref": "UpdateTableColumnPropertiesRequest",
- "description": "Updates the properties of a Table\ncolumn."
- },
- "deleteText": {
- "$ref": "DeleteTextRequest",
- "description": "Deletes text from a shape or a table cell."
- },
- "updatePageProperties": {
- "$ref": "UpdatePagePropertiesRequest",
- "description": "Updates the properties of a Page."
- },
- "deleteParagraphBullets": {
- "$ref": "DeleteParagraphBulletsRequest",
- "description": "Deletes bullets from paragraphs."
- },
- "createShape": {
- "description": "Creates a new shape.",
- "$ref": "CreateShapeRequest"
- },
- "updatePageElementAltText": {
- "description": "Updates the alt text title and/or description of a\npage element.",
- "$ref": "UpdatePageElementAltTextRequest"
- },
- "updateTableBorderProperties": {
- "$ref": "UpdateTableBorderPropertiesRequest",
- "description": "Updates the properties of the table borders in a Table."
- },
- "insertTableColumns": {
- "$ref": "InsertTableColumnsRequest",
- "description": "Inserts columns into a table."
- },
- "mergeTableCells": {
- "description": "Merges cells in a Table.",
- "$ref": "MergeTableCellsRequest"
- },
- "refreshSheetsChart": {
- "$ref": "RefreshSheetsChartRequest",
- "description": "Refreshes a Google Sheets chart."
- },
- "createTable": {
- "description": "Creates a new table.",
- "$ref": "CreateTableRequest"
- },
- "updateTableCellProperties": {
- "description": "Updates the properties of a TableCell.",
- "$ref": "UpdateTableCellPropertiesRequest"
- },
- "deleteObject": {
- "$ref": "DeleteObjectRequest",
- "description": "Deletes a page or page element from the presentation."
- }
- },
- "id": "Request"
- },
- "UpdateImagePropertiesRequest": {
- "description": "Update the properties of an Image.",
- "type": "object",
- "properties": {
- "fields": {
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `imageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the image outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "imageProperties": {
- "description": "The image properties to update.",
- "$ref": "ImageProperties"
- },
- "objectId": {
- "description": "The object ID of the image the updates are applied to.",
- "type": "string"
- }
- },
- "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": {
- "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"
- },
- "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"
- },
- "spaceBelow": {
- "$ref": "Dimension",
- "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent."
- },
- "direction": {
- "enumDescriptions": [
- "The text direction is inherited from the parent.",
- "The text goes from left to right.",
- "The text goes from right to left."
- ],
- "enum": [
- "TEXT_DIRECTION_UNSPECIFIED",
- "LEFT_TO_RIGHT",
- "RIGHT_TO_LEFT"
- ],
- "description": "The text direction of this paragraph. If unset, the value defaults to\nLEFT_TO_RIGHT since\ntext direction is not inherited.",
- "type": "string"
- },
- "spacingMode": {
- "enumDescriptions": [
- "The spacing mode is inherited from the parent.",
- "Paragraph spacing is always rendered.",
- "Paragraph spacing is skipped between list elements."
- ],
- "enum": [
- "SPACING_MODE_UNSPECIFIED",
- "NEVER_COLLAPSE",
- "COLLAPSE_LISTS"
- ],
- "description": "The spacing mode for the paragraph.",
- "type": "string"
- },
- "indentEnd": {
- "$ref": "Dimension",
- "description": "The amount indentation for the paragraph on the side that corresponds to\nthe end of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent."
- },
- "indentStart": {
- "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.",
- "$ref": "Dimension"
- },
- "spaceAbove": {
- "$ref": "Dimension",
- "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent."
- }
- },
- "id": "ParagraphStyle"
- },
- "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": {
- "$ref": "TableRowProperties",
- "description": "The table row properties to update."
- },
- "objectId": {
- "description": "The object ID of the table.",
- "type": "string"
- }
- },
- "id": "UpdateTableRowPropertiesRequest",
- "description": "Updates the properties of a Table row.",
- "type": "object"
- },
- "ReplaceAllShapesWithSheetsChartResponse": {
- "id": "ReplaceAllShapesWithSheetsChartResponse",
- "description": "The result of replacing shapes with a Google Sheets chart.",
- "type": "object",
- "properties": {
- "occurrencesChanged": {
- "type": "integer",
- "description": "The number of shapes replaced with charts.",
- "format": "int32"
- }
- }
- },
- "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": {
- "description": "The alignment of the content in the table cell. The default alignment\nmatches the alignment for newly created table cells in the Slides editor.",
- "type": "string",
- "enumDescriptions": [
- "An unspecified content alignment. The content alignment is inherited from\nthe parent if it exists.",
- "An unsupported content alignment.",
- "An alignment that aligns the content to the top of the content holder.\nCorresponds to ECMA-376 ST_TextAnchoringType 't'.",
- "An alignment that aligns the content to the middle of the content\nholder. Corresponds to ECMA-376 ST_TextAnchoringType 'ctr'.",
- "An alignment that aligns the content to the bottom of the content\nholder. Corresponds to ECMA-376 ST_TextAnchoringType 'b'."
- ],
- "enum": [
- "CONTENT_ALIGNMENT_UNSPECIFIED",
- "CONTENT_ALIGNMENT_UNSUPPORTED",
- "TOP",
- "MIDDLE",
- "BOTTOM"
- ]
- }
- },
- "id": "TableCellProperties"
- },
- "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": {
- "description": "The outline of a PageElement.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
- "type": "object",
- "properties": {
- "outlineFill": {
- "description": "The fill of the outline.",
- "$ref": "OutlineFill"
- },
- "weight": {
- "description": "The thickness of the outline.",
- "$ref": "Dimension"
- },
- "dashStyle": {
- "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'."
- ],
- "enum": [
- "DASH_STYLE_UNSPECIFIED",
- "SOLID",
- "DOT",
- "DASH",
- "DASH_DOT",
- "LONG_DASH",
- "LONG_DASH_DOT"
- ]
- },
- "propertyState": {
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The outline property state.\n\nUpdating the outline on a page element will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no outline on a page element, set this field to `NOT_RENDERED`. In\nthis case, any other outline fields set in the same request will be\nignored.",
- "type": "string",
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ]
- }
- },
- "id": "Outline"
- },
- "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": {
- "$ref": "Outline",
- "description": "The outline of the shape. If unset, the outline is inherited from a\nparent placeholder if it exists. If the shape has no parent, then the\ndefault outline depends on the shape type, matching the defaults for\nnew shapes created in the Slides editor."
- },
- "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": {
- "$ref": "Link",
- "description": "The hyperlink destination of the shape. If unset, there is no link. Links\nare not inherited from parent placeholders."
- }
- },
- "id": "ShapeProperties"
- },
- "TableColumnProperties": {
- "description": "Properties of each column in a table.",
- "type": "object",
- "properties": {
- "columnWidth": {
- "description": "Width of a column.",
- "$ref": "Dimension"
- }
- },
- "id": "TableColumnProperties"
- },
- "NotesProperties": {
- "description": "The properties of Page that are only\nrelevant for pages with page_type NOTES.",
- "type": "object",
- "properties": {
- "speakerNotesObjectId": {
- "description": "The object ID of the shape on this notes page that contains the speaker\nnotes for the corresponding slide.\nThe actual shape may not always exist on the notes page. Inserting text\nusing this object ID will automatically create the shape. In this case, the\nactual shape may have different object ID. The `GetPresentation` or\n`GetPage` action will always return the latest object ID.",
- "type": "string"
- }
- },
- "id": "NotesProperties"
- },
- "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": {
- "objectId": {
- "type": "string",
- "description": "The object ID of the table."
- },
- "tableRange": {
- "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table.",
- "$ref": "TableRange"
- },
- "tableCellProperties": {
- "description": "The table cell properties to update.",
- "$ref": "TableCellProperties"
- },
- "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": {
- "description": "Creates a new slide.",
- "type": "object",
- "properties": {
- "slideLayoutReference": {
- "$ref": "LayoutReference",
- "description": "Layout reference of the slide to be inserted, based on the *current\nmaster*, which is one of the following:\n\n- The master of the previous slide index.\n- The master of the first slide, if the insertion_index is zero.\n- The first master in the presentation, if there are no slides.\n\nIf the LayoutReference is not found in the current master, a 400 bad\nrequest error is returned.\n\nIf you don't specify a layout reference, then the new slide will use the\npredefined layout `BLANK`."
- },
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
- "type": "string"
- },
- "insertionIndex": {
- "description": "The optional zero-based index indicating where to insert the slides.\n\nIf you don't specify an index, the new slide is created at the end.",
- "format": "int32",
- "type": "integer"
- },
- "placeholderIdMappings": {
- "description": "An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s)\nthat will be created on the new slide from that specified layout. Can only\nbe used when `slide_layout_reference` is specified.",
- "type": "array",
- "items": {
- "$ref": "LayoutPlaceholderIdMapping"
- }
- }
- },
- "id": "CreateSlideRequest"
- },
- "TableRowProperties": {
- "type": "object",
- "properties": {
- "minRowHeight": {
- "$ref": "Dimension",
- "description": "Minimum height of the row. The row will be rendered in the Slides editor at\na height equal to or greater than this value in order to show all the text\nin the row's cell(s)."
- }
- },
- "id": "TableRowProperties",
- "description": "Properties of each row in a table."
- },
- "BatchUpdatePresentationRequest": {
- "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",
- "description": "Request message for PresentationsService.BatchUpdatePresentation.",
- "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"
- },
- "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"
- },
- "TableBorderCell": {
- "description": "The properties of each border cell.",
- "type": "object",
- "properties": {
- "location": {
- "$ref": "TableCellLocation",
- "description": "The location of the border within the border table."
- },
- "tableBorderProperties": {
- "$ref": "TableBorderProperties",
- "description": "The border properties."
- }
- },
- "id": "TableBorderCell"
- },
- "TableBorderProperties": {
- "description": "The border styling properties of the\nTableBorderCell.",
- "type": "object",
- "properties": {
- "weight": {
- "$ref": "Dimension",
- "description": "The thickness of the border."
- },
- "tableBorderFill": {
- "$ref": "TableBorderFill",
- "description": "The fill of the table border."
- },
- "dashStyle": {
- "enum": [
- "DASH_STYLE_UNSPECIFIED",
- "SOLID",
- "DOT",
- "DASH",
- "DASH_DOT",
- "LONG_DASH",
- "LONG_DASH_DOT"
- ],
- "description": "The dash style of the border.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified dash style.",
- "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
- "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
- "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
- "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
- "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
- "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
- ]
- }
- },
- "id": "TableBorderProperties"
- },
- "CreateSheetsChartResponse": {
- "properties": {
- "objectId": {
- "type": "string",
- "description": "The object ID of the created chart."
- }
- },
- "id": "CreateSheetsChartResponse",
- "description": "The result of creating an embedded Google Sheets chart.",
- "type": "object"
}
}
}
diff --git a/sourcerepo/v1/sourcerepo-api.json b/sourcerepo/v1/sourcerepo-api.json
index 16012ed..93e35bd 100644
--- a/sourcerepo/v1/sourcerepo-api.json
+++ b/sourcerepo/v1/sourcerepo-api.json
@@ -1,424 +1,10 @@
{
- "basePath": "",
- "id": "sourcerepo:v1",
- "documentationLink": "https://cloud.google.com/source-repositories/docs/apis",
- "revision": "20171215",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "ListReposResponse": {
- "properties": {
- "repos": {
- "description": "The listed repos.",
- "type": "array",
- "items": {
- "$ref": "Repo"
- }
- },
- "nextPageToken": {
- "description": "If non-empty, additional repositories exist within the project. These\ncan be retrieved by including this value in the next ListReposRequest's\npage_token field.",
- "type": "string"
- }
- },
- "id": "ListReposResponse",
- "description": "Response for ListRepos. The size is not set in the returned repositories.",
- "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"
- },
- "AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "logType": {
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string"
- }
- },
- "id": "AuditLogConfig"
- },
- "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": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- },
- "exemptedMembers": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "AuditConfig"
- },
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "policy": {
- "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"
- },
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "condition": {
- "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL.",
- "$ref": "Expr"
- },
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "Expr": {
- "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
- "type": "object",
- "properties": {
- "title": {
- "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
- "type": "string"
- },
- "location": {
- "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
- "type": "string"
- },
- "description": {
- "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
- "type": "string"
- },
- "expression": {
- "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
- "type": "string"
- }
- },
- "id": "Expr"
- },
- "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"
- },
- "MirrorConfig": {
- "description": "Configuration to automatically mirror a repository from another\nhosting service, for example GitHub or Bitbucket.",
- "type": "object",
- "properties": {
- "webhookId": {
- "description": "ID of the webhook listening to updates to trigger mirroring.\nRemoving this webhook from the other hosting service will stop\nGoogle Cloud Source Repositories from receiving notifications,\nand thereby disabling mirroring.",
- "type": "string"
- },
- "deployKeyId": {
- "description": "ID of the SSH deploy key at the other hosting service.\nRemoving this key from the other service would deauthorize\nGoogle Cloud Source Repositories from mirroring.",
- "type": "string"
- },
- "url": {
- "description": "URL of the main repository at the other hosting service.",
- "type": "string"
- }
- },
- "id": "MirrorConfig"
- },
- "Repo": {
- "description": "A repository (or repo) is a Git repository storing versioned source content.",
- "type": "object",
- "properties": {
- "url": {
- "description": "URL to clone the repository from Google Cloud Source Repositories.\nRead-only field.",
- "type": "string"
- },
- "size": {
- "description": "The disk usage of the repo, in bytes. Read-only field. Size is only\nreturned by GetRepo.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Resource name of the repository, of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`. The repo name may contain slashes.\neg, `projects/myproject/repos/name/with/slash`",
- "type": "string"
- },
- "mirrorConfig": {
- "description": "How this repository mirrors a repository managed by another service.\nRead-only field.",
- "$ref": "MirrorConfig"
- }
- },
- "id": "Repo"
- }
- },
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "canonicalName": "Cloud Source Repositories",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/source.read_write": {
- "description": "Manage the contents of your source code repositories"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/source.full_control": {
- "description": "Manage your source code repositories"
- },
- "https://www.googleapis.com/auth/source.read_only": {
- "description": "View the contents of your source code repositories"
- }
- }
- }
- },
- "rootUrl": "https://sourcerepo.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "sourcerepo",
- "batchPath": "batch",
- "title": "Cloud Source Repositories API",
- "ownerName": "Google",
"resources": {
"projects": {
"resources": {
"repos": {
"methods": {
- "delete": {
- "path": "v1/{+name}",
- "id": "sourcerepo.projects.repos.delete",
- "description": "Deletes a repo.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path",
- "description": "The name of the repo to delete. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
- "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}"
- },
- "list": {
- "response": {
- "$ref": "ListReposResponse"
- },
- "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 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": {
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos",
- "path": "v1/{+name}/repos",
- "id": "sourcerepo.projects.repos.list",
- "description": "Returns all repos belonging to a project. The sizes of the repos are\nnot set by ListRepos. To get the size of a repo, use GetRepo."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Repo"
- },
- "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",
- "id": "sourcerepo.projects.repos.create",
- "path": "v1/{+parent}/repos",
- "request": {
- "$ref": "Repo"
- },
- "description": "Creates a repo in the given project with the given name.\n\nIf the named repository already exists, `CreateRepo` returns\n`ALREADY_EXISTS`."
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/repos/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/source.full_control",
- "https://www.googleapis.com/auth/source.read_only",
- "https://www.googleapis.com/auth/source.read_write"
- ],
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}: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": {
- "path": "v1/{+resource}:getIamPolicy",
- "id": "sourcerepo.projects.repos.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"response": {
"$ref": "Policy"
},
@@ -441,16 +27,26 @@
"type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:getIamPolicy"
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "sourcerepo.projects.repos.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
},
"get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
+ "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`.",
@@ -460,18 +56,17 @@
"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}",
- "id": "sourcerepo.projects.repos.get",
"path": "v1/{+name}",
- "description": "Returns information about a repo."
+ "id": "sourcerepo.projects.repos.get"
},
"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.",
"response": {
"$ref": "TestIamPermissionsResponse"
},
@@ -494,13 +89,136 @@
"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"
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}:testIamPermissions"
+ },
+ "delete": {
+ "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": {
+ "pattern": "^projects/[^/]+/repos/.+$",
+ "location": "path",
+ "description": "The name of the repo to delete. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
+ "required": true,
+ "type": "string"
+ }
},
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error."
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
+ "path": "v1/{+name}",
+ "id": "sourcerepo.projects.repos.delete",
+ "description": "Deletes a repo.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE"
+ },
+ "list": {
+ "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 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": {
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos",
+ "path": "v1/{+name}/repos",
+ "id": "sourcerepo.projects.repos.list",
+ "description": "Returns all repos belonging to a project. The sizes of the repos are\nnot set by ListRepos. To get the size of a repo, use GetRepo.",
+ "response": {
+ "$ref": "ListReposResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET"
+ },
+ "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."
+ },
+ "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": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project in which to create the repo. Values are of the form\n`projects/\u003cproject\u003e`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos",
+ "path": "v1/{+parent}/repos",
+ "id": "sourcerepo.projects.repos.create"
}
}
}
@@ -508,69 +226,30 @@
}
},
"parameters": {
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.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"
- ],
+ "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",
- "description": "Data format for response.",
- "default": "json"
+ "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.",
"type": "string"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
+ "default": "true"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
"location": "query"
},
"oauth_token": {
@@ -578,26 +257,347 @@
"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",
+ "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": {
+ "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://sourcerepo.googleapis.com/",
- "kind": "discovery#restDescription",
+ "servicePath": "",
"description": "Access source code repositories hosted by Google.",
- "servicePath": ""
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "sourcerepo:v1",
+ "documentationLink": "https://cloud.google.com/source-repositories/docs/apis",
+ "revision": "20171215",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "Policy": {
+ "id": "Policy",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
+ "properties": {
+ "version": {
+ "description": "Version of the `Policy`. The default version is 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "type": "array",
+ "items": {
+ "$ref": "AuditConfig"
+ }
+ },
+ "bindings": {
+ "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"
+ }
+ }
+ },
+ "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": {
+ "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"
+ }
+ }
+ }
+ },
+ "SetIamPolicyRequest": {
+ "id": "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."
+ }
+ }
+ },
+ "Binding": {
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ },
+ "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."
+ }
+ }
+ },
+ "Expr": {
+ "id": "Expr",
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
+ "type": "string"
+ },
+ "location": {
+ "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ },
+ "MirrorConfig": {
+ "id": "MirrorConfig",
+ "description": "Configuration to automatically mirror a repository from another\nhosting service, for example GitHub or Bitbucket.",
+ "type": "object",
+ "properties": {
+ "deployKeyId": {
+ "description": "ID of the SSH deploy key at the other hosting service.\nRemoving this key from the other service would deauthorize\nGoogle Cloud Source Repositories from mirroring.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL of the main repository at the other hosting service.",
+ "type": "string"
+ },
+ "webhookId": {
+ "description": "ID of the webhook listening to updates to trigger mirroring.\nRemoving this webhook from the other hosting service will stop\nGoogle Cloud Source Repositories from receiving notifications,\nand thereby disabling mirroring.",
+ "type": "string"
+ }
+ }
+ },
+ "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": {}
+ },
+ "Repo": {
+ "description": "A repository (or repo) is a Git repository storing versioned source content.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Resource name of the repository, of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`. The repo name may contain slashes.\neg, `projects/myproject/repos/name/with/slash`",
+ "type": "string"
+ },
+ "mirrorConfig": {
+ "$ref": "MirrorConfig",
+ "description": "How this repository mirrors a repository managed by another service.\nRead-only field."
+ },
+ "url": {
+ "description": "URL to clone the repository from Google Cloud Source Repositories.\nRead-only field.",
+ "type": "string"
+ },
+ "size": {
+ "description": "The disk usage of the repo, in bytes. Read-only field. Size is only\nreturned by GetRepo.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "Repo"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsResponse"
+ },
+ "ListReposResponse": {
+ "description": "Response for ListRepos. The size is not set in the returned repositories.",
+ "type": "object",
+ "properties": {
+ "repos": {
+ "description": "The listed repos.",
+ "type": "array",
+ "items": {
+ "$ref": "Repo"
+ }
+ },
+ "nextPageToken": {
+ "description": "If non-empty, additional repositories exist within the project. These\ncan be retrieved by including this value in the next ListReposRequest's\npage_token field.",
+ "type": "string"
+ }
+ },
+ "id": "ListReposResponse"
+ },
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "logType": {
+ "description": "The log type that this config enables.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ]
+ }
+ },
+ "id": "AuditLogConfig"
+ }
+ },
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
+ "protocol": "rest",
+ "canonicalName": "Cloud Source Repositories",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/source.read_only": {
+ "description": "View the contents of your source code repositories"
+ },
+ "https://www.googleapis.com/auth/source.read_write": {
+ "description": "Manage the contents of your source code repositories"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/source.full_control": {
+ "description": "Manage your source code repositories"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://sourcerepo.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "sourcerepo",
+ "batchPath": "batch",
+ "title": "Cloud Source Repositories API",
+ "ownerName": "Google"
}
diff --git a/spanner/v1/spanner-api.json b/spanner/v1/spanner-api.json
index 5dcad12..6be870c 100644
--- a/spanner/v1/spanner-api.json
+++ b/spanner/v1/spanner-api.json
@@ -1,148 +1,16 @@
{
- "id": "spanner:v1",
- "documentationLink": "https://cloud.google.com/spanner/",
- "revision": "20171204",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Session": {
- "properties": {
- "name": {
- "description": "The name of the session. This is always system-assigned; values provided\nwhen creating a session are ignored.",
- "type": "string"
- },
- "approximateLastUseTime": {
- "description": "Output only. The approximate timestamp when the session is last used. It is\ntypically earlier than the actual last use time.",
- "format": "google-datetime",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The labels for the session.\n\n * Label keys must be between 1 and 63 characters long and must conform to\n the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n * Label values must be between 0 and 63 characters long and must conform\n to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n * No more than 64 labels can be associated with a given session.\n\nSee https://goo.gl/xmQnxf for more information on and examples of labels.",
- "type": "object"
- },
- "createTime": {
- "description": "Output only. The timestamp when the session is created.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Session",
- "description": "A session in the Cloud Spanner API.",
- "type": "object"
- },
- "ListInstancesResponse": {
- "properties": {
- "nextPageToken": {
- "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.",
- "type": "string"
- },
- "instances": {
- "description": "The list of requested instances.",
- "type": "array",
- "items": {
- "$ref": "Instance"
- }
- }
- },
- "id": "ListInstancesResponse",
- "description": "The response for ListInstances.",
- "type": "object"
- },
- "KeyRange": {
- "properties": {
- "startClosed": {
- "description": "If the start is closed, then the range includes all rows whose\nfirst `len(start_closed)` key columns exactly match `start_closed`.",
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "startOpen": {
- "description": "If the start is open, then the range excludes rows whose first\n`len(start_open)` key columns exactly match `start_open`.",
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "endOpen": {
- "description": "If the end is open, then the range excludes rows whose first\n`len(end_open)` key columns exactly match `end_open`.",
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "endClosed": {
- "description": "If the end is closed, then the range includes all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed`.",
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- },
- "id": "KeyRange",
- "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).",
- "type": "object",
- "properties": {
- "description": {
- "description": "A string representation of the expression subtree rooted at this node.",
- "type": "string"
- },
- "subqueries": {
- "additionalProperties": {
- "format": "int32",
- "type": "integer"
- },
- "description": "A mapping of (subquery variable name) -\u003e (subquery node id) for cases\nwhere the `description` string of this node references a `SCALAR`\nsubquery contained in the expression subtree rooted at this node. The\nreferenced `SCALAR` subquery may not necessarily be a direct child of\nthis node.",
- "type": "object"
- }
- },
- "id": "ShortRepresentation"
- },
- "InstanceConfig": {
- "properties": {
- "name": {
- "description": "A unique identifier for the instance configuration. Values\nare of the form\n`projects/\u003cproject\u003e/instanceConfigs/a-z*`",
- "type": "string"
- },
- "displayName": {
- "description": "The name of this instance configuration as it appears in UIs.",
- "type": "string"
- }
- },
- "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.",
- "type": "object",
- "properties": {
- "instance": {
- "$ref": "Instance",
- "description": "Required. The instance to update, which must always include the instance\nname. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included."
- },
- "fieldMask": {
- "description": "Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated.\nThe field mask must always be specified; this prevents any future fields in\n[][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know\nabout them.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateInstanceRequest"
- },
"Empty": {
- "properties": {},
- "id": "Empty",
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
},
"TransactionOptions": {
+ "description": "# Transactions\n\n\nEach session can have at most one active transaction at a time. After the\nactive transaction is completed, the session can immediately be\nre-used for the next transaction. It is not necessary to create a\nnew session for each transaction.\n\n# Transaction Modes\n\nCloud Spanner supports two transaction modes:\n\n 1. Locking read-write. This type of transaction is the only way\n to write data into Cloud Spanner. These transactions rely on\n pessimistic locking and, if necessary, two-phase commit.\n Locking read-write transactions may abort, requiring the\n application to retry.\n\n 2. Snapshot read-only. This transaction type provides guaranteed\n consistency across several reads, but does not allow\n writes. Snapshot read-only transactions can be configured to\n read at timestamps in the past. Snapshot read-only\n transactions do not need to be committed.\n\nFor transactions that only read, snapshot read-only transactions\nprovide simpler semantics and are almost always faster. In\nparticular, read-only transactions do not take locks, so they do\nnot conflict with read-write transactions. As a consequence of not\ntaking locks, they also do not abort, so retry loops are not needed.\n\nTransactions may only read/write data in a single database. They\nmay, however, read/write data in different tables within that\ndatabase.\n\n## Locking Read-Write Transactions\n\nLocking transactions may be used to atomically read-modify-write\ndata anywhere in a database. This type of transaction is externally\nconsistent.\n\nClients should attempt to minimize the amount of time a transaction\nis active. Faster transactions commit with higher probability\nand cause less contention. Cloud Spanner attempts to keep read locks\nactive as long as the transaction continues to do reads, and the\ntransaction has not been terminated by\nCommit or\nRollback. Long periods of\ninactivity at the client may cause Cloud Spanner to release a\ntransaction's locks and abort it.\n\nReads performed within a transaction acquire locks on the data\nbeing read. Writes can only be done at commit time, after all reads\nhave been completed.\nConceptually, a read-write transaction consists of zero or more\nreads or SQL queries followed by\nCommit. At any time before\nCommit, the client can send a\nRollback request to abort the\ntransaction.\n\n### Semantics\n\nCloud Spanner can commit the transaction if all read locks it acquired\nare still valid at commit time, and it is able to acquire write\nlocks for all writes. Cloud Spanner can abort the transaction for any\nreason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees\nthat the transaction has not modified any user data in Cloud Spanner.\n\nUnless the transaction commits, Cloud Spanner makes no guarantees about\nhow long the transaction's locks were held for. It is an error to\nuse Cloud Spanner locks for any sort of mutual exclusion other than\nbetween Cloud Spanner transactions themselves.\n\n### Retrying Aborted Transactions\n\nWhen a transaction aborts, the application can choose to retry the\nwhole transaction again. To maximize the chances of successfully\ncommitting the retry, the client should execute the retry in the\nsame session as the original attempt. The original session's lock\npriority increases with each consecutive abort, meaning that each\nattempt has a slightly better chance of success than the previous.\n\nUnder some circumstances (e.g., many transactions attempting to\nmodify the same row(s)), a transaction can abort many times in a\nshort period before successfully committing. Thus, it is not a good\nidea to cap the number of retries a transaction can attempt;\ninstead, it is better to limit the total amount of wall time spent\nretrying.\n\n### Idle Transactions\n\nA transaction is considered idle if it has no outstanding reads or\nSQL queries and has not started a read or SQL query within the last 10\nseconds. Idle transactions can be aborted by Cloud Spanner so that they\ndon't hold on to locks indefinitely. In that case, the commit will\nfail with error `ABORTED`.\n\nIf this behavior is undesirable, periodically executing a simple\nSQL query in the transaction (e.g., `SELECT 1`) prevents the\ntransaction from becoming idle.\n\n## Snapshot Read-Only Transactions\n\nSnapshot read-only transactions provides a simpler method than\nlocking read-write transactions for doing several consistent\nreads. However, this type of transaction does not support writes.\n\nSnapshot transactions do not take locks. Instead, they work by\nchoosing a Cloud Spanner timestamp, then executing all reads at that\ntimestamp. Since they do not acquire locks, they do not block\nconcurrent read-write transactions.\n\nUnlike locking read-write transactions, snapshot read-only\ntransactions never abort. They can fail if the chosen read\ntimestamp is garbage collected; however, the default garbage\ncollection policy is generous enough that most applications do not\nneed to worry about this in practice.\n\nSnapshot read-only transactions do not need to call\nCommit or\nRollback (and in fact are not\npermitted to do so).\n\nTo execute a snapshot transaction, the client specifies a timestamp\nbound, which tells Cloud Spanner how to choose a read timestamp.\n\nThe types of timestamp bound are:\n\n - Strong (the default).\n - Bounded staleness.\n - Exact staleness.\n\nIf the Cloud Spanner database to be read is geographically distributed,\nstale read-only transactions can execute more quickly than strong\nor read-write transaction, because they are able to execute far\nfrom the leader replica.\n\nEach type of timestamp bound is discussed in detail below.\n\n### Strong\n\nStrong reads are guaranteed to see the effects of all transactions\nthat have committed before the start of the read. Furthermore, all\nrows yielded by a single read are consistent with each other -- if\nany part of the read observes a transaction, all parts of the read\nsee the transaction.\n\nStrong reads are not repeatable: two consecutive strong read-only\ntransactions might return inconsistent results if there are\nconcurrent writes. If consistency across reads is required, the\nreads should be executed within a transaction or at an exact read\ntimestamp.\n\nSee TransactionOptions.ReadOnly.strong.\n\n### Exact Staleness\n\nThese timestamp bounds execute reads at a user-specified\ntimestamp. Reads at a timestamp are guaranteed to see a consistent\nprefix of the global transaction history: they observe\nmodifications done by all transactions with a commit timestamp \u003c=\nthe read timestamp, and observe none of the modifications done by\ntransactions with a larger commit timestamp. They will block until\nall conflicting transactions that may be assigned commit timestamps\n\u003c= the read timestamp have finished.\n\nThe timestamp can either be expressed as an absolute Cloud Spanner commit\ntimestamp or a staleness relative to the current time.\n\nThese modes do not require a \"negotiation phase\" to pick a\ntimestamp. As a result, they execute slightly faster than the\nequivalent boundedly stale concurrency modes. On the other hand,\nboundedly stale reads usually return fresher results.\n\nSee TransactionOptions.ReadOnly.read_timestamp and\nTransactionOptions.ReadOnly.exact_staleness.\n\n### Bounded Staleness\n\nBounded staleness modes allow Cloud Spanner to pick the read timestamp,\nsubject to a user-provided staleness bound. Cloud Spanner chooses the\nnewest timestamp within the staleness bound that allows execution\nof the reads at the closest available replica without blocking.\n\nAll rows yielded are consistent with each other -- if any part of\nthe read observes a transaction, all parts of the read see the\ntransaction. Boundedly stale reads are not repeatable: two stale\nreads, even if they use the same staleness bound, can execute at\ndifferent timestamps and thus return inconsistent results.\n\nBoundedly stale reads execute in two phases: the first phase\nnegotiates a timestamp among all replicas needed to serve the\nread. In the second phase, reads are executed at the negotiated\ntimestamp.\n\nAs a result of the two phase execution, bounded staleness reads are\nusually a little slower than comparable exact staleness\nreads. However, they are typically able to return fresher\nresults, and are more likely to execute at the closest replica.\n\nBecause the timestamp negotiation requires up-front knowledge of\nwhich rows will be read, it can only be used with single-use\nread-only transactions.\n\nSee TransactionOptions.ReadOnly.max_staleness and\nTransactionOptions.ReadOnly.min_read_timestamp.\n\n### Old Read Timestamps and Garbage Collection\n\nCloud Spanner continuously garbage collects deleted and overwritten data\nin the background to reclaim storage space. This process is known\nas \"version GC\". By default, version GC reclaims versions after they\nare one hour old. Because of this, Cloud Spanner cannot perform reads\nat read timestamps more than one hour in the past. This\nrestriction also applies to in-progress reads and/or SQL queries whose\ntimestamp become too old while executing. Reads and SQL queries with\ntoo-old read timestamps fail with the error `FAILED_PRECONDITION`.",
+ "type": "object",
"properties": {
"readWrite": {
"description": "Transaction may write.\n\nAuthorization to begin a read-write transaction requires\n`spanner.databases.beginOrRollbackReadWriteTransaction` permission\non the `session` resource.",
@@ -153,11 +21,11 @@
"$ref": "ReadOnly"
}
},
- "id": "TransactionOptions",
- "description": "# Transactions\n\n\nEach session can have at most one active transaction at a time. After the\nactive transaction is completed, the session can immediately be\nre-used for the next transaction. It is not necessary to create a\nnew session for each transaction.\n\n# Transaction Modes\n\nCloud Spanner supports two transaction modes:\n\n 1. Locking read-write. This type of transaction is the only way\n to write data into Cloud Spanner. These transactions rely on\n pessimistic locking and, if necessary, two-phase commit.\n Locking read-write transactions may abort, requiring the\n application to retry.\n\n 2. Snapshot read-only. This transaction type provides guaranteed\n consistency across several reads, but does not allow\n writes. Snapshot read-only transactions can be configured to\n read at timestamps in the past. Snapshot read-only\n transactions do not need to be committed.\n\nFor transactions that only read, snapshot read-only transactions\nprovide simpler semantics and are almost always faster. In\nparticular, read-only transactions do not take locks, so they do\nnot conflict with read-write transactions. As a consequence of not\ntaking locks, they also do not abort, so retry loops are not needed.\n\nTransactions may only read/write data in a single database. They\nmay, however, read/write data in different tables within that\ndatabase.\n\n## Locking Read-Write Transactions\n\nLocking transactions may be used to atomically read-modify-write\ndata anywhere in a database. This type of transaction is externally\nconsistent.\n\nClients should attempt to minimize the amount of time a transaction\nis active. Faster transactions commit with higher probability\nand cause less contention. Cloud Spanner attempts to keep read locks\nactive as long as the transaction continues to do reads, and the\ntransaction has not been terminated by\nCommit or\nRollback. Long periods of\ninactivity at the client may cause Cloud Spanner to release a\ntransaction's locks and abort it.\n\nReads performed within a transaction acquire locks on the data\nbeing read. Writes can only be done at commit time, after all reads\nhave been completed.\nConceptually, a read-write transaction consists of zero or more\nreads or SQL queries followed by\nCommit. At any time before\nCommit, the client can send a\nRollback request to abort the\ntransaction.\n\n### Semantics\n\nCloud Spanner can commit the transaction if all read locks it acquired\nare still valid at commit time, and it is able to acquire write\nlocks for all writes. Cloud Spanner can abort the transaction for any\nreason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees\nthat the transaction has not modified any user data in Cloud Spanner.\n\nUnless the transaction commits, Cloud Spanner makes no guarantees about\nhow long the transaction's locks were held for. It is an error to\nuse Cloud Spanner locks for any sort of mutual exclusion other than\nbetween Cloud Spanner transactions themselves.\n\n### Retrying Aborted Transactions\n\nWhen a transaction aborts, the application can choose to retry the\nwhole transaction again. To maximize the chances of successfully\ncommitting the retry, the client should execute the retry in the\nsame session as the original attempt. The original session's lock\npriority increases with each consecutive abort, meaning that each\nattempt has a slightly better chance of success than the previous.\n\nUnder some circumstances (e.g., many transactions attempting to\nmodify the same row(s)), a transaction can abort many times in a\nshort period before successfully committing. Thus, it is not a good\nidea to cap the number of retries a transaction can attempt;\ninstead, it is better to limit the total amount of wall time spent\nretrying.\n\n### Idle Transactions\n\nA transaction is considered idle if it has no outstanding reads or\nSQL queries and has not started a read or SQL query within the last 10\nseconds. Idle transactions can be aborted by Cloud Spanner so that they\ndon't hold on to locks indefinitely. In that case, the commit will\nfail with error `ABORTED`.\n\nIf this behavior is undesirable, periodically executing a simple\nSQL query in the transaction (e.g., `SELECT 1`) prevents the\ntransaction from becoming idle.\n\n## Snapshot Read-Only Transactions\n\nSnapshot read-only transactions provides a simpler method than\nlocking read-write transactions for doing several consistent\nreads. However, this type of transaction does not support writes.\n\nSnapshot transactions do not take locks. Instead, they work by\nchoosing a Cloud Spanner timestamp, then executing all reads at that\ntimestamp. Since they do not acquire locks, they do not block\nconcurrent read-write transactions.\n\nUnlike locking read-write transactions, snapshot read-only\ntransactions never abort. They can fail if the chosen read\ntimestamp is garbage collected; however, the default garbage\ncollection policy is generous enough that most applications do not\nneed to worry about this in practice.\n\nSnapshot read-only transactions do not need to call\nCommit or\nRollback (and in fact are not\npermitted to do so).\n\nTo execute a snapshot transaction, the client specifies a timestamp\nbound, which tells Cloud Spanner how to choose a read timestamp.\n\nThe types of timestamp bound are:\n\n - Strong (the default).\n - Bounded staleness.\n - Exact staleness.\n\nIf the Cloud Spanner database to be read is geographically distributed,\nstale read-only transactions can execute more quickly than strong\nor read-write transaction, because they are able to execute far\nfrom the leader replica.\n\nEach type of timestamp bound is discussed in detail below.\n\n### Strong\n\nStrong reads are guaranteed to see the effects of all transactions\nthat have committed before the start of the read. Furthermore, all\nrows yielded by a single read are consistent with each other -- if\nany part of the read observes a transaction, all parts of the read\nsee the transaction.\n\nStrong reads are not repeatable: two consecutive strong read-only\ntransactions might return inconsistent results if there are\nconcurrent writes. If consistency across reads is required, the\nreads should be executed within a transaction or at an exact read\ntimestamp.\n\nSee TransactionOptions.ReadOnly.strong.\n\n### Exact Staleness\n\nThese timestamp bounds execute reads at a user-specified\ntimestamp. Reads at a timestamp are guaranteed to see a consistent\nprefix of the global transaction history: they observe\nmodifications done by all transactions with a commit timestamp \u003c=\nthe read timestamp, and observe none of the modifications done by\ntransactions with a larger commit timestamp. They will block until\nall conflicting transactions that may be assigned commit timestamps\n\u003c= the read timestamp have finished.\n\nThe timestamp can either be expressed as an absolute Cloud Spanner commit\ntimestamp or a staleness relative to the current time.\n\nThese modes do not require a \"negotiation phase\" to pick a\ntimestamp. As a result, they execute slightly faster than the\nequivalent boundedly stale concurrency modes. On the other hand,\nboundedly stale reads usually return fresher results.\n\nSee TransactionOptions.ReadOnly.read_timestamp and\nTransactionOptions.ReadOnly.exact_staleness.\n\n### Bounded Staleness\n\nBounded staleness modes allow Cloud Spanner to pick the read timestamp,\nsubject to a user-provided staleness bound. Cloud Spanner chooses the\nnewest timestamp within the staleness bound that allows execution\nof the reads at the closest available replica without blocking.\n\nAll rows yielded are consistent with each other -- if any part of\nthe read observes a transaction, all parts of the read see the\ntransaction. Boundedly stale reads are not repeatable: two stale\nreads, even if they use the same staleness bound, can execute at\ndifferent timestamps and thus return inconsistent results.\n\nBoundedly stale reads execute in two phases: the first phase\nnegotiates a timestamp among all replicas needed to serve the\nread. In the second phase, reads are executed at the negotiated\ntimestamp.\n\nAs a result of the two phase execution, bounded staleness reads are\nusually a little slower than comparable exact staleness\nreads. However, they are typically able to return fresher\nresults, and are more likely to execute at the closest replica.\n\nBecause the timestamp negotiation requires up-front knowledge of\nwhich rows will be read, it can only be used with single-use\nread-only transactions.\n\nSee TransactionOptions.ReadOnly.max_staleness and\nTransactionOptions.ReadOnly.min_read_timestamp.\n\n### Old Read Timestamps and Garbage Collection\n\nCloud Spanner continuously garbage collects deleted and overwritten data\nin the background to reclaim storage space. This process is known\nas \"version GC\". By default, version GC reclaims versions after they\nare one hour old. Because of this, Cloud Spanner cannot perform reads\nat read timestamps more than one hour in the past. This\nrestriction also applies to in-progress reads and/or SQL queries whose\ntimestamp become too old while executing. Reads and SQL queries with\ntoo-old read timestamps fail with the error `FAILED_PRECONDITION`.",
- "type": "object"
+ "id": "TransactionOptions"
},
"CreateDatabaseRequest": {
+ "description": "The request for CreateDatabase.",
+ "type": "object",
"properties": {
"createStatement": {
"description": "Required. A `CREATE DATABASE` statement, which specifies the ID of the\nnew database. The database ID must conform to the regular expression\n`a-z*[a-z0-9]` and be between 2 and 30 characters in length.\nIf the database ID is a reserved word or if it contains a hyphen, the\ndatabase ID must be enclosed in backticks (`` ` ``).",
@@ -171,9 +39,7 @@
}
}
},
- "id": "CreateDatabaseRequest",
- "description": "The request for CreateDatabase.",
- "type": "object"
+ "id": "CreateDatabaseRequest"
},
"CreateInstanceRequest": {
"description": "The request for CreateInstance.",
@@ -184,14 +50,25 @@
"type": "string"
},
"instance": {
- "$ref": "Instance",
- "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `\u003cparent\u003e/instances/\u003cinstance_id\u003e`."
+ "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `\u003cparent\u003e/instances/\u003cinstance_id\u003e`.",
+ "$ref": "Instance"
}
},
"id": "CreateInstanceRequest"
},
"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",
@@ -210,23 +87,28 @@
"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": {
+ "queryMode": {
+ "description": "Used to control the amount of debugging information returned in\nResultSetStats.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default mode where only the query result, without any information\nabout the query plan is returned.",
+ "This mode returns only the query plan, without any result rows or\nexecution statistics information.",
+ "This mode returns both the query plan and the execution statistics along\nwith the result rows."
+ ],
+ "enum": [
+ "NORMAL",
+ "PLAN",
+ "PROFILE"
+ ]
+ },
"transaction": {
"description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency.",
"$ref": "TransactionSelector"
@@ -237,11 +119,11 @@
"type": "string"
},
"paramTypes": {
+ "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BYTES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn these cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more information\nabout SQL types.",
+ "type": "object",
"additionalProperties": {
"$ref": "Type"
- },
- "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BYTES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn these cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more information\nabout SQL types.",
- "type": "object"
+ }
},
"sql": {
"description": "Required. The SQL query string.",
@@ -254,27 +136,13 @@
},
"description": "The SQL query string can contain parameter placeholders. A parameter\nplaceholder consists of `'@'` followed by the parameter\nname. Parameter names consist of any combination of letters,\nnumbers, and underscores.\n\nParameters can appear anywhere that a literal value is expected. The same\nparameter name can be used more than once, for example:\n `\"WHERE id \u003e @msg_id AND id \u003c @msg_id + 100\"`\n\nIt is an error to execute an SQL query with unbound parameters.\n\nParameter values are specified using `params`, which is a JSON\nobject whose keys are parameter names, and whose values are the\ncorresponding parameter values.",
"type": "object"
- },
- "queryMode": {
- "enumDescriptions": [
- "The default mode where only the query result, without any information\nabout the query plan is returned.",
- "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"
}
},
- "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.",
@@ -294,11 +162,11 @@
}
}
},
- "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": {
+ "description": "The request for Read and\nStreamingRead.",
+ "type": "object",
"properties": {
"limit": {
"description": "If greater than zero, only the first `limit` rows are yielded. If `limit`\nis zero, the default is no limit.",
@@ -321,8 +189,8 @@
}
},
"transaction": {
- "$ref": "TransactionSelector",
- "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
+ "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency.",
+ "$ref": "TransactionSelector"
},
"resumeToken": {
"description": "If this request is resuming a previously interrupted read,\n`resume_token` should be copied from the last\nPartialResultSet yielded before the interruption. Doing this\nenables the new read to resume where the last read left off. The\nrest of the request parameters must exactly match the request\nthat yielded this token.",
@@ -334,9 +202,7 @@
"type": "string"
}
},
- "id": "ReadRequest",
- "description": "The request for Read and\nStreamingRead.",
- "type": "object"
+ "id": "ReadRequest"
},
"Write": {
"description": "Arguments to insert, update, insert_or_update, and\nreplace operations.",
@@ -376,77 +242,83 @@
"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": {
+ "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": {
- "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"
},
"CreateSessionRequest": {
+ "description": "The request for CreateSession.",
+ "type": "object",
"properties": {
"session": {
- "$ref": "Session",
- "description": "The session to create."
+ "description": "The session to create.",
+ "$ref": "Session"
}
},
- "id": "CreateSessionRequest",
- "description": "The request for CreateSession.",
- "type": "object"
+ "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",
"items": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "type": "object"
+ }
}
},
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
"id": "Status"
},
"ResultSet": {
+ "description": "Results from Read or\nExecuteSql.",
+ "type": "object",
"properties": {
+ "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",
@@ -458,17 +330,11 @@
}
},
"metadata": {
- "$ref": "ResultSetMetadata",
- "description": "Metadata about the result set, such as row type information."
- },
- "stats": {
- "$ref": "ResultSetStats",
- "description": "Query plan and execution statistics for the query that produced this\nresult set. These can be requested by setting\nExecuteSqlRequest.query_mode."
+ "description": "Metadata about the result set, such as row type information.",
+ "$ref": "ResultSetMetadata"
}
},
- "id": "ResultSet",
- "description": "Results from Read or\nExecuteSql.",
- "type": "object"
+ "id": "ResultSet"
},
"Binding": {
"description": "Associates `members` with a `role`.",
@@ -489,6 +355,8 @@
"id": "Binding"
},
"UpdateDatabaseDdlRequest": {
+ "description": "Enqueues the given DDL statements to be applied, in order but not\nnecessarily all at once, to the database schema at some point (or\npoints) in the future. The server checks that the statements\nare executable (syntactically valid, name tables that exist, etc.)\nbefore enqueueing them, but they may still fail upon\nlater execution (e.g., if a statement from another batch of\nstatements is applied first and it conflicts in some way, or if\nthere is some data-related problem like a `NULL` value in a column to\nwhich `NOT NULL` would be added). If a statement fails, all\nsubsequent statements in the batch are automatically cancelled.\n\nEach batch of statements is assigned a name which can be used with\nthe Operations API to monitor\nprogress. See the\noperation_id field for more\ndetails.",
+ "type": "object",
"properties": {
"statements": {
"description": "DDL statements to be applied to the database.",
@@ -502,21 +370,12 @@
"type": "string"
}
},
- "id": "UpdateDatabaseDdlRequest",
- "description": "Enqueues the given DDL statements to be applied, in order but not\nnecessarily all at once, to the database schema at some point (or\npoints) in the future. The server checks that the statements\nare executable (syntactically valid, name tables that exist, etc.)\nbefore enqueueing them, but they may still fail upon\nlater execution (e.g., if a statement from another batch of\nstatements is applied first and it conflicts in some way, or if\nthere is some data-related problem like a `NULL` value in a column to\nwhich `NOT NULL` would be added). If a statement fails, all\nsubsequent statements in the batch are automatically cancelled.\n\nEach batch of statements is assigned a name which can be used with\nthe Operations API to monitor\nprogress. See the\noperation_id field for more\ndetails.",
- "type": "object"
+ "id": "UpdateDatabaseDdlRequest"
},
"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": {
- "resumeToken": {
- "description": "Streaming calls might be interrupted for a variety of reasons, such\nas TCP connection loss. If this occurs, the stream of results can\nbe resumed by re-sending the original request and including\n`resume_token`. Note that executing any other transaction in the\nsame session invalidates the token.",
- "format": "byte",
- "type": "string"
- },
- "stats": {
- "description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by setting\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response in the stream.",
- "$ref": "ResultSetStats"
- },
"chunkedValue": {
"description": "If true, then the final value in values is chunked, and must\nbe combined with more values from subsequent `PartialResultSet`s\nto obtain a complete field value.",
"type": "boolean"
@@ -531,23 +390,23 @@
"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": {
- "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",
+ "resumeToken": {
+ "description": "Streaming calls might be interrupted for a variety of reasons, such\nas TCP connection loss. If this occurs, the stream of results can\nbe resumed by re-sending the original request and including\n`resume_token`. Note that executing any other transaction in the\nsame session invalidates the token.",
+ "format": "byte",
"type": "string"
},
+ "stats": {
+ "description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by setting\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response in the stream.",
+ "$ref": "ResultSetStats"
+ }
+ },
+ "id": "PartialResultSet"
+ },
+ "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",
@@ -557,26 +416,33 @@
"description": "The time at which this operation failed or was completed successfully.",
"format": "google-datetime",
"type": "string"
+ },
+ "instance": {
+ "$ref": "Instance",
+ "description": "The desired end state of the update."
+ },
+ "startTime": {
+ "description": "The time at which UpdateInstance\nrequest was received.",
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "UpdateInstanceMetadata",
- "description": "Metadata type for the operation returned by\nUpdateInstance.",
- "type": "object"
+ "id": "UpdateInstanceMetadata"
},
"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"
@@ -585,26 +451,28 @@
"description": "Metadata about a ResultSet or PartialResultSet.",
"type": "object",
"properties": {
- "rowType": {
- "$ref": "StructType",
- "description": "Indicates the field names and types for the rows in the result\nset. For example, a SQL query like `\"SELECT UserId, UserName FROM\nUsers\"` could return a `row_type` value like:\n\n \"fields\": [\n { \"name\": \"UserId\", \"type\": { \"code\": \"INT64\" } },\n { \"name\": \"UserName\", \"type\": { \"code\": \"STRING\" } },\n ]"
- },
"transaction": {
"$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 ]"
}
},
"id": "ResultSetMetadata"
},
"TransactionSelector": {
+ "description": "This message is used to select the transaction in which a\nRead or\nExecuteSql call runs.\n\nSee TransactionOptions for more information about transactions.",
+ "type": "object",
"properties": {
"singleUse": {
"$ref": "TransactionOptions",
"description": "Execute the read or SQL query in a temporary transaction.\nThis is the most efficient way to execute a transaction that\nconsists of a single SQL query."
},
"begin": {
- "description": "Begin a new transaction and execute this read or SQL query in\nit. The transaction ID of the new transaction is returned in\nResultSetMetadata.transaction, which is a Transaction.",
- "$ref": "TransactionOptions"
+ "$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.",
@@ -612,14 +480,20 @@
"type": "string"
}
},
- "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": {
+ "insert": {
+ "$ref": "Write",
+ "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`."
+ },
+ "insertOrUpdate": {
+ "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncolumn values not explicitly written are preserved.",
+ "$ref": "Write"
+ },
"update": {
"description": "Update existing rows in a table. If any of the rows does not\nalready exist, the transaction fails with error `NOT_FOUND`.",
"$ref": "Write"
@@ -631,19 +505,13 @@
"delete": {
"$ref": "Delete",
"description": "Delete rows from a table. Succeeds whether or not the named\nrows were present."
- },
- "insert": {
- "$ref": "Write",
- "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`."
- },
- "insertOrUpdate": {
- "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncolumn values not explicitly written are preserved.",
- "$ref": "Write"
}
},
"id": "Mutation"
},
"KeySet": {
+ "description": "`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All\nthe keys are expected to be in the same table or index. The keys need\nnot be sorted in any particular way.\n\nIf the same key is specified multiple times in the set (for example\nif two ranges, two keys, or a key and a range overlap), Cloud Spanner\nbehaves as if the key were only specified once.",
+ "type": "object",
"properties": {
"ranges": {
"description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.",
@@ -667,9 +535,7 @@
"type": "boolean"
}
},
- "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.",
@@ -711,15 +577,15 @@
"id": "Database"
},
"SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
"properties": {
"policy": {
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
"$ref": "Policy"
}
},
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object"
+ "id": "SetIamPolicyRequest"
},
"ListDatabasesResponse": {
"description": "The response for ListDatabases.",
@@ -740,6 +606,8 @@
"id": "ListDatabasesResponse"
},
"Instance": {
+ "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",
+ "type": "object",
"properties": {
"displayName": {
"description": "Required. The descriptive name for this instance as it appears in UIs.\nMust be unique per project and between 4 and 30 characters in length.",
@@ -762,17 +630,17 @@
"type": "string"
},
"state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "CREATING",
- "READY"
- ],
"description": "Output only. The current instance state. For\nCreateInstance, the state must be\neither omitted or set to `CREATING`. For\nUpdateInstance, the state must be\neither omitted or set to `READY`.",
"type": "string",
"enumDescriptions": [
"Not specified.",
"The instance is still being created. Resources may not be\navailable yet, and operations such as database creation may not\nwork.",
"The instance is fully created and ready to do work such as\ncreating databases."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "CREATING",
+ "READY"
]
},
"name": {
@@ -780,9 +648,7 @@
"type": "string"
}
},
- "id": "Instance",
- "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",
- "type": "object"
+ "id": "Instance"
},
"RollbackRequest": {
"description": "The request for Rollback.",
@@ -797,6 +663,8 @@
"id": "RollbackRequest"
},
"Transaction": {
+ "description": "A transaction.",
+ "type": "object",
"properties": {
"readTimestamp": {
"description": "For snapshot read-only transactions, the read timestamp chosen\nfor the transaction. Not returned by default: see\nTransactionOptions.ReadOnly.return_read_timestamp.\n\nA timestamp in RFC3339 UTC \\\"Zulu\\\" format, accurate to nanoseconds.\nExample: `\"2014-10-02T15:01:23.045123456Z\"`.",
@@ -809,12 +677,20 @@
"type": "string"
}
},
- "id": "Transaction",
- "description": "A transaction.",
- "type": "object"
+ "id": "Transaction"
},
"UpdateDatabaseDdlMetadata": {
+ "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",
+ "type": "object",
"properties": {
+ "commitTimestamps": {
+ "description": "Reports the commit timestamps of all statements that have\nsucceeded so far, where `commit_timestamps[i]` is the commit\ntimestamp for the statement `statements[i]`.",
+ "type": "array",
+ "items": {
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
"database": {
"description": "The database being modified.",
"type": "string"
@@ -825,21 +701,13 @@
"items": {
"type": "string"
}
- },
- "commitTimestamps": {
- "description": "Reports the commit timestamps of all statements that have\nsucceeded so far, where `commit_timestamps[i]` is the commit\ntimestamp for the statement `statements[i]`.",
- "type": "array",
- "items": {
- "format": "google-datetime",
- "type": "string"
- }
}
},
- "id": "UpdateDatabaseDdlMetadata",
- "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",
- "type": "object"
+ "id": "UpdateDatabaseDdlMetadata"
},
"QueryPlan": {
+ "description": "Contains an ordered list of nodes appearing in the query plan.",
+ "type": "object",
"properties": {
"planNodes": {
"description": "The nodes in the query plan. Plan nodes are returned in pre-order starting\nwith the plan root. Each PlanNode's `id` corresponds to its index in\n`plan_nodes`.",
@@ -849,9 +717,7 @@
}
}
},
- "id": "QueryPlan",
- "description": "Contains an ordered list of nodes appearing in the query plan.",
- "type": "object"
+ "id": "QueryPlan"
},
"StructType": {
"description": "`StructType` defines the fields of a STRUCT type.",
@@ -876,8 +742,8 @@
"type": "string"
},
"type": {
- "$ref": "Type",
- "description": "The type of the field."
+ "description": "The type of the field.",
+ "$ref": "Type"
}
},
"id": "Field"
@@ -900,6 +766,10 @@
"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.",
@@ -907,10 +777,6 @@
},
"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": {
- "description": "QueryPlan for the query associated with this result.",
- "$ref": "QueryPlan"
}
},
"id": "ResultSetStats"
@@ -928,6 +794,8 @@
"id": "CommitResponse"
},
"Type": {
+ "description": "`Type` indicates the type of a Cloud Spanner value, as might be stored in a\ntable cell or returned from an SQL query.",
+ "type": "object",
"properties": {
"structType": {
"description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields.",
@@ -938,6 +806,18 @@
"$ref": "Type"
},
"code": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Encoded as JSON `true` or `false`.",
+ "Encoded as `string`, in decimal format.",
+ "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or\n`\"-Infinity\"`.",
+ "Encoded as `string` in RFC 3339 timestamp format. The time zone\nmust be present, and must be `\"Z\"`.",
+ "Encoded as `string` in RFC 3339 date format.",
+ "Encoded as `string`.",
+ "Encoded as a base64-encoded `string`, as described in RFC 4648,\nsection 4.",
+ "Encoded as `list`, where the list elements are represented\naccording to array_element_type.",
+ "Encoded as `list`, where list element `i` is represented according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]."
+ ],
"enum": [
"TYPE_CODE_UNSPECIFIED",
"BOOL",
@@ -951,36 +831,30 @@
"STRUCT"
],
"description": "Required. The TypeCode for this type.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Encoded as JSON `true` or `false`.",
- "Encoded as `string`, in decimal format.",
- "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or\n`\"-Infinity\"`.",
- "Encoded as `string` in RFC 3339 timestamp format. The time zone\nmust be present, and must be `\"Z\"`.",
- "Encoded as `string` in RFC 3339 date format.",
- "Encoded as `string`.",
- "Encoded as a base64-encoded `string`, as described in RFC 4648,\nsection 4.",
- "Encoded as `list`, where the list elements are represented\naccording to array_element_type.",
- "Encoded as `list`, where list element `i` is represented according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]."
- ]
+ "type": "string"
}
},
- "id": "Type",
- "description": "`Type` indicates the type of a Cloud Spanner value, as might be stored in a\ntable cell or returned from an SQL query.",
- "type": "object"
+ "id": "Type"
},
"PlanNode": {
"description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",
"type": "object",
"properties": {
- "executionStats": {
+ "metadata": {
+ "description": "Attributes relevant to the node contained in a group of key-value pairs.\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n\n {\n \"parameter_reference\": \"param1\",\n \"parameter_type\": \"array\"\n }",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- },
+ }
+ },
+ "executionStats": {
"description": "The execution statistics associated with the node, contained in a group of\nkey-value pairs. Only present if the plan was returned as a result of a\nprofile query. For example, number of executions, number of rows/time per\nexecution etc.",
- "type": "object"
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
},
"shortRepresentation": {
"$ref": "ShortRepresentation",
@@ -996,18 +870,18 @@
"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"
},
"childLinks": {
"description": "List of child node `index`es and their relationship to this parent.",
@@ -1015,14 +889,6 @@
"items": {
"$ref": "ChildLink"
}
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Attributes relevant to the node contained in a group of key-value pairs.\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n\n {\n \"parameter_reference\": \"param1\",\n \"parameter_type\": \"array\"\n }",
- "type": "object"
}
},
"id": "PlanNode"
@@ -1054,6 +920,8 @@
"id": "CreateInstanceMetadata"
},
"ChildLink": {
+ "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
+ "type": "object",
"properties": {
"type": {
"description": "The type of the link. For example, in Hash Joins this could be used to\ndistinguish between the build child and the probe child, or in the case\nof the child being an output variable, to represent the tag associated\nwith the output variable.",
@@ -1069,30 +937,30 @@
"type": "string"
}
},
- "id": "ChildLink",
- "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
- "type": "object"
+ "id": "ChildLink"
},
"Delete": {
+ "description": "Arguments to delete operations.",
+ "type": "object",
"properties": {
- "keySet": {
- "description": "Required. The primary keys of the rows within table to delete.",
- "$ref": "KeySet"
- },
"table": {
"description": "Required. The table whose rows will be deleted.",
"type": "string"
+ },
+ "keySet": {
+ "description": "Required. The primary keys of the rows within table to delete.",
+ "$ref": "KeySet"
}
},
- "id": "Delete",
- "description": "Arguments to delete operations.",
- "type": "object"
+ "id": "Delete"
},
"CommitRequest": {
+ "description": "The request for Commit.",
+ "type": "object",
"properties": {
"singleUseTransaction": {
- "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead.",
- "$ref": "TransactionOptions"
+ "$ref": "TransactionOptions",
+ "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead."
},
"mutations": {
"description": "The mutations to be executed when this transaction commits. All\nmutations are applied atomically, in the order they appear in\nthis list.",
@@ -1107,22 +975,22 @@
"type": "string"
}
},
- "id": "CommitRequest",
- "description": "The request for Commit.",
- "type": "object"
+ "id": "CommitRequest"
},
"BeginTransactionRequest": {
+ "description": "The request for BeginTransaction.",
+ "type": "object",
"properties": {
"options": {
"$ref": "TransactionOptions",
"description": "Required. Options for the new transaction."
}
},
- "id": "BeginTransactionRequest",
- "description": "The request for BeginTransaction.",
- "type": "object"
+ "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.",
@@ -1136,17 +1004,17 @@
}
}
},
- "id": "ListInstanceConfigsResponse",
- "description": "The response for ListInstanceConfigs.",
- "type": "object"
+ "id": "ListInstanceConfigsResponse"
},
"GetIamPolicyRequest": {
- "properties": {},
- "id": "GetIamPolicyRequest",
"description": "Request message for `GetIamPolicy` method.",
- "type": "object"
+ "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.",
@@ -1156,9 +1024,7 @@
}
}
},
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
+ "id": "TestIamPermissionsResponse"
},
"CreateDatabaseMetadata": {
"description": "Metadata type for the operation returned by\nCreateDatabase.",
@@ -1175,24 +1041,155 @@
"description": "The response for ListSessions.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "`next_page_token` can be sent in a subsequent\nListSessions call to fetch more of the matching\nsessions.",
- "type": "string"
- },
"sessions": {
"description": "The list of requested sessions.",
"type": "array",
"items": {
"$ref": "Session"
}
+ },
+ "nextPageToken": {
+ "description": "`next_page_token` can be sent in a subsequent\nListSessions call to fetch more of the matching\nsessions.",
+ "type": "string"
}
},
"id": "ListSessionsResponse"
+ },
+ "Session": {
+ "description": "A session in the Cloud Spanner API.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "The labels for the session.\n\n * Label keys must be between 1 and 63 characters long and must conform to\n the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n * Label values must be between 0 and 63 characters long and must conform\n to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n * No more than 64 labels can be associated with a given session.\n\nSee https://goo.gl/xmQnxf for more information on and examples of labels.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "createTime": {
+ "description": "Output only. The timestamp when the session is created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the session. This is always system-assigned; values provided\nwhen creating a session are ignored.",
+ "type": "string"
+ },
+ "approximateLastUseTime": {
+ "description": "Output only. The approximate timestamp when the session is last used. It is\ntypically earlier than the actual last use time.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Session"
+ },
+ "KeyRange": {
+ "description": "KeyRange represents a range of rows in a table or index.\n\nA range has a start key and an end key. These keys can be open or\nclosed, indicating if the range includes rows with that key.\n\nKeys are represented by lists, where the ith value in the list\ncorresponds to the ith component of the table or index primary key.\nIndividual values are encoded as described here.\n\nFor example, consider the following table definition:\n\n CREATE TABLE UserEvents (\n UserName STRING(MAX),\n EventDate STRING(10)\n ) PRIMARY KEY(UserName, EventDate);\n\nThe following keys name rows in this table:\n\n \"Bob\", \"2014-09-23\"\n\nSince the `UserEvents` table's `PRIMARY KEY` clause names two\ncolumns, each `UserEvents` key has two elements; the first is the\n`UserName`, and the second is the `EventDate`.\n\nKey ranges with multiple components are interpreted\nlexicographically by component using the table or index key's declared\nsort order. For example, the following range returns all events for\nuser `\"Bob\"` that occurred in the year 2015:\n\n \"start_closed\": [\"Bob\", \"2015-01-01\"]\n \"end_closed\": [\"Bob\", \"2015-12-31\"]\n\nStart and end keys can omit trailing key components. This affects the\ninclusion and exclusion of rows that exactly match the provided key\ncomponents: if the key is closed, then rows that exactly match the\nprovided components are included; if the key is open, then rows\nthat exactly match are not included.\n\nFor example, the following range includes all events for `\"Bob\"` that\noccurred during and after the year 2000:\n\n \"start_closed\": [\"Bob\", \"2000-01-01\"]\n \"end_closed\": [\"Bob\"]\n\nThe next example retrieves all events for `\"Bob\"`:\n\n \"start_closed\": [\"Bob\"]\n \"end_closed\": [\"Bob\"]\n\nTo retrieve events before the year 2000:\n\n \"start_closed\": [\"Bob\"]\n \"end_open\": [\"Bob\", \"2000-01-01\"]\n\nThe following range includes all rows in the table:\n\n \"start_closed\": []\n \"end_closed\": []\n\nThis range returns all users whose `UserName` begins with any\ncharacter from A to C:\n\n \"start_closed\": [\"A\"]\n \"end_open\": [\"D\"]\n\nThis range returns all users whose `UserName` begins with B:\n\n \"start_closed\": [\"B\"]\n \"end_open\": [\"C\"]\n\nKey ranges honor column sort order. For example, suppose a table is\ndefined as follows:\n\n CREATE TABLE DescendingSortedTable {\n Key INT64,\n ...\n ) PRIMARY KEY(Key DESC);\n\nThe following range retrieves all rows with key values between 1\nand 100 inclusive:\n\n \"start_closed\": [\"100\"]\n \"end_closed\": [\"1\"]\n\nNote that 100 is passed as the start, and 1 is passed as the end,\nbecause `Key` is a descending column in the schema.",
+ "type": "object",
+ "properties": {
+ "endOpen": {
+ "description": "If the end is open, then the range excludes rows whose first\n`len(end_open)` key columns exactly match `end_open`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "endClosed": {
+ "description": "If the end is closed, then the range includes all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "startClosed": {
+ "description": "If the start is closed, then the range includes all rows whose\nfirst `len(start_closed)` key columns exactly match `start_closed`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "startOpen": {
+ "description": "If the start is open, then the range excludes rows whose first\n`len(start_open)` key columns exactly match `start_open`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ },
+ "id": "KeyRange"
+ },
+ "ListInstancesResponse": {
+ "description": "The response for ListInstances.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.",
+ "type": "string"
+ },
+ "instances": {
+ "description": "The list of requested instances.",
+ "type": "array",
+ "items": {
+ "$ref": "Instance"
+ }
+ }
+ },
+ "id": "ListInstancesResponse"
+ },
+ "ShortRepresentation": {
+ "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A string representation of the expression subtree rooted at this node.",
+ "type": "string"
+ },
+ "subqueries": {
+ "additionalProperties": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "description": "A mapping of (subquery variable name) -\u003e (subquery node id) for cases\nwhere the `description` string of this node references a `SCALAR`\nsubquery contained in the expression subtree rooted at this node. The\nreferenced `SCALAR` subquery may not necessarily be a direct child of\nthis node.",
+ "type": "object"
+ }
+ },
+ "id": "ShortRepresentation"
+ },
+ "InstanceConfig": {
+ "description": "A possible configuration for a Cloud Spanner instance. Configurations\ndefine the geographic placement of nodes and their replication.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A unique identifier for the instance configuration. Values\nare of the form\n`projects/\u003cproject\u003e/instanceConfigs/a-z*`",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The name of this instance configuration as it appears in UIs.",
+ "type": "string"
+ }
+ },
+ "id": "InstanceConfig"
+ },
+ "UpdateInstanceRequest": {
+ "description": "The request for UpdateInstance.",
+ "type": "object",
+ "properties": {
+ "instance": {
+ "$ref": "Instance",
+ "description": "Required. The instance to update, which must always include the instance\nname. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included."
+ },
+ "fieldMask": {
+ "description": "Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated.\nThe field mask must always be specified; this prevents any future fields in\n[][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know\nabout them.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateInstanceRequest"
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"canonicalName": "Spanner",
@@ -1223,6 +1220,10 @@
"instanceConfigs": {
"methods": {
"list": {
+ "flatPath": "v1/projects/{projectsId}/instanceConfigs",
+ "path": "v1/{+parent}/instanceConfigs",
+ "id": "spanner.projects.instanceConfigs.list",
+ "description": "Lists the supported instance configurations for a given project.",
"response": {
"$ref": "ListInstanceConfigsResponse"
},
@@ -1230,10 +1231,6 @@
"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.",
@@ -1247,17 +1244,17 @@
"location": "query"
},
"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"
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
}
},
- "flatPath": "v1/projects/{projectsId}/instanceConfigs",
- "path": "v1/{+parent}/instanceConfigs",
- "id": "spanner.projects.instanceConfigs.list",
- "description": "Lists the supported instance configurations for a given project."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ]
},
"get": {
"response": {
@@ -1269,11 +1266,11 @@
"httpMethod": "GET",
"parameters": {
"name": {
+ "location": "path",
"description": "Required. The name of the requested instance configuration. Values are of\nthe form `projects/\u003cproject\u003e/instanceConfigs/\u003cconfig\u003e`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$"
}
},
"scopes": [
@@ -1288,8 +1285,511 @@
}
},
"instances": {
+ "methods": {
+ "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": {
+ "location": "path",
+ "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "spanner.projects.instances.testIamPermissions"
+ },
+ "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",
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the instance to be deleted. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.delete"
+ },
+ "list": {
+ "description": "Lists all instances in the given project.",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Number of instances to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/\u003cproject\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "filter": {
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * `name`\n * `display_name`\n * `labels.key` where key is the name of a label\n\nSome examples of using filters are:\n\n * `name:*` --\u003e The instance has a name.\n * `name:Howl` --\u003e The instance's name contains the string \"howl\".\n * `name:HOWL` --\u003e Equivalent to above.\n * `NAME:howl` --\u003e Equivalent to above.\n * `labels.env:*` --\u003e The instance has the label \"env\".\n * `labels.env:dev` --\u003e The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * `name:howl labels.env:dev` --\u003e The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n containing \"dev\".",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances",
+ "path": "v1/{+parent}/instances",
+ "id": "spanner.projects.instances.list"
+ },
+ "create": {
+ "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",
+ "path": "v1/{+parent}/instances",
+ "id": "spanner.projects.instances.create"
+ },
+ "setIamPolicy": {
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "spanner.projects.instances.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource.",
+ "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"
+ ]
+ },
+ "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": {
+ "location": "path",
+ "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "spanner.projects.instances.getIamPolicy",
+ "description": "Gets the access control policy for an instance resource. Returns an empty\npolicy if an instance exists but does not have a policy set.\n\nAuthorization requires `spanner.instances.getIamPolicy` on\nresource.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ }
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Instance"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The name of the requested instance. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "id": "spanner.projects.instances.get",
+ "path": "v1/{+name}",
+ "description": "Gets information about a particular instance."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "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."
+ }
+ },
"resources": {
"databases": {
+ "methods": {
+ "getIamPolicy": {
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for a database resource. Returns an empty\npolicy if a database exists but does not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPolicy` permission on\nresource.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy",
+ "id": "spanner.projects.instances.databases.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy"
+ },
+ "get": {
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.get",
+ "description": "Gets the state of a Cloud Spanner database.",
+ "response": {
+ "$ref": "Database"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The name of the requested database. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$"
+ }
+ }
+ },
+ "dropDatabase": {
+ "description": "Drops (aka deletes) a Cloud Spanner database.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "database": {
+ "description": "Required. The database to be dropped.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
+ "path": "v1/{+database}",
+ "id": "spanner.projects.instances.databases.dropDatabase"
+ },
+ "updateDdl": {
+ "request": {
+ "$ref": "UpdateDatabaseDdlRequest"
+ },
+ "description": "Updates the schema of a Cloud Spanner database by\ncreating/altering/dropping tables, columns, indexes, etc. The returned\nlong-running operation will have a name of\nthe format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and can be used to\ntrack execution of the schema change(s). The\nmetadata field type is\nUpdateDatabaseDdlMetadata. The operation has no response.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "database": {
+ "location": "path",
+ "description": "Required. The database to update.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl",
+ "path": "v1/{+database}/ddl",
+ "id": "spanner.projects.instances.databases.updateDdl"
+ },
+ "testIamPermissions": {
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "spanner.projects.instances.databases.testIamPermissions",
+ "description": "Returns permissions that the caller has on the specified database resource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will result in\na NOT_FOUND error if the user has `spanner.databases.list` permission on\nthe containing Cloud Spanner instance. Otherwise returns an empty set of\npermissions.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$"
+ }
+ }
+ },
+ "getDdl": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "database"
+ ],
+ "response": {
+ "$ref": "GetDatabaseDdlResponse"
+ },
+ "parameters": {
+ "database": {
+ "description": "Required. The database whose schema we wish to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl",
+ "id": "spanner.projects.instances.databases.getDdl",
+ "path": "v1/{+database}/ddl",
+ "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": {
+ "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"
+ },
+ "parent": {
+ "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",
+ "pattern": "^projects/[^/]+/instances/[^/]+$"
+ }
+ },
+ "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": {
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "spanner.projects.instances.databases.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource.",
+ "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/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ]
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the instance that will serve the new database.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases",
+ "id": "spanner.projects.instances.databases.create",
+ "path": "v1/{+parent}/databases",
+ "request": {
+ "$ref": "CreateDatabaseRequest"
+ },
+ "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operation will\nhave a name of the format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track preparation of the database. The\nmetadata field type is\nCreateDatabaseMetadata. The\nresponse field type is\nDatabase, if successful."
+ }
+ },
"resources": {
"operations": {
"methods": {
@@ -1301,19 +1801,19 @@
"response": {
"$ref": "Empty"
},
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$"
+ }
+ },
"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",
"id": "spanner.projects.instances.databases.operations.cancel",
"path": "v1/{+name}:cancel",
@@ -1329,11 +1829,11 @@
"httpMethod": "DELETE",
"parameters": {
"name": {
+ "location": "path",
"description": "The name of the operation resource to be deleted.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$"
}
},
"scopes": [
@@ -1346,20 +1846,26 @@
"description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
},
"list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
"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/[^/]+/instances/[^/]+/databases/[^/]+/operations$",
- "location": "path"
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations$"
},
"pageToken": {
"location": "query",
@@ -1367,15 +1873,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": [
@@ -1383,154 +1884,44 @@
"https://www.googleapis.com/auth/spanner.admin"
],
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations",
- "path": "v1/{+name}",
"id": "spanner.projects.instances.databases.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
+ "path": "v1/{+name}"
},
"get": {
- "id": "spanner.projects.instances.databases.operations.get",
- "path": "v1/{+name}",
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
],
"parameters": {
"name": {
+ "location": "path",
"description": "The name of the operation resource.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.operations.get"
}
}
},
"sessions": {
"methods": {
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
- "response": {
- "$ref": "CommitResponse"
- },
- "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"
- }
- },
- "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"
- },
- "beginTransaction": {
- "response": {
- "$ref": "Transaction"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the transaction runs.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction",
- "path": "v1/{+session}:beginTransaction",
- "id": "spanner.projects.instances.databases.sessions.beginTransaction",
- "request": {
- "$ref": "BeginTransactionRequest"
- },
- "description": "Begins a new transaction. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect."
- },
- "executeStreamingSql": {
- "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",
- "id": "spanner.projects.instances.databases.sessions.executeStreamingSql",
- "path": "v1/{+session}:executeStreamingSql",
+ "executeSql": {
"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."
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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}",
- "id": "spanner.projects.instances.databases.sessions.delete",
- "path": "v1/{+name}",
- "description": "Ends a session, releasing server resources associated with it."
- },
- "executeSql": {
+ "description": "Executes an SQL query, returning all rows in a single reply. This\nmethod cannot be used to return a result set larger than 10 MiB;\nif the query yields more data than that, the query fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead.",
"httpMethod": "POST",
"parameterOrder": [
"session"
@@ -1538,31 +1929,24 @@
"response": {
"$ref": "ResultSet"
},
+ "parameters": {
+ "session": {
+ "description": "Required. The session in which the SQL query should be performed.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.data"
],
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the SQL query should be performed.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql",
"id": "spanner.projects.instances.databases.sessions.executeSql",
- "path": "v1/{+session}:executeSql",
- "description": "Executes an SQL query, returning all rows in a single reply. This\nmethod cannot be used to return a result set larger than 10 MiB;\nif the query yields more data than that, the query fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead.",
- "request": {
- "$ref": "ExecuteSqlRequest"
- }
+ "path": "v1/{+session}:executeSql"
},
"list": {
- "path": "v1/{+database}/sessions",
- "id": "spanner.projects.instances.databases.sessions.list",
- "description": "Lists all sessions in a given database.",
"response": {
"$ref": "ListSessionsResponse"
},
@@ -1571,12 +1955,18 @@
],
"httpMethod": "GET",
"parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Number of sessions to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
+ "format": "int32",
+ "type": "integer"
+ },
"database": {
+ "location": "path",
"description": "Required. The database in which to list sessions.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$"
},
"filter": {
"description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * `labels.key` where key is the name of a label\n\nSome examples of using filters are:\n\n * `labels.env:*` --\u003e The session has the label \"env\".\n * `labels.env:dev` --\u003e The session has the label \"env\" and the value of\n the label contains the string \"dev\".",
@@ -1587,32 +1977,29 @@
"description": "If non-empty, `page_token` should contain a\nnext_page_token from a previous\nListSessionsResponse.",
"type": "string",
"location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Number of sessions to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
- "format": "int32",
- "type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.data"
],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions"
+ "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."
},
"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"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
"response": {
"$ref": "PartialResultSet"
},
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.data"
@@ -1627,25 +2014,21 @@
}
},
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead",
- "id": "spanner.projects.instances.databases.sessions.streamingRead",
- "path": "v1/{+session}:streamingRead"
+ "path": "v1/{+session}:streamingRead",
+ "id": "spanner.projects.instances.databases.sessions.streamingRead"
},
"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"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
+ "description": "Rolls back a transaction, releasing any locks it holds. It is a good\nidea to call this for any transaction that includes one or more\nRead or ExecuteSql requests and\nultimately decides not to commit.\n\n`Rollback` returns `OK` if it successfully aborts the transaction, the\ntransaction was already aborted, or the transaction is not\nfound. `Rollback` never returns `ABORTED`.",
"response": {
"$ref": "Empty"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
+ "parameterOrder": [
+ "session"
],
+ "httpMethod": "POST",
"parameters": {
"session": {
"description": "Required. The session in which the transaction to roll back is running.",
@@ -1655,11 +2038,16 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback",
- "id": "spanner.projects.instances.databases.sessions.rollback",
- "path": "v1/{+session}:rollback"
+ "path": "v1/{+session}:rollback",
+ "id": "spanner.projects.instances.databases.sessions.rollback"
},
"create": {
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions",
"path": "v1/{+database}/sessions",
"id": "spanner.projects.instances.databases.sessions.create",
"request": {
@@ -1685,17 +2073,20 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions"
+ ]
},
"read": {
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
+ "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.",
"response": {
"$ref": "ResultSet"
},
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
"parameters": {
"session": {
"description": "Required. The session in which the read should be performed.",
@@ -1710,303 +2101,150 @@
"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."
+ "id": "spanner.projects.instances.databases.sessions.read"
},
"get": {
- "description": "Gets a session. Returns `NOT_FOUND` if the session does not exist.\nThis is mainly useful for determining whether a session is still\nalive.",
- "response": {
- "$ref": "Session"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Session"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The name of the session to retrieve.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
+ "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."
+ },
+ "commit": {
+ "request": {
+ "$ref": "CommitRequest"
+ },
+ "description": "Commits a transaction. The request includes the mutations to be\napplied to rows in the database.\n\n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly, the cause is conflicts with concurrent\ntransactions. However, it can also happen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller should re-attempt\nthe transaction from the beginning, re-using the same session.",
+ "response": {
+ "$ref": "CommitResponse"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "session": {
+ "location": "path",
+ "description": "Required. The session in which the transaction to be committed is running.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit",
+ "path": "v1/{+session}:commit",
+ "id": "spanner.projects.instances.databases.sessions.commit"
+ },
+ "beginTransaction": {
+ "description": "Begins a new transaction. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect.",
+ "request": {
+ "$ref": "BeginTransactionRequest"
+ },
+ "response": {
+ "$ref": "Transaction"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.data"
],
"parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "session": {
"location": "path",
- "description": "Required. The name of the session to retrieve.",
+ "description": "Required. The session in which the transaction runs.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
}
},
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction",
+ "path": "v1/{+session}:beginTransaction",
+ "id": "spanner.projects.instances.databases.sessions.beginTransaction"
+ },
+ "executeStreamingSql": {
+ "request": {
+ "$ref": "ExecuteSqlRequest"
+ },
+ "description": "Like ExecuteSql, except returns the result\nset as a stream. Unlike ExecuteSql, there\nis no limit on the size of the returned result set. However, no\nindividual row in the result set can exceed 100 MiB, and no\ncolumn value can exceed 10 MiB.",
+ "response": {
+ "$ref": "PartialResultSet"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "session": {
+ "location": "path",
+ "description": "Required. The session in which the SQL query should be performed.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql",
+ "path": "v1/{+session}:executeStreamingSql",
+ "id": "spanner.projects.instances.databases.sessions.executeStreamingSql"
+ },
+ "delete": {
+ "description": "Ends a session, releasing server resources associated with it.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the session to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
"path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.sessions.get"
+ "id": "spanner.projects.instances.databases.sessions.delete"
}
}
}
- },
- "methods": {
- "getIamPolicy": {
- "id": "spanner.projects.instances.databases.getIamPolicy",
- "path": "v1/{+resource}: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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "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 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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy"
- },
- "get": {
- "id": "spanner.projects.instances.databases.get",
- "path": "v1/{+name}",
- "description": "Gets the state of a Cloud Spanner database.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Database"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the requested database. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}"
- },
- "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": {
- "description": "Required. The database to be dropped.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "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": {
- "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",
- "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": {
- "path": "v1/{+resource}:testIamPermissions",
- "id": "spanner.projects.instances.databases.testIamPermissions",
- "description": "Returns permissions that the caller has on the specified database resource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will result in\na NOT_FOUND error if the user has `spanner.databases.list` permission on\nthe containing Cloud Spanner instance. Otherwise returns an empty set of\npermissions.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "resource": {
- "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"
- },
- "getDdl": {
- "id": "spanner.projects.instances.databases.getDdl",
- "path": "v1/{+database}/ddl",
- "description": "Returns the schema of a Cloud Spanner database as a list of formatted\nDDL statements. This method does not show pending schema updates, those may\nbe queried using the Operations API.",
- "httpMethod": "GET",
- "parameterOrder": [
- "database"
- ],
- "response": {
- "$ref": "GetDatabaseDdlResponse"
- },
- "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"
- },
- "list": {
- "response": {
- "$ref": "ListDatabasesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases",
- "path": "v1/{+parent}/databases",
- "id": "spanner.projects.instances.databases.list",
- "description": "Lists Cloud Spanner databases."
- },
- "setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "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",
- "id": "spanner.projects.instances.databases.setIamPolicy",
- "path": "v1/{+resource}: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": {
- "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"
- }
- }
}
},
"operations": {
@@ -2020,19 +2258,19 @@
"name"
],
"httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$"
+ }
+ },
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel",
"path": "v1/{+name}:cancel",
"id": "spanner.projects.instances.operations.cancel"
@@ -2051,11 +2289,11 @@
],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
"location": "path",
"description": "The name of the operation resource to be deleted.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
@@ -2064,8 +2302,6 @@
"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.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"
@@ -2079,35 +2315,35 @@
"https://www.googleapis.com/auth/spanner.admin"
],
"parameters": {
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
"filter": {
- "location": "query",
"description": "The standard list filter.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"name": {
+ "location": "path",
"description": "The name of the operation's parent resource.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/operations$",
- "location": "path"
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations$"
},
"pageToken": {
"description": "The standard list page token.",
"type": "string",
"location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.operations.list"
},
"get": {
- "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.",
"response": {
"$ref": "Operation"
@@ -2116,264 +2352,25 @@
"name"
],
"httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
],
- "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}"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.operations.get"
}
}
}
- },
- "methods": {
- "delete": {
- "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}",
- "id": "spanner.projects.instances.delete",
- "path": "v1/{+name}",
- "description": "Deletes an instance.\n\nImmediately upon completion of the request:\n\n * Billing ceases for all of the instance's reserved resources.\n\nSoon afterward:\n\n * The instance and *all of its databases* immediately and\n irrevocably disappear from the API. All data in the databases\n is permanently deleted."
- },
- "list": {
- "description": "Lists all instances in the given project.",
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/\u003cproject\u003e`.",
- "required": true,
- "type": "string"
- },
- "filter": {
- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * `name`\n * `display_name`\n * `labels.key` where key is the name of a label\n\nSome examples of using filters are:\n\n * `name:*` --\u003e The instance has a name.\n * `name:Howl` --\u003e The instance's name contains the string \"howl\".\n * `name:HOWL` --\u003e Equivalent to above.\n * `NAME:howl` --\u003e Equivalent to above.\n * `labels.env:*` --\u003e The instance has the label \"env\".\n * `labels.env:dev` --\u003e The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * `name:howl labels.env:dev` --\u003e The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n containing \"dev\".",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances",
- "path": "v1/{+parent}/instances",
- "id": "spanner.projects.instances.list"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for databases resources.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "spanner.projects.instances.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "parent": {
- "description": "Required. The name of the project in which to create the instance. Values\nare of the form `projects/\u003cproject\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances",
- "id": "spanner.projects.instances.create",
- "path": "v1/{+parent}/instances",
- "request": {
- "$ref": "CreateInstanceRequest"
- },
- "description": "Creates an instance and begins preparing it to begin serving. The\nreturned long-running operation\ncan be used to track the progress of preparing the new\ninstance. The instance name is assigned by the caller. If the\nnamed instance already exists, `CreateInstance` returns\n`ALREADY_EXISTS`.\n\nImmediately upon completion of this request:\n\n * The instance is readable via the API, with all requested attributes\n but no allocated resources. Its state is `CREATING`.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation renders the instance immediately unreadable\n via the API.\n * The instance can be deleted.\n * All other attempts to modify the instance are rejected.\n\nUpon completion of the returned operation:\n\n * Billing for all successfully-allocated resources begins (some types\n may have lower than the requested levels).\n * Databases can be created in the instance.\n * The instance's allocated resource levels are readable via the API.\n * The instance's state becomes `READY`.\n\nThe returned long-running operation will\nhave a name of the format `\u003cinstance_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track creation of the instance. The\nmetadata field type is\nCreateInstanceMetadata.\nThe response field type is\nInstance, if successful."
- },
- "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": {
- "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.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path"
- }
- },
- "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}"
- },
- "get": {
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.get",
- "description": "Gets information about a particular instance.",
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the requested instance. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}"
- },
- "testIamPermissions": {
- "id": "spanner.projects.instances.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user has `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions"
- }
}
}
}
@@ -2381,43 +2378,43 @@
},
"parameters": {
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "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"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
},
"alt": {
"description": "Data format for response.",
@@ -2451,26 +2448,29 @@
"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": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
}
},
"version": "v1",
"baseUrl": "https://spanner.googleapis.com/",
- "servicePath": "",
- "description": "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.",
"kind": "discovery#restDescription",
- "basePath": ""
+ "description": "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "spanner:v1",
+ "documentationLink": "https://cloud.google.com/spanner/",
+ "revision": "20171204"
}
diff --git a/speech/v1/speech-api.json b/speech/v1/speech-api.json
index 2568ca8..8b2fbc5 100644
--- a/speech/v1/speech-api.json
+++ b/speech/v1/speech-api.json
@@ -11,10 +11,29 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "SpeechRecognitionResult": {
+ "description": "A speech recognition result corresponding to a portion of the audio.",
+ "type": "object",
+ "properties": {
+ "alternatives": {
+ "description": "*Output-only* May contain one or more recognition hypotheses (up to the\nmaximum specified in `max_alternatives`).\nThese alternatives are ordered in terms of accuracy, with the top (first)\nalternative being the most probable, as ranked by the recognizer.",
+ "type": "array",
+ "items": {
+ "$ref": "SpeechRecognitionAlternative"
+ }
+ }
+ },
+ "id": "SpeechRecognitionResult"
+ },
"RecognitionConfig": {
"description": "Provides information to the recognizer that specifies how to process the\nrequest.",
"type": "object",
"properties": {
+ "sampleRateHertz": {
+ "description": "*Required* Sample rate in Hertz of the audio data sent in all\n`RecognitionAudio` messages. Valid values are: 8000-48000.\n16000 is optimal. For best results, set the sampling rate of the audio\nsource to 16000 Hz. If that's not possible, use the native sample rate of\nthe audio source (instead of re-sampling).",
+ "format": "int32",
+ "type": "integer"
+ },
"enableWordTimeOffsets": {
"description": "*Optional* If `true`, the top result includes a list of words and\nthe start and end time offsets (timestamps) for those words. If\n`false`, no word-level time offset information is returned. The default is\n`false`.",
"type": "boolean"
@@ -40,8 +59,6 @@
}
},
"encoding": {
- "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
- "type": "string",
"enumDescriptions": [
"Not specified.",
"Uncompressed 16-bit signed little-endian samples (Linear PCM).",
@@ -61,16 +78,13 @@
"AMR_WB",
"OGG_OPUS",
"SPEEX_WITH_HEADER_BYTE"
- ]
+ ],
+ "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
+ "type": "string"
},
"enableWordConfidence": {
"description": "*Optional* If `true`, the top result includes a list of words and the\nconfidence for those words. If `false`, no word-level confidence\ninformation is returned. The default is `false`.",
"type": "boolean"
- },
- "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"
@@ -79,11 +93,6 @@
"description": "Word-specific information for recognized words.",
"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",
@@ -92,11 +101,18 @@
"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"
},
"RecognitionAudio": {
+ "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).",
+ "type": "object",
"properties": {
"uri": {
"description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
@@ -108,23 +124,12 @@
"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"
+ "id": "RecognitionAudio"
},
"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",
@@ -135,6 +140,15 @@
"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"
@@ -148,8 +162,8 @@
"description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request."
},
"audio": {
- "$ref": "RecognitionAudio",
- "description": "*Required* The audio data to be recognized."
+ "description": "*Required* The audio data to be recognized.",
+ "$ref": "RecognitionAudio"
}
},
"id": "LongRunningRecognizeRequest"
@@ -177,8 +191,8 @@
"$ref": "RecognitionConfig"
},
"audio": {
- "$ref": "RecognitionAudio",
- "description": "*Required* The audio data to be recognized."
+ "description": "*Required* The audio data to be recognized.",
+ "$ref": "RecognitionAudio"
}
},
"id": "RecognizeRequest"
@@ -201,6 +215,18 @@
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
@@ -216,18 +242,6 @@
"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"
@@ -254,20 +268,6 @@
}
},
"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`).\nThese alternatives are ordered in terms of accuracy, with the top (first)\nalternative being the most probable, as ranked by the recognizer.",
- "type": "array",
- "items": {
- "$ref": "SpeechRecognitionAlternative"
- }
- }
- },
- "id": "SpeechRecognitionResult"
}
},
"icons": {
@@ -348,11 +348,11 @@
],
"parameters": {
"name": {
+ "pattern": "^[^/]+$",
"location": "path",
"description": "The name of the operation resource.",
"required": true,
- "type": "string",
- "pattern": "^[^/]+$"
+ "type": "string"
}
},
"flatPath": "v1/operations/{operationsId}",
@@ -363,6 +363,22 @@
}
},
"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": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -375,27 +391,27 @@
"default": "true"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
},
"callback": {
"description": "JSONP",
@@ -403,6 +419,8 @@
"location": "query"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -414,40 +432,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"
+ "location": "query"
},
"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.",
- "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"
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
}
}
}
diff --git a/speech/v1beta1/speech-api.json b/speech/v1beta1/speech-api.json
index 6b62469..55699c6 100644
--- a/speech/v1beta1/speech-api.json
+++ b/speech/v1beta1/speech-api.json
@@ -1,94 +1,11 @@
{
+ "basePath": "",
+ "revision": "20180123",
+ "documentationLink": "https://cloud.google.com/speech/",
+ "id": "speech:v1beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "SyncRecognizeRequest": {
- "description": "The top-level message sent by the client for the `SyncRecognize` 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": "SyncRecognizeRequest"
- },
- "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"
- },
- "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"
- },
- "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"
- },
"SpeechRecognitionAlternative": {
"description": "Alternative hypotheses (a.k.a. n-best list).",
"type": "object",
@@ -110,8 +27,8 @@
"type": "object",
"properties": {
"error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
},
"metadata": {
"additionalProperties": {
@@ -126,12 +43,12 @@
"type": "boolean"
},
"response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
@@ -169,8 +86,6 @@
"id": "SpeechRecognitionResult"
},
"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.",
@@ -191,10 +106,12 @@
"type": "boolean"
},
"speechContext": {
- "description": "*Optional* A means to provide context to assist the speech recognition.",
- "$ref": "SpeechContext"
+ "$ref": "SpeechContext",
+ "description": "*Optional* A means to provide context to assist the speech recognition."
},
"encoding": {
+ "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
+ "type": "string",
"enumDescriptions": [
"Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.",
"Uncompressed 16-bit signed little-endian samples (Linear PCM).\nThis is the only encoding that may be used by `AsyncRecognize`.",
@@ -210,12 +127,99 @@
"MULAW",
"AMR",
"AMR_WB"
- ],
- "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
+ ]
+ }
+ },
+ "id": "RecognitionConfig",
+ "description": "Provides information to the recognizer that specifies how to process the\nrequest.",
+ "type": "object"
+ },
+ "SyncRecognizeRequest": {
+ "properties": {
+ "config": {
+ "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.",
+ "$ref": "RecognitionConfig"
+ },
+ "audio": {
+ "$ref": "RecognitionAudio",
+ "description": "*Required* The audio data to be recognized."
+ }
+ },
+ "id": "SyncRecognizeRequest",
+ "description": "The top-level message sent by the client for the `SyncRecognize` method.",
+ "type": "object"
+ },
+ "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": "RecognitionConfig"
+ "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"
+ },
+ "AsyncRecognizeRequest": {
+ "properties": {
+ "config": {
+ "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.",
+ "$ref": "RecognitionConfig"
+ },
+ "audio": {
+ "$ref": "RecognitionAudio",
+ "description": "*Required* The audio data to be recognized."
+ }
+ },
+ "id": "AsyncRecognizeRequest",
+ "description": "The top-level message sent by the client for the `AsyncRecognize` 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": {
+ "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"
+ },
+ "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"
}
},
"icons": {
@@ -240,52 +244,9 @@
"title": "Google Cloud Speech API",
"ownerName": "Google",
"resources": {
- "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": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/speech:asyncrecognize",
- "id": "speech.speech.asyncrecognize",
- "path": "v1beta1/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."
- }
- }
- },
"operations": {
"methods": {
"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"
},
@@ -305,17 +266,115 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/operations/{operationsId}"
+ "flatPath": "v1beta1/operations/{operationsId}",
+ "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."
+ }
+ }
+ },
+ "speech": {
+ "methods": {
+ "asyncrecognize": {
+ "request": {
+ "$ref": "AsyncRecognizeRequest"
+ },
+ "description": "Performs asynchronous speech recognition: receive results via the\n[google.longrunning.Operations]\n(/speech/reference/rest/v1beta1/operations#Operation)\ninterface. Returns either an\n`Operation.error` or an `Operation.response` which contains\nan `AsyncRecognizeResponse` message.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
- "access_token": {
- "description": "OAuth access 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": {
+ "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"
+ ]
+ },
+ "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.",
@@ -333,78 +392,19 @@
"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"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "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://speech.googleapis.com/",
"description": "Converts audio to text by applying powerful neural network models.",
"kind": "discovery#restDescription",
- "servicePath": "",
- "basePath": "",
- "revision": "20180123",
- "documentationLink": "https://cloud.google.com/speech/",
- "id": "speech:v1beta1"
+ "servicePath": ""
}
diff --git a/storagetransfer/v1/storagetransfer-api.json b/storagetransfer/v1/storagetransfer-api.json
index a8ac502..47182c2 100644
--- a/storagetransfer/v1/storagetransfer-api.json
+++ b/storagetransfer/v1/storagetransfer-api.json
@@ -1,16 +1,59 @@
{
+ "version": "v1",
+ "baseUrl": "https://storagetransfer.googleapis.com/",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.",
+ "servicePath": "",
+ "rootUrl": "https://storagetransfer.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "storagetransfer",
"batchPath": "batch",
"revision": "20180118",
- "id": "storagetransfer:v1",
"documentationLink": "https://cloud.google.com/storage/transfer",
+ "id": "storagetransfer:v1",
"title": "Google Storage Transfer API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": true,
"resources": {
+ "googleServiceAccounts": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "GoogleServiceAccount"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1/googleServiceAccounts/{projectId}",
+ "path": "v1/googleServiceAccounts/{projectId}",
+ "id": "storagetransfer.googleServiceAccounts.get",
+ "description": "Returns the Google service account that is used by Storage Transfer\nService to access buckets in the project where transfers\nrun or in other projects. Each Google service account is associated\nwith one Google Cloud Platform Console project. Users\nshould add this service account to the Google Cloud Storage bucket\nACLs to grant access to Storage Transfer Service. This service\naccount is created and owned by Storage Transfer Service and can\nonly be used by Storage Transfer Service."
+ }
+ }
+ },
"transferJobs": {
"methods": {
"patch": {
@@ -26,11 +69,11 @@
],
"parameters": {
"jobName": {
+ "pattern": "^transferJobs/.+$",
"location": "path",
"description": "The name of job to update.\nRequired.",
"required": true,
- "type": "string",
- "pattern": "^transferJobs/.+$"
+ "type": "string"
}
},
"flatPath": "v1/transferJobs/{transferJobsId}",
@@ -42,13 +85,14 @@
}
},
"get": {
- "response": {
- "$ref": "TransferJob"
- },
+ "description": "Gets a transfer job.",
+ "httpMethod": "GET",
"parameterOrder": [
"jobName"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "TransferJob"
+ },
"parameters": {
"jobName": {
"description": "The job to get.\nRequired.",
@@ -58,25 +102,27 @@
"location": "path"
},
"projectId": {
+ "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
"type": "string",
- "location": "query",
- "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired."
+ "location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/transferJobs/{transferJobsId}",
- "path": "v1/{+jobName}",
"id": "storagetransfer.transferJobs.get",
- "description": "Gets a transfer job."
+ "path": "v1/{+jobName}"
},
"list": {
- "httpMethod": "GET",
"response": {
"$ref": "ListTransferJobsResponse"
},
"parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"filter": {
"location": "query",
@@ -84,9 +130,9 @@
"type": "string"
},
"pageToken": {
+ "location": "query",
"description": "The list page token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -95,122 +141,44 @@
"type": "integer"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/transferJobs",
- "id": "storagetransfer.transferJobs.list",
"path": "v1/transferJobs",
+ "id": "storagetransfer.transferJobs.list",
"description": "Lists transfer jobs."
},
"create": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/transferJobs",
- "path": "v1/transferJobs",
- "id": "storagetransfer.transferJobs.create",
- "description": "Creates a transfer job that runs periodically.",
- "request": {
- "$ref": "TransferJob"
- },
"response": {
"$ref": "TransferJob"
},
"parameterOrder": [],
- "httpMethod": "POST"
+ "httpMethod": "POST",
+ "parameters": {},
+ "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."
}
}
},
"transferOperations": {
"methods": {
- "resume": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^transferOperations/.+$",
- "location": "path",
- "description": "The name of the transfer operation.\nRequired.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/transferOperations/{transferOperationsId}:resume",
- "id": "storagetransfer.transferOperations.resume",
- "path": "v1/{+name}:resume",
- "description": "Resumes a transfer operation that is paused.",
- "request": {
- "$ref": "ResumeTransferOperationRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- }
- },
- "cancel": {
- "description": "Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
- "httpMethod": "POST",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^transferOperations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/transferOperations/{transferOperationsId}:cancel",
- "id": "storagetransfer.transferOperations.cancel",
- "path": "v1/{+name}:cancel"
- },
- "get": {
- "flatPath": "v1/transferOperations/{transferOperationsId}",
- "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"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^transferOperations/.+$",
- "location": "path"
- }
- }
- },
"pause": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"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.",
@@ -220,19 +188,15 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/transferOperations/{transferOperationsId}:pause",
- "id": "storagetransfer.transferOperations.pause",
"path": "v1/{+name}:pause",
+ "id": "storagetransfer.transferOperations.pause",
+ "description": "Pauses a transfer operation.",
"request": {
"$ref": "PauseTransferOperationRequest"
- },
- "description": "Pauses a transfer operation."
+ }
},
"delete": {
- "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
"response": {
"$ref": "Empty"
},
@@ -240,21 +204,22 @@
"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": "^transferOperations/.+$"
+ "pattern": "^transferOperations/.+$",
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/transferOperations/{transferOperationsId}",
"path": "v1/{+name}",
- "id": "storagetransfer.transferOperations.delete"
+ "id": "storagetransfer.transferOperations.delete",
+ "description": "This method is not supported and the server returns `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.",
@@ -277,129 +242,150 @@
"location": "path"
},
"pageToken": {
- "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",
+ "type": "string",
"location": "query"
},
- "filter": {
+ "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"
+ "type": "string",
+ "location": "query"
}
},
"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.",
- "httpMethod": "GET",
- "response": {
- "$ref": "GoogleServiceAccount"
- },
+ },
+ "resume": {
+ "httpMethod": "POST",
"parameterOrder": [
- "projectId"
+ "name"
],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
- "projectId": {
- "location": "path",
- "description": "The ID of the Google Cloud Platform Console project that the Google service\naccount is associated with.\nRequired.",
+ "name": {
+ "description": "The name of the transfer operation.\nRequired.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^transferOperations/.+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/googleServiceAccounts/{projectId}",
- "id": "storagetransfer.googleServiceAccounts.get",
- "path": "v1/googleServiceAccounts/{projectId}"
+ "flatPath": "v1/transferOperations/{transferOperationsId}:resume",
+ "id": "storagetransfer.transferOperations.resume",
+ "path": "v1/{+name}:resume",
+ "request": {
+ "$ref": "ResumeTransferOperationRequest"
+ },
+ "description": "Resumes a transfer operation that is paused."
+ },
+ "cancel": {
+ "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",
+ "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": "^transferOperations/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/transferOperations/{transferOperationsId}:cancel"
+ },
+ "get": {
+ "path": "v1/{+name}",
+ "id": "storagetransfer.transferOperations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^transferOperations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/transferOperations/{transferOperationsId}"
}
}
}
},
"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"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -411,127 +397,43 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
"location": "query",
- "description": "Data format for response.",
- "default": "json"
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
}
},
"schemas": {
- "AwsAccessKey": {
- "description": "AWS access key (see\n[AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).",
- "type": "object",
- "properties": {
- "secretAccessKey": {
- "description": "AWS secret access key. This field is not returned in RPC responses.\nRequired.",
- "type": "string"
- },
- "accessKeyId": {
- "description": "AWS access key ID.\nRequired.",
- "type": "string"
- }
- },
- "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": {
- "id": "PauseTransferOperationRequest",
- "description": "Request passed to PauseTransferOperation.",
- "type": "object",
- "properties": {}
- },
- "TransferCounters": {
- "description": "A collection of counters that report the progress of a transfer operation.",
- "type": "object",
- "properties": {
- "bytesDeletedFromSource": {
- "description": "Bytes that are deleted from the data source.",
- "format": "int64",
- "type": "string"
- },
- "objectsFoundFromSource": {
- "description": "Objects found in the data source that are scheduled to be transferred,\nexcluding any that are filtered based on object conditions or skipped due\nto sync.",
- "format": "int64",
- "type": "string"
- },
- "objectsFailedToDeleteFromSink": {
- "description": "Objects that failed to be deleted from the data sink.",
- "format": "int64",
- "type": "string"
- },
- "objectsDeletedFromSink": {
- "description": "Objects that are deleted from the data sink.",
- "format": "int64",
- "type": "string"
- },
- "objectsFoundOnlyFromSink": {
- "description": "Objects found only in the data sink that are scheduled to be deleted.",
- "format": "int64",
- "type": "string"
- },
- "bytesFromSourceSkippedBySync": {
- "description": "Bytes in the data source that are not transferred because they already\nexist in the data sink.",
- "format": "int64",
- "type": "string"
- },
- "bytesFailedToDeleteFromSink": {
- "description": "Bytes that failed to be deleted from the data sink.",
- "format": "int64",
- "type": "string"
- },
- "bytesDeletedFromSink": {
- "description": "Bytes that are deleted from the data sink.",
- "format": "int64",
- "type": "string"
- },
- "bytesFromSourceFailed": {
- "description": "Bytes in the data source that failed to be transferred or that failed to\nbe deleted after being transferred.",
- "format": "int64",
- "type": "string"
- },
- "objectsFromSourceFailed": {
- "type": "string",
- "description": "Objects in the data source that failed to be transferred or that failed\nto be deleted after being transferred.",
- "format": "int64"
- },
- "objectsCopiedToSink": {
- "description": "Objects that are copied to the data sink.",
- "format": "int64",
- "type": "string"
- },
- "bytesFoundOnlyFromSink": {
- "type": "string",
- "description": "Bytes found only in the data sink that are scheduled to be deleted.",
- "format": "int64"
- },
- "objectsDeletedFromSource": {
- "description": "Objects that are deleted from the data source.",
- "format": "int64",
- "type": "string"
- },
- "bytesCopiedToSink": {
- "description": "Bytes that are copied to the data sink.",
- "format": "int64",
- "type": "string"
- },
- "bytesFoundFromSource": {
- "description": "Bytes found in the data source that are scheduled to be transferred,\nexcluding any that are filtered based on object conditions or skipped due\nto sync.",
- "format": "int64",
- "type": "string"
- },
- "objectsFromSourceSkippedBySync": {
- "description": "Objects in the data source that are not transferred because they already\nexist in the data sink.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "TransferCounters"
- },
"ErrorSummary": {
+ "description": "A summary of errors by error code, plus a count and sample error log\nentries.",
"type": "object",
"properties": {
"errorCode": {
@@ -589,11 +491,9 @@
}
}
},
- "id": "ErrorSummary",
- "description": "A summary of errors by error code, plus a count and sample error log\nentries."
+ "id": "ErrorSummary"
},
"HttpData": {
- "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.",
@@ -601,7 +501,8 @@
}
},
"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."
+ "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.",
@@ -615,9 +516,6 @@
"id": "GcsData"
},
"ListTransferJobsResponse": {
- "id": "ListTransferJobsResponse",
- "description": "Response from ListTransferJobs.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The list next page token.",
@@ -630,37 +528,41 @@
"$ref": "TransferJob"
}
}
- }
+ },
+ "id": "ListTransferJobsResponse",
+ "description": "Response from ListTransferJobs.",
+ "type": "object"
},
"UpdateTransferJobRequest": {
"description": "Request passed to UpdateTransferJob.",
"type": "object",
"properties": {
"updateTransferJobFieldMask": {
- "type": "string",
"description": "The field mask of the fields in `transferJob` that are to be updated in\nthis request. Fields in `transferJob` that can be updated are:\n`description`, `transferSpec`, and `status`. To update the `transferSpec`\nof the job, a complete transfer specification has to be provided. An\nincomplete specification which misses any required fields will be rejected\nwith the error `INVALID_ARGUMENT`.",
- "format": "google-fieldmask"
+ "format": "google-fieldmask",
+ "type": "string"
},
"transferJob": {
- "description": "The job to update. `transferJob` is expected to specify only three fields:\n`description`, `transferSpec`, and `status`. An UpdateTransferJobRequest\nthat specifies other fields will be rejected with an error\n`INVALID_ARGUMENT`.\nRequired.",
- "$ref": "TransferJob"
+ "$ref": "TransferJob",
+ "description": "The job to update. `transferJob` is expected to specify only three fields:\n`description`, `transferSpec`, and `status`. An UpdateTransferJobRequest\nthat specifies other fields will be rejected with an error\n`INVALID_ARGUMENT`.\nRequired."
},
"projectId": {
- "type": "string",
- "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired."
+ "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
+ "type": "string"
}
},
"id": "UpdateTransferJobRequest"
},
"ObjectConditions": {
+ "description": "Conditions that determine which objects will be transferred.",
"type": "object",
"properties": {
"includePrefixes": {
+ "description": "If `includePrefixes` is specified, objects that satisfy the object\nconditions must have names that start with one of the `includePrefixes`\nand that do not start with any of the `excludePrefixes`. If `includePrefixes`\nis not specified, all objects except those that have names starting with\none of the `excludePrefixes` must satisfy the object conditions.\n\nRequirements:\n\n * Each include-prefix and exclude-prefix can contain any sequence of\n Unicode characters, of max length 1024 bytes when UTF8-encoded, and\n must not contain Carriage Return or Line Feed characters. Wildcard\n matching and regular expression matching are not supported.\n\n * Each include-prefix and exclude-prefix must omit the leading slash.\n For example, to include the `requests.gz` object in a transfer from\n `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include\n prefix as `logs/y=2015/requests.gz`.\n\n * None of the include-prefix or the exclude-prefix values can be empty,\n if specified.\n\n * Each include-prefix must include a distinct portion of the object\n namespace, i.e., no include-prefix may be a prefix of another\n include-prefix.\n\n * Each exclude-prefix must exclude a distinct portion of the object\n namespace, i.e., no exclude-prefix may be a prefix of another\n exclude-prefix.\n\n * If `includePrefixes` is specified, then each exclude-prefix must start\n with the value of a path explicitly included by `includePrefixes`.\n\nThe max size of `includePrefixes` is 1000.",
"type": "array",
"items": {
"type": "string"
- },
- "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."
+ }
},
"minTimeElapsedSinceLastModification": {
"description": "If unspecified, `minTimeElapsedSinceLastModification` takes a zero value\nand `maxTimeElapsedSinceLastModification` takes the maximum possible\nvalue of Duration. Objects that satisfy the object conditions\nmust either have a `lastModificationTime` greater or equal to\n`NOW` - `maxTimeElapsedSinceLastModification` and less than\n`NOW` - `minTimeElapsedSinceLastModification`, or not have a\n`lastModificationTime`.",
@@ -680,10 +582,10 @@
"type": "string"
}
},
- "id": "ObjectConditions",
- "description": "Conditions that determine which objects will be transferred."
+ "id": "ObjectConditions"
},
"Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
"response": {
@@ -715,16 +617,15 @@
"type": "boolean"
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
+ "id": "Operation"
},
"TransferOptions": {
"description": "TransferOptions uses three boolean parameters to define the actions\nto be performed on objects in a transfer.",
"type": "object",
"properties": {
"overwriteObjectsAlreadyExistingInSink": {
- "type": "boolean",
- "description": "Whether overwriting objects that already exist in the sink is allowed."
+ "description": "Whether overwriting objects that already exist in the sink is allowed.",
+ "type": "boolean"
},
"deleteObjectsFromSourceAfterTransfer": {
"description": "Whether objects should be deleted from the source after they are\ntransferred to the sink. Note that this option and\n`deleteObjectsUniqueInSink` are mutually exclusive.",
@@ -738,16 +639,18 @@
"id": "TransferOptions"
},
"TransferSpec": {
- "description": "Configuration for running a transfer.",
- "type": "object",
"properties": {
+ "awsS3DataSource": {
+ "$ref": "AwsS3Data",
+ "description": "An AWS S3 data source."
+ },
"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."
+ "description": "Only objects that satisfy these object conditions are included in the set\nof data source and data sink objects. Object conditions based on\nobjects' `lastModificationTime` do not exclude objects in a data sink.",
+ "$ref": "ObjectConditions"
},
"gcsDataSink": {
"description": "A Google Cloud Storage data sink.",
@@ -760,23 +663,19 @@
"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."
- },
- "awsS3DataSource": {
- "$ref": "AwsS3Data",
- "description": "An AWS S3 data source."
}
},
- "id": "TransferSpec"
+ "id": "TransferSpec",
+ "description": "Configuration for running a transfer.",
+ "type": "object"
},
"ResumeTransferOperationRequest": {
- "type": "object",
"properties": {},
"id": "ResumeTransferOperationRequest",
- "description": "Request passed to ResumeTransferOperation."
+ "description": "Request passed to ResumeTransferOperation.",
+ "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.",
@@ -799,7 +698,9 @@
"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"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
@@ -820,30 +721,18 @@
"id": "ListOperationsResponse"
},
"GoogleServiceAccount": {
- "description": "Google service account",
- "type": "object",
"properties": {
"accountEmail": {
"description": "Required.",
"type": "string"
}
},
- "id": "GoogleServiceAccount"
+ "id": "GoogleServiceAccount",
+ "description": "Google service account",
+ "type": "object"
},
"TimeOfDay": {
- "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
- "type": "object",
"properties": {
- "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",
@@ -853,9 +742,21 @@
"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": "TimeOfDay"
+ "id": "TimeOfDay",
+ "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
+ "type": "object"
},
"ErrorLogEntry": {
"description": "An entry describing an error that has occurred.",
@@ -866,40 +767,17 @@
"type": "string"
},
"errorDetails": {
+ "description": "A list of messages that carry the error details.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "A list of messages that carry the error details."
+ }
}
},
"id": "ErrorLogEntry"
},
"TransferJob": {
- "type": "object",
"properties": {
- "name": {
- "type": "string",
- "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."
- },
- "deletionTime": {
- "description": "This field cannot be changed by user requests.",
- "format": "google-datetime",
- "type": "string"
- },
- "lastModificationTime": {
- "description": "This field cannot be changed by user requests.",
- "format": "google-datetime",
- "type": "string"
- },
- "projectId": {
- "description": "The ID of the Google Cloud Platform Console project that owns the job.",
- "type": "string"
- },
- "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",
@@ -928,14 +806,35 @@
"schedule": {
"$ref": "Schedule",
"description": "Schedule specification."
+ },
+ "name": {
+ "description": "A globally unique name assigned by Storage Transfer Service when the\njob is created. This field should be left empty in requests to create a new\ntransfer job; otherwise, the requests result in an `INVALID_ARGUMENT`\nerror.",
+ "type": "string"
+ },
+ "deletionTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The ID of the Google Cloud Platform Console project that owns the job.",
+ "type": "string"
+ },
+ "lastModificationTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "description": {
+ "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded.",
+ "type": "string"
}
},
"id": "TransferJob",
- "description": "This resource represents the configuration of a transfer job that runs\nperiodically."
+ "description": "This resource represents the configuration of a transfer job that runs\nperiodically.",
+ "type": "object"
},
"Schedule": {
- "description": "Transfers can be scheduled to recur or to run just once.",
- "type": "object",
"properties": {
"scheduleEndDate": {
"$ref": "Date",
@@ -946,45 +845,57 @@
"description": "The time in UTC at which the transfer will be scheduled to start in a day.\nTransfers may start later than this time. If not specified, recurring and\none-time transfers that are scheduled to run today will run immediately;\nrecurring transfers that are scheduled to run on a future date will start\nat approximately midnight UTC on that date. Note that when configuring a\ntransfer with the Cloud Platform Console, the transfer's start time in a\nday is specified in your local timezone."
},
"scheduleStartDate": {
- "description": "The first day the recurring transfer is scheduled to run. If\n`scheduleStartDate` is in the past, the transfer will run for the first\ntime on the following day.\nRequired.",
- "$ref": "Date"
+ "$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"
+ "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",
"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"
- },
- "month": {
- "type": "integer",
- "description": "Month of year. Must be from 1 to 12.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "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"
},
"TransferOperation": {
- "id": "TransferOperation",
- "description": "A description of the execution of a transfer.",
- "type": "object",
"properties": {
+ "endTime": {
+ "description": "End time of this transfer execution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Start time of this transfer execution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "transferJobName": {
+ "description": "The name of the transfer job that triggers this transfer operation.",
+ "type": "string"
+ },
"transferSpec": {
- "description": "Transfer specification.\nRequired.",
- "$ref": "TransferSpec"
+ "$ref": "TransferSpec",
+ "description": "Transfer specification.\nRequired."
},
"status": {
- "type": "string",
"enumDescriptions": [
"Zero is an illegal value.",
"In progress.",
@@ -1001,11 +912,12 @@
"FAILED",
"ABORTED"
],
- "description": "Status of the transfer operation."
+ "description": "Status of the transfer operation.",
+ "type": "string"
},
"counters": {
- "$ref": "TransferCounters",
- "description": "Information about the progress of the transfer operation."
+ "description": "Information about the progress of the transfer operation.",
+ "$ref": "TransferCounters"
},
"errorBreakdowns": {
"description": "Summarizes errors encountered with sample error log entries.",
@@ -1021,57 +933,145 @@
"projectId": {
"description": "The ID of the Google Cloud Platform Console project that owns the operation.\nRequired.",
"type": "string"
- },
- "endTime": {
- "description": "End time of this transfer execution.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Start time of this transfer execution.",
- "format": "google-datetime",
- "type": "string"
- },
- "transferJobName": {
- "description": "The name of the transfer job that triggers this transfer operation.",
- "type": "string"
}
- }
+ },
+ "id": "TransferOperation",
+ "description": "A description of the execution of a transfer.",
+ "type": "object"
},
"AwsS3Data": {
- "description": "An AwsS3Data can be a data source, but not a data sink.\nIn an AwsS3Data, an object's name is the S3 object's key name.",
- "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."
+ },
+ "bucketName": {
+ "description": "S3 Bucket name (see\n[Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).\nRequired.",
+ "type": "string"
}
},
- "id": "AwsS3Data"
+ "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"
+ },
+ "AwsAccessKey": {
+ "description": "AWS access key (see\n[AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).",
+ "type": "object",
+ "properties": {
+ "secretAccessKey": {
+ "description": "AWS secret access key. This field is not returned in RPC responses.\nRequired.",
+ "type": "string"
+ },
+ "accessKeyId": {
+ "description": "AWS access key ID.\nRequired.",
+ "type": "string"
+ }
+ },
+ "id": "AwsAccessKey"
+ },
+ "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"
+ },
+ "PauseTransferOperationRequest": {
+ "properties": {},
+ "id": "PauseTransferOperationRequest",
+ "description": "Request passed to PauseTransferOperation.",
+ "type": "object"
+ },
+ "TransferCounters": {
+ "description": "A collection of counters that report the progress of a transfer operation.",
+ "type": "object",
+ "properties": {
+ "bytesDeletedFromSource": {
+ "description": "Bytes that are deleted from the data source.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectsFoundFromSource": {
+ "description": "Objects found in the data source that are scheduled to be transferred,\nexcluding any that are filtered based on object conditions or skipped due\nto sync.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectsFailedToDeleteFromSink": {
+ "description": "Objects that failed to be deleted from the data sink.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectsDeletedFromSink": {
+ "description": "Objects that are deleted from the data sink.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectsFoundOnlyFromSink": {
+ "description": "Objects found only in the data sink that are scheduled to be deleted.",
+ "format": "int64",
+ "type": "string"
+ },
+ "bytesFromSourceSkippedBySync": {
+ "description": "Bytes in the data source that are not transferred because they already\nexist in the data sink.",
+ "format": "int64",
+ "type": "string"
+ },
+ "bytesFailedToDeleteFromSink": {
+ "description": "Bytes that failed to be deleted from the data sink.",
+ "format": "int64",
+ "type": "string"
+ },
+ "bytesDeletedFromSink": {
+ "description": "Bytes that are deleted from the data sink.",
+ "format": "int64",
+ "type": "string"
+ },
+ "bytesFromSourceFailed": {
+ "description": "Bytes in the data source that failed to be transferred or that failed to\nbe deleted after being transferred.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectsFromSourceFailed": {
+ "description": "Objects in the data source that failed to be transferred or that failed\nto be deleted after being transferred.",
+ "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",
+ "type": "string"
+ },
+ "objectsFromSourceSkippedBySync": {
+ "description": "Objects in the data source that are not transferred because they already\nexist in the data sink.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "TransferCounters"
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest",
- "version": "v1",
- "baseUrl": "https://storagetransfer.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.",
- "servicePath": "",
- "rootUrl": "https://storagetransfer.googleapis.com/"
+ "protocol": "rest"
}
diff --git a/streetviewpublish/v1/streetviewpublish-api.json b/streetviewpublish/v1/streetviewpublish-api.json
index 2574e08..8d72d1d 100644
--- a/streetviewpublish/v1/streetviewpublish-api.json
+++ b/streetviewpublish/v1/streetviewpublish-api.json
@@ -1,28 +1,123 @@
{
+ "id": "streetviewpublish:v1",
+ "documentationLink": "https://developers.google.com/streetview/publish/",
+ "revision": "20180125",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "BatchGetPhotosResponse": {
+ "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",
+ "description": "Response to batch get of Photos.",
+ "type": "object"
+ },
+ "Place": {
+ "properties": {
+ "placeId": {
+ "description": "Place identifier, as described in\nhttps://developers.google.com/places/place-id.",
+ "type": "string"
+ }
+ },
+ "id": "Place",
+ "description": "Place metadata for an entity.",
+ "type": "object"
+ },
+ "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": {
+ "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"
+ },
+ "BatchDeletePhotosRequest": {
+ "description": "Request to delete multiple Photos.",
+ "type": "object",
+ "properties": {
+ "photoIds": {
+ "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "BatchDeletePhotosRequest"
+ },
+ "UpdatePhotoRequest": {
+ "description": "Request to update the metadata of a\nPhoto. Updating the pixels of a photo\nis not supported.",
+ "type": "object",
+ "properties": {
+ "updateMask": {
+ "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"
+ },
"PhotoId": {
+ "description": "Identifier for a Photo.",
+ "type": "object",
"properties": {
"id": {
"description": "Required. A unique identifier for a photo.",
"type": "string"
}
},
- "id": "PhotoId",
- "description": "Identifier for a Photo.",
- "type": "object"
+ "id": "PhotoId"
},
"Pose": {
"properties": {
+ "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"
},
"level": {
- "description": "Level (the floor in a building) used to configure vertical navigation.",
- "$ref": "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.",
@@ -33,15 +128,6 @@
"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": {
- "description": "Latitude and longitude pair of the pose, as explained here:\nhttps://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng\nWhen creating a Photo, if the\nlatitude and longitude pair are not provided here, the geolocation from the\nexif header will be used. If the latitude and longitude pair is not\nprovided and cannot be found in the exif header, the create photo process\nwill fail.",
- "$ref": "LatLng"
}
},
"id": "Pose",
@@ -63,22 +149,22 @@
"type": "object"
},
"ListPhotosResponse": {
- "description": "Response to list all photos that belong to a user.",
- "type": "object",
"properties": {
- "nextPageToken": {
- "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
- "type": "string"
- },
"photos": {
"description": "List of photos. The maximum number of items returned is based on the\npageSize field\nin the request.",
"type": "array",
"items": {
"$ref": "Photo"
}
+ },
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
+ "type": "string"
}
},
- "id": "ListPhotosResponse"
+ "id": "ListPhotosResponse",
+ "description": "Response to list all photos that belong to a user.",
+ "type": "object"
},
"Photo": {
"properties": {
@@ -91,13 +177,6 @@
"description": "Output only. The download URL for the photo bytes. This field is set only\nwhen\nGetPhotoRequest.view\nis set to\nPhotoView.INCLUDE_DOWNLOAD_URL.",
"type": "string"
},
- "places": {
- "description": "Places where this photo belongs.",
- "type": "array",
- "items": {
- "$ref": "Place"
- }
- },
"connections": {
"description": "Connections to other photos. A connection represents the link from this\nphoto to another photo.",
"type": "array",
@@ -105,30 +184,37 @@
"$ref": "Connection"
}
},
+ "places": {
+ "description": "Places where this photo belongs.",
+ "type": "array",
+ "items": {
+ "$ref": "Place"
+ }
+ },
"uploadReference": {
- "description": "Required when creating a photo. Input only. The resource URL where the\nphoto bytes are uploaded to.",
- "$ref": "UploadRef"
+ "$ref": "UploadRef",
+ "description": "Required when creating a photo. Input only. The resource URL where the\nphoto bytes are uploaded to."
},
"photoId": {
- "description": "Required when updating a photo. Output only when creating a photo.\nIdentifier for the photo, which is unique among all photos in\nGoogle.",
- "$ref": "PhotoId"
+ "$ref": "PhotoId",
+ "description": "Required when updating a photo. Output only when creating a photo.\nIdentifier for the photo, which is unique among all photos in\nGoogle."
},
"pose": {
- "description": "Pose of the photo.",
- "$ref": "Pose"
+ "$ref": "Pose",
+ "description": "Pose of the photo."
},
"shareLink": {
"description": "Output only. The share link for the photo.",
"type": "string"
},
- "thumbnailUrl": {
- "description": "Output only. The thumbnail URL for showing a preview of the given photo.",
- "type": "string"
- },
"captureTime": {
"description": "Absolute time when the photo was captured.\nWhen the photo has no exif timestamp, this is used to set a timestamp in\nthe photo metadata.",
"format": "google-datetime",
"type": "string"
+ },
+ "thumbnailUrl": {
+ "description": "Output only. The thumbnail URL for showing a preview of the given photo.",
+ "type": "string"
}
},
"id": "Photo",
@@ -136,11 +222,9 @@
"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.",
@@ -164,26 +248,28 @@
},
"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"
+ "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."
+ },
+ "status": {
+ "description": "The status for the operation to get or update a single photo in the batch\nrequest.",
+ "$ref": "Status"
}
},
- "id": "PhotoResponse",
- "description": "Response payload for a single\nPhoto\nin batch operations including\nBatchGetPhotos\nand\nBatchUpdatePhotos.",
- "type": "object"
+ "id": "PhotoResponse"
},
"Connection": {
"description": "A connection is the link from a source photo to a destination photo.",
@@ -197,8 +283,6 @@
"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.",
@@ -208,10 +292,18 @@
}
}
},
- "id": "BatchUpdatePhotosResponse"
+ "id": "BatchUpdatePhotosResponse",
+ "description": "Response to batch update of metadata of one or more\nPhotos.",
+ "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",
@@ -227,17 +319,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"
},
"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.",
@@ -247,11 +335,11 @@
}
}
},
- "id": "BatchDeletePhotosResponse",
- "description": "Response to batch delete of one or more\nPhotos.",
- "type": "object"
+ "id": "BatchDeletePhotosResponse"
},
"Level": {
+ "description": "Level information containing level number and its corresponding name.",
+ "type": "object",
"properties": {
"name": {
"description": "Required. A name assigned to this Level, restricted to 3 characters.\nConsider how the elevator buttons would be labeled for this level if there\nwas an elevator.",
@@ -263,105 +351,20 @@
"type": "number"
}
},
- "id": "Level",
- "description": "Level information containing level number and its corresponding name.",
- "type": "object"
+ "id": "Level"
},
"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"
- },
- "UploadRef": {
- "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",
- "description": "Upload reference for media files.",
- "type": "object"
- },
- "Place": {
- "description": "Place metadata for an entity.",
"type": "object",
- "properties": {
- "placeId": {
- "description": "Place identifier, as described in\nhttps://developers.google.com/places/place-id.",
- "type": "string"
- }
- },
- "id": "Place"
- },
- "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": {
- "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"
- },
- "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": {
- "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"
+ "properties": {},
+ "id": "Empty"
}
},
- "protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"canonicalName": "Street View Publish",
"auth": {
"oauth2": {
@@ -382,49 +385,85 @@
"resources": {
"photos": {
"methods": {
+ "batchUpdate": {
+ "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",
+ "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"
+ }
+ },
+ "batchDelete": {
+ "response": {
+ "$ref": "BatchDeletePhotosResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "flatPath": "v1/photos:batchDelete",
+ "path": "v1/photos:batchDelete",
+ "id": "streetviewpublish.photos.batchDelete",
+ "request": {
+ "$ref": "BatchDeletePhotosRequest"
+ },
+ "description": "Deletes a list of Photos and their\nmetadata.\n\nNote that if\nBatchDeletePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchDeletePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchDeletePhotosResponse.results.\nSee\nDeletePhoto\nfor specific failures that can occur per photo."
+ },
"batchGet": {
- "httpMethod": "GET",
+ "description": "Gets the metadata of the specified\nPhoto batch.\n\nNote that if\nBatchGetPhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchGetPhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchGetPhotosResponse.results.\nSee\nGetPhoto\nfor specific failures that can occur per photo.",
"response": {
"$ref": "BatchGetPhotosResponse"
},
"parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
"view": {
- "location": "query",
"enum": [
"BASIC",
"INCLUDE_DOWNLOAD_URL"
],
"description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"photoIds": {
- "repeated": true,
- "location": "query",
"description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`.",
- "type": "string"
+ "type": "string",
+ "repeated": true,
+ "location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
],
"flatPath": "v1/photos:batchGet",
- "id": "streetviewpublish.photos.batchGet",
"path": "v1/photos:batchGet",
- "description": "Gets the metadata of the specified\nPhoto batch.\n\nNote that if\nBatchGetPhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchGetPhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchGetPhotosResponse.results.\nSee\nGetPhoto\nfor specific failures that can occur per photo."
+ "id": "streetviewpublish.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",
- "httpMethod": "GET",
"response": {
"$ref": "ListPhotosResponse"
},
"parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
"pageToken": {
+ "location": "query",
"description": "The\nnextPageToken\nvalue returned from a previous\nListPhotos\nrequest, if any.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"description": "The maximum number of photos to return.\n`pageSize` must be non-negative. If `pageSize` is zero or is not provided,\nthe default page size of 100 will be used.\nThe number of photos returned in the response may be less than `pageSize`\nif the number of photos that belong to the user is less than `pageSize`.",
@@ -433,137 +472,102 @@
"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": {
- "description": "The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.\n\nThe only filter supported at the moment is `placeId`.",
"type": "string",
"location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.\n\nThe only filter supported at the moment is `placeId`.",
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
],
"flatPath": "v1/photos",
- "id": "streetviewpublish.photos.list",
- "path": "v1/photos"
- },
- "batchUpdate": {
- "request": {
- "$ref": "BatchUpdatePhotosRequest"
- },
- "description": "Updates the metadata of Photos, such\nas pose, place association, connections, etc. Changing the pixels of photos\nis not supported.\n\nNote that if\nBatchUpdatePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchUpdatePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchUpdatePhotosResponse.results.\nSee\nUpdatePhoto\nfor specific failures that can occur per photo.\n\nOnly the fields specified in\nupdateMask\nfield are used. If `updateMask` is not present, the update applies to all\nfields.\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e To update\nPose.altitude,\nPose.latLngPair has to be\nfilled as well. Otherwise, the request will fail.\u003c/aside\u003e",
- "response": {
- "$ref": "BatchUpdatePhotosResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photos:batchUpdate",
- "path": "v1/photos:batchUpdate",
- "id": "streetviewpublish.photos.batchUpdate"
- },
- "batchDelete": {
- "response": {
- "$ref": "BatchDeletePhotosResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {},
- "flatPath": "v1/photos:batchDelete",
- "path": "v1/photos:batchDelete",
- "id": "streetviewpublish.photos.batchDelete",
- "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"
- }
+ "path": "v1/photos",
+ "id": "streetviewpublish.photos.list"
}
}
},
"photo": {
"methods": {
"update": {
- "id": "streetviewpublish.photo.update",
- "path": "v1/photo/{id}",
- "request": {
+ "response": {
"$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.",
- "httpMethod": "PUT",
"parameterOrder": [
"id"
],
- "response": {
- "$ref": "Photo"
- },
- "parameters": {
- "id": {
- "location": "path",
- "description": "Required. A unique identifier for a photo.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "Mask that identifies fields on the photo metadata to update.\nIf not present, the old Photo\nmetadata will be entirely replaced with the\nnew Photo metadata in this request.\nThe update fails if invalid fields are specified. Multiple fields can be\nspecified in a comma-delimited list.\n\nThe following fields are valid:\n\n* `pose.heading`\n* `pose.latLngPair`\n* `pose.pitch`\n* `pose.roll`\n* `pose.level`\n* `pose.altitude`\n* `connections`\n* `places`\n\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e Repeated fields in\nupdateMask\nmean the entire set of repeated values will be replaced with the new\ncontents. For example, if\nupdateMask\ncontains `connections` and `UpdatePhotoRequest.photo.connections` is empty,\nall connections will be removed.\u003c/aside\u003e",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
+ "httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
],
- "flatPath": "v1/photo/{id}"
+ "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",
+ "description": "Updates the metadata of a Photo, such\nas pose, place association, connections, etc. Changing the pixels of a\nphoto is not supported.\n\nOnly the fields specified in the\nupdateMask\nfield are used. If `updateMask` is not present, the update applies to all\nfields.\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e To update\nPose.altitude,\nPose.latLngPair has to be\nfilled as well. Otherwise, the request will fail.\u003c/aside\u003e\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed.\n* google.rpc.Code.NOT_FOUND if the requested photo does not exist.\n* google.rpc.Code.UNAVAILABLE if the requested\nPhoto is still being indexed.",
+ "request": {
+ "$ref": "Photo"
+ }
},
"create": {
- "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Photo"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "flatPath": "v1/photo",
+ "id": "streetviewpublish.photo.create",
+ "path": "v1/photo",
"request": {
"$ref": "Photo"
},
- "response": {
- "$ref": "Photo"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {},
- "flatPath": "v1/photo",
- "path": "v1/photo",
- "id": "streetviewpublish.photo.create"
+ "description": "After the client finishes uploading the photo with the returned\nUploadRef,\nCreatePhoto\npublishes the uploaded Photo to\nStreet View on Google Maps.\n\nCurrently, the only way to set heading, pitch, and roll in CreatePhoto is\nthrough the [Photo Sphere XMP\nmetadata](https://developers.google.com/streetview/spherical-metadata) in\nthe photo bytes. The `pose.heading`, `pose.pitch`, `pose.roll`,\n`pose.altitude`, and `pose.level` fields in Pose are ignored for\nCreatePhoto.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed or if\nthe uploaded photo is not a 360 photo.\n* google.rpc.Code.NOT_FOUND if the upload reference does not exist.\n* google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the\nstorage limit."
},
"startUpload": {
- "id": "streetviewpublish.photo.startUpload",
"path": "v1/photo:startUpload",
+ "id": "streetviewpublish.photo.startUpload",
+ "description": "Creates an upload session to start uploading photo bytes. The upload URL of\nthe returned UploadRef is used to\nupload the bytes for the Photo.\n\nIn addition to the photo requirements shown in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604,\nthe photo must also meet the following requirements:\n\n* Photo Sphere XMP metadata must be included in the photo medadata. See\nhttps://developers.google.com/streetview/spherical-metadata for the\nrequired fields.\n* The pixel size of the photo must meet the size requirements listed in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and\nthe photo must be a full 360 horizontally.\n\nAfter the upload is complete, the\nUploadRef is used with\nCreatePhoto\nto create the Photo object entry.",
"request": {
"$ref": "Empty"
},
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "UploadRef"
},
- "parameters": {},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
],
+ "parameters": {},
"flatPath": "v1/photo:startUpload"
},
"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"
},
@@ -584,11 +588,9 @@
},
"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."
+ "id": "streetviewpublish.photo.delete"
},
"get": {
- "description": "Gets the metadata of the specified\nPhoto.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested Photo.\n* google.rpc.Code.NOT_FOUND if the requested\nPhoto does not exist.\n* google.rpc.Code.UNAVAILABLE if the requested\nPhoto is still being indexed.",
"response": {
"$ref": "Photo"
},
@@ -618,81 +620,27 @@
],
"flatPath": "v1/photo/{photoId}",
"path": "v1/photo/{photoId}",
- "id": "streetviewpublish.photo.get"
+ "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": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "access_token": {
+ "description": "OAuth access token.",
"type": "string",
"location": "query"
},
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
"description": "Pretty-print response.",
@@ -709,6 +657,61 @@
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
}
},
"version": "v1",
@@ -716,8 +719,5 @@
"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": "20180125"
+ "basePath": ""
}
diff --git a/testing/v1/testing-api.json b/testing/v1/testing-api.json
index 57a15ff..0aa50e9 100644
--- a/testing/v1/testing-api.json
+++ b/testing/v1/testing-api.json
@@ -1,21 +1,10 @@
{
- "rootUrl": "https://testing.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "testing",
- "batchPath": "batch",
- "revision": "20180126",
- "documentationLink": "https://developers.google.com/cloud-test-lab/",
- "id": "testing:v1",
- "title": "Google Cloud Testing API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
"testEnvironmentCatalog": {
"methods": {
"get": {
- "id": "testing.testEnvironmentCatalog.get",
- "path": "v1/testEnvironmentCatalog/{environmentType}",
"description": "Get the catalog of supported test environments.\n\nMay return any of the following canonical error codes:\n\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the environment type does not exist\n- INTERNAL - if an internal error occurred",
"httpMethod": "GET",
"parameterOrder": [
@@ -26,27 +15,29 @@
},
"parameters": {
"projectId": {
+ "location": "query",
"description": "For authorization, the cloud project requesting the TestEnvironmentCatalog.\nOptional",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"environmentType": {
+ "required": true,
+ "type": "string",
+ "location": "path",
"enum": [
"ENVIRONMENT_TYPE_UNSPECIFIED",
"ANDROID",
"NETWORK_CONFIGURATION"
],
- "description": "The type of environment that should be listed.\nRequired",
- "required": true,
- "type": "string",
- "location": "path"
+ "description": "The type of environment that should be listed.\nRequired"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/testEnvironmentCatalog/{environmentType}"
+ "flatPath": "v1/testEnvironmentCatalog/{environmentType}",
+ "id": "testing.testEnvironmentCatalog.get",
+ "path": "v1/testEnvironmentCatalog/{environmentType}"
}
}
},
@@ -54,11 +45,70 @@
"resources": {
"testMatrices": {
"methods": {
- "create": {
- "request": {
+ "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",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "CancelTestMatrixResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "testMatrixId"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Cloud project that owns the test.",
+ "required": true,
+ "type": "string"
+ },
+ "testMatrixId": {
+ "description": "Test matrix that will be canceled.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}",
+ "id": "testing.projects.testMatrices.get",
+ "description": "Check the status of a test matrix.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist",
+ "response": {
"$ref": "TestMatrix"
},
- "description": "Request to run a matrix of tests according to the given specifications.\nUnsupported environments will be returned in the state UNSUPPORTED.\nMatrices are limited to at most 200 supported executions.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project\n- INVALID_ARGUMENT - if the request is malformed or if the matrix expands\n to more than 200 supported executions",
+ "parameterOrder": [
+ "projectId",
+ "testMatrixId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Cloud project that owns the test matrix.",
+ "required": true,
+ "type": "string"
+ },
+ "testMatrixId": {
+ "description": "Unique test matrix id which was assigned by the service.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}"
+ },
+ "create": {
"httpMethod": "POST",
"parameterOrder": [
"projectId"
@@ -84,70 +134,11 @@
],
"flatPath": "v1/projects/{projectId}/testMatrices",
"id": "testing.projects.testMatrices.create",
- "path": "v1/projects/{projectId}/testMatrices"
- },
- "cancel": {
- "httpMethod": "POST",
- "response": {
- "$ref": "CancelTestMatrixResponse"
- },
- "parameterOrder": [
- "projectId",
- "testMatrixId"
- ],
- "parameters": {
- "testMatrixId": {
- "location": "path",
- "description": "Test matrix that will be canceled.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "Cloud project that owns the test.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- },
- "get": {
- "response": {
+ "path": "v1/projects/{projectId}/testMatrices",
+ "request": {
"$ref": "TestMatrix"
},
- "parameterOrder": [
- "projectId",
- "testMatrixId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "projectId": {
- "description": "Cloud project that owns the test matrix.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "testMatrixId": {
- "description": "Unique test matrix id which was assigned by the service.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}",
- "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}",
- "id": "testing.projects.testMatrices.get",
- "description": "Check the status of a test matrix.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist"
+ "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"
}
}
}
@@ -156,9 +147,9 @@
},
"parameters": {
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
@@ -172,29 +163,31 @@
"type": "string"
},
"uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
"location": "query",
- "description": "JSONP",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
+ },
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "type": "string"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -206,9 +199,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"
},
"access_token": {
"description": "OAuth access token.",
@@ -216,9 +207,9 @@
"location": "query"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"quotaUser": {
"location": "query",
@@ -243,69 +234,9 @@
}
},
"schemas": {
- "AndroidRuntimeConfiguration": {
- "description": "Configuration that can be selected at the time a test is run.",
- "type": "object",
- "properties": {
- "orientations": {
- "description": "The set of available orientations.\n@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "Orientation"
- }
- },
- "locales": {
- "description": "The set of available locales.\n@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "Locale"
- }
- }
- },
- "id": "AndroidRuntimeConfiguration"
- },
- "AndroidDevice": {
- "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",
- "description": "A single Android device.",
- "type": "object"
- },
- "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": {
- "description": "The emulation rule applying to the download traffic",
- "$ref": "TrafficRule"
- }
- },
- "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",
@@ -324,17 +255,12 @@
"type": "string"
}
},
- "id": "ToolResultsStep",
- "description": "Represents a tool results step resource.\n\nThis has the results of a TestExecution.",
- "type": "object"
+ "id": "ToolResultsStep"
},
"TrafficRule": {
+ "description": "Network emulation parameters",
+ "type": "object",
"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",
@@ -354,48 +280,22 @@
"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",
- "description": "Network emulation parameters",
- "type": "object"
+ "id": "TrafficRule"
},
"AndroidInstrumentationTest": {
"description": "A test of an Android application that can control an Android component\nindependently of its normal lifecycle.\nAndroid instrumentation tests run an application APK and test APK inside the\nsame process on a virtual or physical AndroidDevice. They also specify\na test runner class, such as com.google.GoogleTestRunner, which can vary\non the specific instrumentation framework chosen.\n\nSee \u003chttp://developer.android.com/tools/testing/testing_android.html\u003e for\nmore information on types of Android tests.",
"type": "object",
"properties": {
- "appPackageId": {
- "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.",
- "type": "string"
- },
- "appApk": {
- "$ref": "FileReference",
- "description": "The APK for the application under test.\nRequired"
- },
- "orchestratorOption": {
- "enum": [
- "ORCHESTRATOR_OPTION_UNSPECIFIED",
- "USE_ORCHESTRATOR",
- "DO_NOT_USE_ORCHESTRATOR"
- ],
- "description": "The option of whether running each test within its own invocation of\ninstrumentation with Android Test Orchestrator or not.\n** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher! **\nOrchestrator offers the following benefits:\n - No shared state\n - Crashes are isolated\n - Logs are scoped per test\n\nSee\n\u003chttps://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator\u003e\nfor more information about Android Test Orchestrator.\n\nOptional, if empty, test will be run without orchestrator.",
- "type": "string",
- "enumDescriptions": [
- "This means that the server should choose the mode. And test will be run\nwithout orchestrator.\nUsing orchestrator is highly encouraged because of all the benefits it\noffers. And in the future, all instrumentation tests will be run with\norchestrator by default if preference unspecified.",
- "Run test using orchestrator.\n** Only compatible with AndroidJUnitRunner version 1.0 or higher! **\nRecommended.",
- "Run test without using orchestrator."
- ]
- },
- "testTargets": {
- "description": "Each target must be fully qualified with the package name or class name,\nin one of these formats:\n - \"package package_name\"\n - \"class package_name.class_name\"\n - \"class package_name.class_name#method_name\"\n\nOptional, if empty, all targets in the module will be run.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"testApk": {
- "description": "The APK containing the test code to be executed.\nRequired",
- "$ref": "FileReference"
+ "$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.",
@@ -404,22 +304,52 @@
"testPackageId": {
"description": "The java package for the test to be executed.\nOptional, default is determined by examining the application's manifest.",
"type": "string"
+ },
+ "appPackageId": {
+ "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.",
+ "type": "string"
+ },
+ "appApk": {
+ "description": "The APK for the application under test.\nRequired",
+ "$ref": "FileReference"
+ },
+ "orchestratorOption": {
+ "enumDescriptions": [
+ "This means that the server should choose the mode. And test will be run\nwithout orchestrator.\nUsing orchestrator is highly encouraged because of all the benefits it\noffers. And in the future, all instrumentation tests will be run with\norchestrator by default if preference unspecified.",
+ "Run test using orchestrator.\n** Only compatible with AndroidJUnitRunner version 1.0 or higher! **\nRecommended.",
+ "Run test without using orchestrator."
+ ],
+ "enum": [
+ "ORCHESTRATOR_OPTION_UNSPECIFIED",
+ "USE_ORCHESTRATOR",
+ "DO_NOT_USE_ORCHESTRATOR"
+ ],
+ "description": "The option of whether running each test within its own invocation of\ninstrumentation with Android Test Orchestrator or not.\n** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher! **\nOrchestrator offers the following benefits:\n - No shared state\n - Crashes are isolated\n - Logs are scoped per test\n\nSee\n\u003chttps://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator\u003e\nfor more information about Android Test Orchestrator.\n\nOptional, if empty, test will be run without orchestrator.",
+ "type": "string"
+ },
+ "testTargets": {
+ "description": "Each target must be fully qualified with the package name or class name,\nin one of these formats:\n - \"package package_name\"\n - \"class package_name.class_name\"\n - \"class package_name.class_name#method_name\"\n\nOptional, if empty, all targets in the module will be run.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "AndroidInstrumentationTest"
},
"DeviceFile": {
+ "description": "A single device file description.",
+ "type": "object",
"properties": {
"obbFile": {
"$ref": "ObbFile",
"description": "A reference to an opaque binary blob file"
}
},
- "id": "DeviceFile",
- "description": "A single device file description.",
- "type": "object"
+ "id": "DeviceFile"
},
"ClientInfoDetail": {
+ "id": "ClientInfoDetail",
"description": "Key-value pair of detailed information about the client which invoked the\ntest. For example {'Version', '1.0'}, {'Release Track', 'BETA'}",
"type": "object",
"properties": {
@@ -431,12 +361,9 @@
"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": {
"key": {
"description": "Key for the environment variable",
@@ -447,7 +374,9 @@
"type": "string"
}
},
- "id": "EnvironmentVariable"
+ "id": "EnvironmentVariable",
+ "description": "A key-value pair passed as an environment variable to the test",
+ "type": "object"
},
"Environment": {
"description": "The environment in which the test is run.",
@@ -461,8 +390,27 @@
"id": "Environment"
},
"TestExecution": {
+ "description": "Specifies a single test to be executed in a single environment.",
+ "type": "object",
"properties": {
+ "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",
@@ -477,28 +425,15 @@
"INVALID"
],
"description": "Indicates the current progress of the test execution (e.g., FINISHED).\n@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "Do not use. For proto versioning only.",
- "The execution or matrix is being validated.",
- "The execution or matrix is waiting for resources to become available.",
- "The execution is currently being processed.\n\nCan only be set on an execution.",
- "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
- "The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
- "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
- "The user cancelled the execution.\n\nCan only be set on an execution.",
- "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
- ]
+ "type": "string"
},
"toolResultsStep": {
- "description": "Where the results for this execution are written.\n@OutputOnly",
- "$ref": "ToolResultsStep"
+ "$ref": "ToolResultsStep",
+ "description": "Where the results for this execution are written.\n@OutputOnly"
},
"testSpecification": {
- "description": "How to run the test.\n@OutputOnly",
- "$ref": "TestSpecification"
+ "$ref": "TestSpecification",
+ "description": "How to run the test.\n@OutputOnly"
},
"projectId": {
"description": "The cloud project that owns the test execution.\n@OutputOnly",
@@ -514,61 +449,55 @@
"type": "string"
},
"testDetails": {
- "description": "Additional details about the running test.\n@OutputOnly",
- "$ref": "TestDetails"
+ "$ref": "TestDetails",
+ "description": "Additional details about the running test.\n@OutputOnly"
},
"matrixId": {
"description": "Id of the containing TestMatrix.\n@OutputOnly",
"type": "string"
- },
- "environment": {
- "description": "How the host machine(s) are configured.\n@OutputOnly",
- "$ref": "Environment"
}
},
- "id": "TestExecution",
- "description": "Specifies a single test to be executed in a single environment.",
- "type": "object"
+ "id": "TestExecution"
},
"GoogleCloudStorage": {
"description": "A storage location within Google cloud storage (GCS).",
"type": "object",
"properties": {
"gcsPath": {
- "description": "The path to a directory in GCS that will\neventually contain the results for this test.\nThe requesting user must have write access on the bucket in the supplied\npath.\nRequired",
- "type": "string"
+ "type": "string",
+ "description": "The path to a directory in GCS that will\neventually contain the results for this test.\nThe requesting user must have write access on the bucket in the supplied\npath.\nRequired"
}
},
"id": "GoogleCloudStorage"
},
"RoboDirective": {
+ "description": "Directs Robo to interact with a specific UI element if it is encountered\nduring the crawl. Currently, Robo can perform text entry or element click.",
+ "type": "object",
"properties": {
"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"
+ "type": "string",
+ "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"
},
"actionType": {
+ "enumDescriptions": [
+ "DO NOT USE. For proto versioning only.",
+ "Direct Robo to click on the specified element. No-op if specified element\nis not clickable.",
+ "Direct Robo to enter text on the specified element. No-op if specified\nelement is not enabled or does not allow text entry."
+ ],
"enum": [
"ACTION_TYPE_UNSPECIFIED",
"SINGLE_CLICK",
"ENTER_TEXT"
],
"description": "The type of action that Robo should perform on the specified element.\nRequired.",
- "type": "string",
- "enumDescriptions": [
- "DO NOT USE. For proto versioning only.",
- "Direct Robo to click on the specified element. No-op if specified element\nis not clickable.",
- "Direct Robo to enter text on the specified element. No-op if specified\nelement is not enabled or does not allow text entry."
- ]
+ "type": "string"
}
},
- "id": "RoboDirective",
- "description": "Directs Robo to interact with a specific UI element if it is encountered\nduring the crawl. Currently, Robo can perform text entry or element click.",
- "type": "object"
+ "id": "RoboDirective"
},
"AndroidMatrix": {
"properties": {
@@ -606,20 +535,39 @@
"type": "object"
},
"AndroidModel": {
+ "type": "object",
"properties": {
+ "brand": {
+ "description": "The company that this device is branded with.\nExample: \"Google\", \"Samsung\"\n@OutputOnly",
+ "type": "string"
+ },
+ "screenX": {
+ "description": "Screen size in the horizontal (X) dimension measured in pixels.\n@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "codename": {
+ "description": "The name of the industrial design.\nThis corresponds to android.os.Build.DEVICE\n@OutputOnly",
+ "type": "string"
+ },
+ "screenY": {
+ "description": "Screen size in the vertical (Y) dimension measured in pixels.\n@OutputOnly",
+ "format": "int32",
+ "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"
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use. For proto versioning only.",
+ "A software stack that simulates the device",
+ "Actual hardware"
+ ]
},
"screenDensity": {
"description": "Screen density in DPI.\nThis corresponds to ro.sf.lcd_density\n@OutputOnly",
@@ -656,47 +604,18 @@
}
},
"manufacturer": {
- "description": "The manufacturer of this device.\n@OutputOnly",
- "type": "string"
- },
- "brand": {
- "description": "The company that this device is branded with.\nExample: \"Google\", \"Samsung\"\n@OutputOnly",
- "type": "string"
- },
- "screenX": {
- "description": "Screen size in the horizontal (X) dimension measured in pixels.\n@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "codename": {
- "description": "The name of the industrial design.\nThis corresponds to android.os.Build.DEVICE\n@OutputOnly",
- "type": "string"
- },
- "screenY": {
- "description": "Screen size in the vertical (Y) dimension measured in pixels.\n@OutputOnly",
- "format": "int32",
- "type": "integer"
+ "type": "string",
+ "description": "The manufacturer of this device.\n@OutputOnly"
}
},
"id": "AndroidModel",
- "description": "A description of an Android device tests may be run on.",
- "type": "object"
+ "description": "A description of an Android device tests may be run on."
},
"TestSetup": {
+ "id": "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"
@@ -714,11 +633,23 @@
"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"
+ }
},
"TestSpecification": {
+ "description": "A description of how to run the test.",
+ "type": "object",
"properties": {
"testTimeout": {
"description": "Max time a test execution is allowed to run before it is\nautomatically cancelled.\nOptional, default is 5 min.",
@@ -730,62 +661,121 @@
"type": "boolean"
},
"androidTestLoop": {
- "$ref": "AndroidTestLoop",
- "description": "An Android Application with a Test Loop"
+ "description": "An Android Application with a Test Loop",
+ "$ref": "AndroidTestLoop"
},
"testSetup": {
- "description": "Test setup requirements e.g. files to install, bootstrap scripts\nOptional",
- "$ref": "TestSetup"
+ "$ref": "TestSetup",
+ "description": "Test setup requirements e.g. files to install, bootstrap scripts\nOptional"
},
"androidRoboTest": {
- "description": "An Android robo test.",
- "$ref": "AndroidRoboTest"
+ "$ref": "AndroidRoboTest",
+ "description": "An Android robo test."
},
"androidInstrumentationTest": {
- "description": "An Android instrumentation test.",
- "$ref": "AndroidInstrumentationTest"
+ "$ref": "AndroidInstrumentationTest",
+ "description": "An Android instrumentation test."
},
"disablePerformanceMetrics": {
- "description": "Disables performance metrics recording; may reduce test latency.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Disables performance metrics recording; may reduce test latency."
},
"disableVideoRecording": {
"description": "Disables video recording; may reduce test latency.",
"type": "boolean"
}
},
- "id": "TestSpecification",
- "description": "A description of how to run the test.",
- "type": "object"
+ "id": "TestSpecification"
},
"ResultStorage": {
+ "description": "Locations where the results of running the test are stored.",
+ "type": "object",
"properties": {
"toolResultsHistory": {
- "description": "The tool results history that contains the tool results execution that\nresults are written to.\n\nOptional, if not provided the service will choose an appropriate value.",
- "$ref": "ToolResultsHistory"
+ "$ref": "ToolResultsHistory",
+ "description": "The tool results history that contains the tool results execution that\nresults are written to.\n\nOptional, if not provided the service will choose an appropriate value."
},
"googleCloudStorage": {
"description": "Required.",
"$ref": "GoogleCloudStorage"
},
"toolResultsExecution": {
- "description": "The tool results execution that results are written to.\n@OutputOnly",
- "$ref": "ToolResultsExecution"
+ "$ref": "ToolResultsExecution",
+ "description": "The tool results execution that results are written to.\n@OutputOnly"
}
},
- "id": "ResultStorage",
- "description": "Locations where the results of running the test are stored.",
- "type": "object"
+ "id": "ResultStorage"
},
"TestMatrix": {
+ "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",
"properties": {
+ "state": {
+ "enum": [
+ "TEST_STATE_UNSPECIFIED",
+ "VALIDATING",
+ "PENDING",
+ "RUNNING",
+ "FINISHED",
+ "ERROR",
+ "UNSUPPORTED_ENVIRONMENT",
+ "INCOMPATIBLE_ENVIRONMENT",
+ "INCOMPATIBLE_ARCHITECTURE",
+ "CANCELLED",
+ "INVALID"
+ ],
+ "description": "Indicates the current progress of the test matrix (e.g., FINISHED)\n@OutputOnly",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use. For proto versioning only.",
+ "The execution or matrix is being validated.",
+ "The execution or matrix is waiting for resources to become available.",
+ "The execution is currently being processed.\n\nCan only be set on an execution.",
+ "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
+ "The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
+ "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
+ "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
+ "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
+ "The user cancelled the execution.\n\nCan only be set on an execution.",
+ "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
+ ]
+ },
+ "projectId": {
+ "description": "The cloud project that owns the test matrix.\n@OutputOnly",
+ "type": "string"
+ },
+ "testSpecification": {
+ "$ref": "TestSpecification",
+ "description": "How to run the test.\nRequired"
+ },
+ "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"
+ },
+ "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"
+ "$ref": "ResultStorage",
+ "description": "Where the results for the matrix are written.\nRequired"
},
"invalidMatrixDetails": {
"enumDescriptions": [
@@ -836,71 +826,12 @@
],
"description": "Describes why the matrix is considered invalid.\nOnly useful for matrices in the INVALID state.\n@OutputOnly",
"type": "string"
- },
- "state": {
- "enumDescriptions": [
- "Do not use. For proto versioning only.",
- "The execution or matrix is being validated.",
- "The execution or matrix is waiting for resources to become available.",
- "The execution is currently being processed.\n\nCan only be set on an execution.",
- "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
- "The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
- "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
- "The user cancelled the execution.\n\nCan only be set on an execution.",
- "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
- ],
- "enum": [
- "TEST_STATE_UNSPECIFIED",
- "VALIDATING",
- "PENDING",
- "RUNNING",
- "FINISHED",
- "ERROR",
- "UNSUPPORTED_ENVIRONMENT",
- "INCOMPATIBLE_ENVIRONMENT",
- "INCOMPATIBLE_ARCHITECTURE",
- "CANCELLED",
- "INVALID"
- ],
- "description": "Indicates the current progress of the test matrix (e.g., FINISHED)\n@OutputOnly",
- "type": "string"
- },
- "projectId": {
- "description": "The cloud project that owns the test matrix.\n@OutputOnly",
- "type": "string"
- },
- "testSpecification": {
- "$ref": "TestSpecification",
- "description": "How to run the test.\nRequired"
- },
- "clientInfo": {
- "$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",
@@ -931,30 +862,28 @@
"type": "string"
},
"releaseDate": {
- "description": "The date this Android version became available in the market.\n@OutputOnly",
- "$ref": "Date"
+ "$ref": "Date",
+ "description": "The date this Android version became available in the market.\n@OutputOnly"
}
},
- "id": "AndroidVersion",
- "description": "A version of the Android OS",
- "type": "object"
+ "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",
- "description": "A reference to a file, used for user inputs.",
- "type": "object"
+ "id": "FileReference"
},
"LauncherActivityIntent": {
- "properties": {},
- "id": "LauncherActivityIntent",
"description": "Specifies an intent that starts the main launcher activity.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "LauncherActivityIntent"
},
"TestDetails": {
"description": "Additional details about the progress of the running test.",
@@ -975,6 +904,8 @@
"id": "TestDetails"
},
"ToolResultsExecution": {
+ "description": "Represents a tool results execution resource.\n\nThis has the results of a TestMatrix.",
+ "type": "object",
"properties": {
"executionId": {
"description": "A tool results execution ID.\n@OutputOnly",
@@ -985,13 +916,11 @@
"type": "string"
},
"historyId": {
- "description": "A tool results history ID.\n@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "A tool results history ID.\n@OutputOnly"
}
},
- "id": "ToolResultsExecution",
- "description": "Represents a tool results execution resource.\n\nThis has the results of a TestMatrix.",
- "type": "object"
+ "id": "ToolResultsExecution"
},
"Distribution": {
"description": "Data about the relative number of devices running a\ngiven configuration of the Android platform.",
@@ -1011,35 +940,17 @@
"id": "Distribution"
},
"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": {
- "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": {
- "description": "The APK for the application under test.\nRequired",
- "$ref": "FileReference"
- },
- "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": {
+ "type": "integer",
"description": "The max number of steps Robo can execute.\nDefault is no limit.\nOptional",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"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",
@@ -1047,13 +958,33 @@
"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"
+ },
+ "appPackageId": {
+ "type": "string",
+ "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest."
+ },
+ "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"
+ }
}
},
- "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"
+ "id": "AndroidRoboTest"
},
"ToolResultsHistory": {
+ "description": "Represents a tool results history resource.",
+ "type": "object",
"properties": {
"projectId": {
"description": "The cloud project that owns the tool results history.\nRequired",
@@ -1064,11 +995,12 @@
"type": "string"
}
},
- "id": "ToolResultsHistory",
- "description": "Represents a tool results history resource.",
- "type": "object"
+ "id": "ToolResultsHistory"
},
"Orientation": {
+ "id": "Orientation",
+ "description": "Screen orientation of the device.",
+ "type": "object",
"properties": {
"id": {
"description": "The id for this orientation.\nExample: \"portrait\"\n@OutputOnly",
@@ -1085,10 +1017,7 @@
"description": "A human-friendly name for this orientation.\nExample: \"portrait\"\n@OutputOnly",
"type": "string"
}
- },
- "id": "Orientation",
- "description": "Screen orientation of the device.",
- "type": "object"
+ }
},
"NetworkConfigurationCatalog": {
"type": "object",
@@ -1105,12 +1034,12 @@
"AndroidTestLoop": {
"properties": {
"scenarios": {
- "description": "The list of scenarios that should be run during the test.\nOptional, default is all test loops, derived from the application's\nmanifest.",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
- }
+ },
+ "description": "The list of scenarios that should be run during the test.\nOptional, default is all test loops, derived from the application's\nmanifest."
},
"scenarioLabels": {
"description": "The list of scenario labels that should be run during the test.\nThe scenario labels should map to labels defined in the application's\nmanifest. For example, player_experience and\ncom.google.test.loops.player_experience add all of the loops labeled in the\nmanifest with the com.google.test.loops.player_experience name to the\nexecution.\nOptional. Scenarios can also be specified in the scenarios field.",
@@ -1120,8 +1049,8 @@
}
},
"appApk": {
- "description": "The APK for the application under test.\nRequired",
- "$ref": "FileReference"
+ "$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.",
@@ -1133,22 +1062,13 @@
"type": "object"
},
"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"
+ "id": "GoogleAuto",
+ "description": "Enables automatic Google account login.\nIf set, the service will automatically generate a Google test account and add\nit to the device, before executing the test. Note that test accounts might be\nreused.\nMany applications show their full set of functionalities when an account is\npresent on the device. Logging into the device with these generated accounts\nallows testing more functionalities.",
+ "type": "object"
},
"AndroidDeviceCatalog": {
- "description": "The currently supported Android devices.",
- "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",
@@ -1159,11 +1079,21 @@
"runtimeConfiguration": {
"description": "The set of supported runtime configurations.\n@OutputOnly",
"$ref": "AndroidRuntimeConfiguration"
+ },
+ "models": {
+ "description": "The set of supported Android device models.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "AndroidModel"
+ }
}
},
- "id": "AndroidDeviceCatalog"
+ "id": "AndroidDeviceCatalog",
+ "description": "The currently supported Android devices.",
+ "type": "object"
},
"AndroidDeviceList": {
+ "id": "AndroidDeviceList",
"description": "A list of Android device configurations in which the test is to be executed.",
"type": "object",
"properties": {
@@ -1174,41 +1104,40 @@
"$ref": "AndroidDevice"
}
}
- },
- "id": "AndroidDeviceList"
+ }
},
"ClientInfo": {
+ "id": "ClientInfo",
+ "description": "Information about the client which invoked the test.",
+ "type": "object",
"properties": {
- "name": {
- "description": "Client name, such as gcloud.\nRequired",
- "type": "string"
- },
"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",
- "description": "Information about the client which invoked the test.",
- "type": "object"
+ }
},
"EnvironmentMatrix": {
+ "description": "The matrix of environments in which the test is to be executed.",
+ "type": "object",
"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"
+ "$ref": "AndroidMatrix",
+ "description": "A matrix of Android devices."
}
},
- "id": "EnvironmentMatrix",
- "description": "The matrix of environments in which the test is to be executed.",
- "type": "object"
+ "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`.",
@@ -1233,6 +1162,9 @@
"id": "Date"
},
"CancelTestMatrixResponse": {
+ "id": "CancelTestMatrixResponse",
+ "description": "Response containing the current state of the specified test matrix.",
+ "type": "object",
"properties": {
"testState": {
"enum": [
@@ -1264,10 +1196,7 @@
"The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
]
}
- },
- "id": "CancelTestMatrixResponse",
- "description": "Response containing the current state of the specified test matrix.",
- "type": "object"
+ }
},
"RoboStartingIntent": {
"description": "Message for specifying the start activities to crawl",
@@ -1283,7 +1212,13 @@
"id": "RoboStartingIntent"
},
"StartActivityIntent": {
+ "description": "A starting intent specified by an action, uri, and categories.",
+ "type": "object",
"properties": {
+ "action": {
+ "description": "Action name.\nRequired for START_ACTIVITY.",
+ "type": "string"
+ },
"uri": {
"description": "URI for the action.\nOptional.",
"type": "string"
@@ -1294,15 +1229,9 @@
"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"
+ "id": "StartActivityIntent"
},
"Account": {
"properties": {
@@ -1316,6 +1245,8 @@
"type": "object"
},
"TestEnvironmentCatalog": {
+ "description": "A description of a test environment.",
+ "type": "object",
"properties": {
"androidDeviceCatalog": {
"$ref": "AndroidDeviceCatalog",
@@ -1326,14 +1257,17 @@
"description": "Supported network configurations"
}
},
- "id": "TestEnvironmentCatalog",
- "description": "A description of a test environment.",
- "type": "object"
+ "id": "TestEnvironmentCatalog"
},
"Locale": {
+ "id": "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"
@@ -1348,33 +1282,90 @@
"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"
+ }
},
"ObbFile": {
+ "description": "An opaque binary blob file to install on the device before the test starts",
+ "type": "object",
"properties": {
"obb": {
- "$ref": "FileReference",
- "description": "Opaque Binary Blob (OBB) file(s) to install on the device\nRequired"
+ "description": "Opaque Binary Blob (OBB) file(s) to install on the device\nRequired",
+ "$ref": "FileReference"
},
"obbFileName": {
"description": "OBB file name which must conform to the format as specified by\nAndroid\ne.g. [main|patch].0300110.com.example.android.obb\nwhich will be installed into\n \u003cshared-storage\u003e/Android/obb/\u003cpackage-name\u003e/\non the device\nRequired",
"type": "string"
}
},
- "id": "ObbFile",
- "description": "An opaque binary blob file to install on the device before the test starts",
- "type": "object"
+ "id": "ObbFile"
+ },
+ "AndroidRuntimeConfiguration": {
+ "id": "AndroidRuntimeConfiguration",
+ "description": "Configuration that can be selected at the time a test is run.",
+ "type": "object",
+ "properties": {
+ "orientations": {
+ "description": "The set of available orientations.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "Orientation"
+ }
+ },
+ "locales": {
+ "description": "The set of available locales.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "Locale"
+ }
+ }
+ }
+ },
+ "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": {
+ "id": "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"
+ }
+ }
}
},
"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",
@@ -1393,5 +1384,14 @@
},
"kind": "discovery#restDescription",
"description": "Allows developers to run automated tests for their mobile applications on Google infrastructure.",
- "servicePath": ""
+ "servicePath": "",
+ "rootUrl": "https://testing.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "testing",
+ "batchPath": "batch",
+ "revision": "20180126",
+ "documentationLink": "https://developers.google.com/cloud-test-lab/",
+ "id": "testing:v1",
+ "title": "Google Cloud Testing API"
}
diff --git a/tpu/v1alpha1/tpu-api.json b/tpu/v1alpha1/tpu-api.json
index 5903a3b..fbbda62 100644
--- a/tpu/v1alpha1/tpu-api.json
+++ b/tpu/v1alpha1/tpu-api.json
@@ -1,4 +1,384 @@
{
+ "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": {
+ "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"
+ },
+ "ListTensorFlowVersionsResponse": {
+ "description": "Response for ListTensorFlowVersions.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The next page token or empty if none.",
+ "type": "string"
+ },
+ "tensorflowVersions": {
+ "description": "The listed nodes.",
+ "type": "array",
+ "items": {
+ "$ref": "TensorFlowVersion"
+ }
+ }
+ },
+ "id": "ListTensorFlowVersionsResponse"
+ },
+ "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": {
+ "locationId": {
+ "description": "The canonical id for this location. For example: `\"us-east1\"`.",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object"
+ },
+ "labels": {
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
+ "type": "string"
+ }
+ },
+ "id": "Location"
+ },
+ "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"
+ },
+ "StartNodeRequest": {
+ "description": "Request for StartNode.",
+ "type": "object",
+ "properties": {},
+ "id": "StartNodeRequest"
+ },
+ "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",
+ "type": "string"
+ },
+ "statusDetail": {
+ "description": "[Output only] Human-readable status of the operation, if any.",
+ "type": "string"
+ },
+ "apiVersion": {
+ "description": "[Output only] API version used to start the operation.",
+ "type": "string"
+ },
+ "target": {
+ "description": "[Output only] Server-defined resource path for the target of the operation.",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadata"
+ },
+ "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"
+ },
+ "ResetNodeRequest": {
+ "description": "Request for ResetNode.",
+ "type": "object",
+ "properties": {},
+ "id": "ResetNodeRequest"
+ },
+ "Node": {
+ "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 Compute Engine 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 Compute Engine network inside of the project on which this API\nhas been activated. If none is provided, \"default\" will be used.",
+ "type": "string"
+ },
+ "health": {
+ "description": "The health status of the TPU node.",
+ "type": "string",
+ "enumDescriptions": [
+ "Health status is unknown: not initialized or failed to retrieve.",
+ "The resource is healthy.",
+ "The resource is unhealthy.",
+ "The resource is unresponsive."
+ ],
+ "enum": [
+ "HEALTH_UNSPECIFIED",
+ "HEALTHY",
+ "UNHEALTHY",
+ "TIMEOUT"
+ ]
+ },
+ "ipAddress": {
+ "description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network address for the TPU Node as visible to Compute Engine\ninstances.",
+ "type": "string"
+ },
+ "cidrBlock": {
+ "description": "The CIDR block that the TPU node will use when selecting an IP address.\nThis CIDR block must be a /29 block; the Compute Engine networks API\nforbids a smaller block, and using a larger block would be wasteful (a\nnode can only consume one IP address). Errors will occur if the CIDR block\nhas already been used for a currently existing TPU node, the CIDR block\nconflicts with any subnetworks in the user's provided network, or the\nprovided network is peered with another network that is using that CIDR\nblock.\nRequired.",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "Output only.\nThe time when the node was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Resource labels to represent user-provided metadata.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "tensorflowVersion": {
+ "description": "The version of Tensorflow running in the Node.\nRequired.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The user-supplied description of the TPU. Maximum of 512 characters.",
+ "type": "string"
+ },
+ "networkEndpoints": {
+ "description": "Output only. The network endpoints where TPU workers can be accessed and sent work.\nIt is recommended that Tensorflow clients of the node reach out to the 0th\nentry in this map first.",
+ "type": "array",
+ "items": {
+ "$ref": "NetworkEndpoint"
+ }
+ },
+ "state": {
+ "enumDescriptions": [
+ "TPU node state is not known/set.",
+ "TPU node is being created.",
+ "TPU node has been created and is fully usable.",
+ "TPU node is restarting.",
+ "TPU node is undergoing reimaging.",
+ "TPU node is being deleted.",
+ "TPU node is being repaired and may be unusable. Details can be\nfound in the `help_description` field."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "CREATING",
+ "READY",
+ "RESTARTING",
+ "REIMAGING",
+ "DELETING",
+ "REPAIRING"
+ ],
+ "description": "Output only.\nThe current state for the TPU Node.",
+ "type": "string"
+ },
+ "acceleratorType": {
+ "description": "The type of hardware accelerators associated with this node.\nRequired.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only.\nThe immutable name of the TPU",
+ "type": "string"
+ }
+ },
+ "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.",
+ "type": "string"
+ },
+ "port": {
+ "description": "The port of this network endpoint.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "NetworkEndpoint"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "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"
+ },
+ "TensorFlowVersion": {
+ "description": "A tensorflow version that a Node can be configured with.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The resource name.",
+ "type": "string"
+ },
+ "version": {
+ "description": "the tensorflow version.",
+ "type": "string"
+ }
+ },
+ "id": "TensorFlowVersion"
+ },
+ "StopNodeRequest": {
+ "description": "Request for StopNode.",
+ "type": "object",
+ "properties": {},
+ "id": "StopNodeRequest"
+ }
+ },
+ "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": "TPU",
"auth": {
"oauth2": {
@@ -22,9 +402,6 @@
"locations": {
"methods": {
"list": {
- "flatPath": "v1alpha1/projects/{projectsId}/locations",
- "path": "v1alpha1/{+name}/locations",
- "id": "tpu.projects.locations.list",
"description": "Lists information about the supported locations for this service.",
"response": {
"$ref": "ListLocationsResponse"
@@ -34,6 +411,11 @@
],
"httpMethod": "GET",
"parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"required": true,
@@ -42,35 +424,33 @@
"location": "path"
},
"pageToken": {
+ "location": "query",
"description": "The standard list page token.",
- "type": "string",
- "location": "query"
+ "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": "v1alpha1/projects/{projectsId}/locations",
+ "path": "v1alpha1/{+name}/locations",
+ "id": "tpu.projects.locations.list"
},
"get": {
"description": "Get information about a location.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Location"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -84,40 +464,43 @@
}
},
"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}",
- "id": "tpu.projects.locations.get",
- "path": "v1alpha1/{+name}"
+ "path": "v1alpha1/{+name}",
+ "id": "tpu.projects.locations.get"
}
},
"resources": {
"tensorflowVersions": {
"methods": {
"list": {
- "response": {
- "$ref": "ListTensorFlowVersionsResponse"
- },
+ "description": "Lists TensorFlow versions supported by this API.",
+ "httpMethod": "GET",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "ListTensorFlowVersionsResponse"
+ },
"parameters": {
+ "filter": {
+ "location": "query",
+ "description": "List filter.",
+ "type": "string"
+ },
"pageToken": {
"location": "query",
"description": "The next_page_token value returned from a previous List request, if any.",
"type": "string"
},
"orderBy": {
- "location": "query",
"description": "Sort results.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
- "location": "query",
"description": "The maximum number of items to return.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"parent": {
"description": "The parent resource name.",
@@ -125,19 +508,19 @@
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path"
- },
- "filter": {
- "location": "query",
- "description": "List filter.",
- "type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/tensorflowVersions",
- "path": "v1alpha1/{+parent}/tensorflowVersions",
"id": "tpu.projects.locations.tensorflowVersions.list",
- "description": "List TensorFlow versions."
+ "path": "v1alpha1/{+parent}/tensorflowVersions"
},
"get": {
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/tensorflowVersions/{tensorflowVersionsId}",
+ "path": "v1alpha1/{+name}",
+ "id": "tpu.projects.locations.tensorflowVersions.get",
"description": "Gets TensorFlow Version.",
"response": {
"$ref": "TensorFlowVersion"
@@ -146,35 +529,98 @@
"name"
],
"httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The resource name.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/tensorflowVersions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "list": {
+ "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/[^/]+/locations/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations",
+ "path": "v1alpha1/{+name}/operations",
+ "id": "tpu.projects.locations.operations.list",
+ "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",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/tensorflowVersions/[^/]+$",
- "location": "path",
- "description": "The resource name.",
+ "description": "The name of the operation resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/tensorflowVersions/{tensorflowVersionsId}",
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"path": "v1alpha1/{+name}",
- "id": "tpu.projects.locations.tensorflowVersions.get"
- }
- }
- },
- "operations": {
- "methods": {
+ "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."
+ },
"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"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"name": {
"location": "path",
@@ -188,8 +634,8 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
- "path": "v1alpha1/{+name}:cancel",
- "id": "tpu.projects.locations.operations.cancel"
+ "id": "tpu.projects.locations.operations.cancel",
+ "path": "v1alpha1/{+name}:cancel"
},
"delete": {
"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
@@ -203,129 +649,35 @@
"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/[^/]+/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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The name of the operation's parent resource."
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
+ "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations",
- "id": "tpu.projects.locations.operations.list",
- "path": "v1alpha1/{+name}/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": {
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$"
- }
- },
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
- "path": "v1alpha1/{+name}",
- "id": "tpu.projects.locations.operations.get"
+ ]
}
}
},
"nodes": {
"methods": {
- "stop": {
- "request": {
- "$ref": "StopNodeRequest"
+ "get": {
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}",
+ "path": "v1alpha1/{+name}",
+ "id": "tpu.projects.locations.nodes.get",
+ "description": "Gets the details of a node.",
+ "response": {
+ "$ref": "Node"
},
- "description": "Stops a node.",
- "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "response": {
- "$ref": "Operation"
- },
- "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}:stop",
- "id": "tpu.projects.locations.nodes.stop",
- "path": "v1alpha1/{+name}:stop"
- },
- "start": {
- "request": {
- "$ref": "StartNodeRequest"
- },
- "description": "Start a node.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "GET",
"parameters": {
"name": {
"location": "path",
@@ -337,22 +689,48 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:start",
- "id": "tpu.projects.locations.nodes.start",
- "path": "v1alpha1/{+name}:start"
+ ]
},
- "delete": {
- "path": "v1alpha1/{+name}",
- "id": "tpu.projects.locations.nodes.delete",
- "description": "Deletes a node.",
+ "stop": {
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:stop",
+ "path": "v1alpha1/{+name}:stop",
+ "id": "tpu.projects.locations.nodes.stop",
+ "description": "Stops a node.",
+ "request": {
+ "$ref": "StopNodeRequest"
+ },
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "start": {
+ "description": "Starts a node.",
+ "request": {
+ "$ref": "StartNodeRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -365,19 +743,18 @@
"location": "path"
}
},
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}"
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:start",
+ "path": "v1alpha1/{+name}:start",
+ "id": "tpu.projects.locations.nodes.start"
},
- "reset": {
- "response": {
- "$ref": "Operation"
- },
+ "delete": {
+ "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"name": {
"location": "path",
@@ -387,13 +764,41 @@
"pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$"
}
},
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:reset",
- "path": "v1alpha1/{+name}:reset",
- "id": "tpu.projects.locations.nodes.reset",
- "description": "Resets a node, which stops and starts the VM.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}",
+ "id": "tpu.projects.locations.nodes.delete",
+ "path": "v1alpha1/{+name}",
+ "description": "Deletes a node."
+ },
+ "reset": {
"request": {
"$ref": "ResetNodeRequest"
- }
+ },
+ "description": "Resets a node, which stops and starts the VM.",
+ "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"
},
"list": {
"description": "Lists nodes.",
@@ -404,118 +809,93 @@
"parent"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
+ "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"
+ "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"
- },
- "pageSize": {
- "description": "The maximum number of items to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes",
"path": "v1alpha1/{+parent}/nodes",
"id": "tpu.projects.locations.nodes.list"
},
- "reimage": {
- "request": {
- "$ref": "ReimageNodeRequest"
- },
- "description": "Reimage a node's OS.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
+ "create": {
"response": {
"$ref": "Operation"
},
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
- "location": "path",
- "description": "The resource name."
- }
- },
- "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"
- },
- "create": {
- "request": {
- "$ref": "Node"
- },
- "description": "Creates a node.",
- "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"parameters": {
+ "nodeId": {
+ "description": "The unqualified resource name.",
+ "type": "string",
+ "location": "query"
+ },
"parent": {
+ "location": "path",
"description": "The parent resource name.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "nodeId": {
- "location": "query",
- "description": "The unqualified resource name.",
- "type": "string"
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes",
+ "path": "v1alpha1/{+parent}/nodes",
"id": "tpu.projects.locations.nodes.create",
- "path": "v1alpha1/{+parent}/nodes"
+ "request": {
+ "$ref": "Node"
+ },
+ "description": "Creates a node."
},
- "get": {
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}",
- "id": "tpu.projects.locations.nodes.get",
- "path": "v1alpha1/{+name}",
- "description": "Gets the details of a node.",
- "httpMethod": "GET",
+ "reimage": {
+ "description": "Reimages a node's OS.",
+ "request": {
+ "$ref": "ReimageNodeRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"name"
],
- "response": {
- "$ref": "Node"
- },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
+ "location": "path",
"description": "The resource name.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$"
}
},
- "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"
}
}
}
@@ -525,31 +905,21 @@
}
},
"parameters": {
- "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."
- },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
- "type": "string",
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
@@ -596,409 +966,39 @@
"type": "string"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
- "pp": {
- "type": "boolean",
- "default": "true",
+ "oauth_token": {
"location": "query",
- "description": "Pretty-print response."
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
}
},
"version": "v1alpha1",
"baseUrl": "https://tpu.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "TPU API provides customers with access to Google TPU technology.",
"servicePath": "",
+ "description": "TPU API provides customers with access to Google TPU technology.",
+ "kind": "discovery#restDescription",
"basePath": "",
"id": "tpu:v1alpha1",
"documentationLink": "https://cloud.google.com/tpu/",
- "revision": "20180123",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "OperationMetadata": {
- "type": "object",
- "properties": {
- "apiVersion": {
- "description": "[Output only] API version used to start the operation.",
- "type": "string"
- },
- "target": {
- "type": "string",
- "description": "[Output only] Server-defined resource path for the target of the operation."
- },
- "endTime": {
- "description": "[Output only] The time the operation finished running.",
- "format": "google-datetime",
- "type": "string"
- },
- "cancelRequested": {
- "type": "boolean",
- "description": "[Output only] Identifies whether the user has requested cancellation\nof the operation. Operations that have successfully been cancelled\nhave Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
- },
- "verb": {
- "description": "[Output only] Name of the verb executed by the operation.",
- "type": "string"
- },
- "createTime": {
- "type": "string",
- "description": "[Output only] The time the operation was created.",
- "format": "google-datetime"
- },
- "statusDetail": {
- "type": "string",
- "description": "[Output only] Human-readable status of the operation, if any."
- }
- },
- "id": "OperationMetadata",
- "description": "Represents the metadata of the long-running operation."
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "The standard List next-page token."
- },
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- }
- },
- "id": "ListLocationsResponse"
- },
- "ResetNodeRequest": {
- "properties": {},
- "id": "ResetNodeRequest",
- "description": "Request for ResetNode.",
- "type": "object"
- },
- "Node": {
- "description": "A TPU instance.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Output only.\nThe immutable name of the TPU",
- "type": "string"
- },
- "acceleratorType": {
- "type": "string",
- "description": "The type of hardware accelerators associated with this node.\nRequired."
- },
- "port": {
- "description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network port for the TPU Node as visible to Compute Engine 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 Compute Engine network inside of the project on which this API\nhas been activated. 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": {
- "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": {
- "type": "string",
- "description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network address for the TPU Node as visible to Compute Engine\ninstances."
- },
- "labels": {
- "description": "Resource labels to represent user-provided metadata.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "createTime": {
- "description": "Output only.\nThe time when the node was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "cidrBlock": {
- "description": "The CIDR block that the TPU node will use when selecting an IP address.\nThis CIDR block must be a /29 block; the Compute Engine networks API\nforbids a smaller block, and using a larger block would be wasteful (a\nnode can only consume one IP address). Errors will occur if the CIDR block\nhas already been used for a currently existing TPU node, the CIDR block\nconflicts with any subnetworks in the user's provided network, or the\nprovided network is peered with another network that is using that CIDR\nblock.\nRequired.",
- "type": "string"
- },
- "tensorflowVersion": {
- "description": "The version of Tensorflow running in the Node.\nRequired.",
- "type": "string"
- },
- "description": {
- "description": "The user-supplied description of the TPU. Maximum of 512 characters.",
- "type": "string"
- },
- "networkEndpoints": {
- "description": "Output only. The network endpoints where TPU workers can be accessed and sent work.\nIt is recommended that Tensorflow clients of the node reach out to the 0th\nentry in this map first.",
- "type": "array",
- "items": {
- "$ref": "NetworkEndpoint"
- }
- },
- "state": {
- "description": "Output only.\nThe current state for the TPU Node.",
- "type": "string",
- "enumDescriptions": [
- "TPU node state is not known/set.",
- "TPU node is being created.",
- "TPU node has been created and is fully usable.",
- "TPU node is restarting.",
- "TPU node is undergoing reimaging.",
- "TPU node is being deleted.",
- "TPU node is being repaired and may be unusable. Details can be\nfound in the `help_description` field."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "CREATING",
- "READY",
- "RESTARTING",
- "REIMAGING",
- "DELETING",
- "REPAIRING"
- ]
- }
- },
- "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.",
- "type": "string"
- },
- "port": {
- "description": "The port of this network endpoint.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "NetworkEndpoint"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "type": "boolean",
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable."
- }
- },
- "id": "Operation"
- },
- "StopNodeRequest": {
- "description": "Request for StopNode.",
- "type": "object",
- "properties": {},
- "id": "StopNodeRequest"
- },
- "TensorFlowVersion": {
- "description": "A tensorflow version that a Node can be configured with.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The resource name.",
- "type": "string"
- },
- "version": {
- "description": "the tensorflow version.",
- "type": "string"
- }
- },
- "id": "TensorFlowVersion"
- },
- "ListNodesResponse": {
- "id": "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"
- }
- }
- }
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "code": {
- "type": "integer",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32"
- }
- },
- "id": "Status"
- },
- "ListTensorFlowVersionsResponse": {
- "description": "Response for ListTensorFlowVersions.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The next page token or empty if none.",
- "type": "string"
- },
- "tensorflowVersions": {
- "description": "The listed nodes.",
- "type": "array",
- "items": {
- "$ref": "TensorFlowVersion"
- }
- }
- },
- "id": "ListTensorFlowVersionsResponse"
- },
- "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": {
- "type": "string",
- "description": "The version for reimage to create."
- }
- },
- "id": "ReimageNodeRequest"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "labels": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}"
- },
- "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": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object"
- }
- },
- "id": "Location"
- },
- "StartNodeRequest": {
- "description": "Request for StartNode.",
- "type": "object",
- "properties": {},
- "id": "StartNodeRequest"
- },
- "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"
- }
- },
- "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"
+ "revision": "20180127"
}
diff --git a/tpu/v1alpha1/tpu-gen.go b/tpu/v1alpha1/tpu-gen.go
index f468e5a..4e85b29 100644
--- a/tpu/v1alpha1/tpu-gen.go
+++ b/tpu/v1alpha1/tpu-gen.go
@@ -1785,7 +1785,7 @@
header_ http.Header
}
-// Reimage: Reimage a node's OS.
+// Reimage: Reimages a node's OS.
func (r *ProjectsLocationsNodesService) Reimage(name string, reimagenoderequest *ReimageNodeRequest) *ProjectsLocationsNodesReimageCall {
c := &ProjectsLocationsNodesReimageCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -1879,7 +1879,7 @@
}
return ret, nil
// {
- // "description": "Reimage a node's OS.",
+ // "description": "Reimages a node's OS.",
// "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:reimage",
// "httpMethod": "POST",
// "id": "tpu.projects.locations.nodes.reimage",
@@ -2055,7 +2055,7 @@
header_ http.Header
}
-// Start: Start a node.
+// Start: Starts a node.
func (r *ProjectsLocationsNodesService) Start(name string, startnoderequest *StartNodeRequest) *ProjectsLocationsNodesStartCall {
c := &ProjectsLocationsNodesStartCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -2149,7 +2149,7 @@
}
return ret, nil
// {
- // "description": "Start a node.",
+ // "description": "Starts a node.",
// "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:start",
// "httpMethod": "POST",
// "id": "tpu.projects.locations.nodes.start",
@@ -3093,7 +3093,7 @@
header_ http.Header
}
-// List: List TensorFlow versions.
+// List: Lists TensorFlow versions supported by this API.
func (r *ProjectsLocationsTensorflowVersionsService) List(parent string) *ProjectsLocationsTensorflowVersionsListCall {
c := &ProjectsLocationsTensorflowVersionsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.parent = parent
@@ -3220,7 +3220,7 @@
}
return ret, nil
// {
- // "description": "List TensorFlow versions.",
+ // "description": "Lists TensorFlow versions supported by this API.",
// "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/tensorflowVersions",
// "httpMethod": "GET",
// "id": "tpu.projects.locations.tensorflowVersions.list",
diff --git a/translate/v2/translate-api.json b/translate/v2/translate-api.json
index 724e193..6270b3d 100644
--- a/translate/v2/translate-api.json
+++ b/translate/v2/translate-api.json
@@ -1,289 +1,21 @@
{
- "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",
- "features": [
- "dataWrapper"
- ],
- "title": "Google Cloud Translation API",
- "ownerName": "Google",
- "resources": {
- "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": {
- "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": {
- "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"
- },
- "cid": {
- "repeated": true,
- "location": "query",
- "description": "The customization id for translate",
- "type": "string"
- },
- "target": {
- "location": "query",
- "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
- "type": "string",
- "required": true
- },
- "format": {
- "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",
- "enumDescriptions": [
- "Specifies the input is in HTML",
- "Specifies the input is in plain textual format"
- ],
- "location": "query"
- }
- },
- "path": "v2",
- "id": "language.translations.list",
- "description": "Translates input text, returning translated text."
- }
- }
- },
- "detections": {
- "methods": {
- "list": {
- "response": {
- "$ref": "DetectionsListResponse"
- },
- "parameterOrder": [
- "q"
- ],
- "httpMethod": "GET",
- "parameters": {
- "q": {
- "description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.",
- "type": "string",
- "required": true,
- "repeated": true,
- "location": "query"
- }
- },
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "model": {
- "description": "The model type for which supported languages should be returned.",
- "type": "string",
- "location": "query"
- },
- "target": {
- "description": "The language to use to return localized, human readable names of supported\nlanguages.",
- "type": "string",
- "location": "query"
- }
- },
- "id": "language.languages.list",
- "path": "v2/languages",
- "description": "Returns a list of supported languages for translation."
- }
- }
- }
- },
- "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": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "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. Overrides userIp if both are provided.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- }
- },
- "version": "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": {
"TranslationsResource": {
"type": "object",
"properties": {
+ "translatedText": {
+ "description": "Text translated into the target language.",
+ "type": "string"
+ },
"detectedSourceLanguage": {
"description": "The source language of the initial request, detected automatically, if\nno source language was passed within the initial request. If the\nsource language was passed, auto-detection of the language will not\noccur and this field will be empty.",
"type": "string"
@@ -291,16 +23,11 @@
"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"
},
"DetectionsResource": {
- "id": "DetectionsResource",
"description": "An array of languages which we detect for the given text The most likely language list first.",
"type": "array",
"items": {
@@ -320,9 +47,12 @@
"type": "string"
}
}
- }
+ },
+ "id": "DetectionsResource"
},
"TranslationsListResponse": {
+ "description": "The main language translation response message.",
+ "type": "object",
"properties": {
"translations": {
"description": "Translations contains list of translation results of given text",
@@ -332,16 +62,12 @@
}
}
},
- "id": "TranslationsListResponse",
- "description": "The main language translation response message.",
- "type": "object"
+ "id": "TranslationsListResponse"
},
"TranslateTextRequest": {
+ "description": "The main translation request message for the Cloud Translation API.",
+ "type": "object",
"properties": {
- "target": {
- "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
- "type": "string"
- },
"q": {
"description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.",
"type": "array",
@@ -360,13 +86,17 @@
"model": {
"description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
"type": "string"
+ },
+ "target": {
+ "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
+ "type": "string"
}
},
- "id": "TranslateTextRequest",
- "description": "The main translation request message for the Cloud Translation API.",
- "type": "object"
+ "id": "TranslateTextRequest"
},
"DetectLanguageRequest": {
+ "description": "The request message for language detection.",
+ "type": "object",
"properties": {
"q": {
"description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.",
@@ -376,9 +106,7 @@
}
}
},
- "id": "DetectLanguageRequest",
- "description": "The request message for language detection.",
- "type": "object"
+ "id": "DetectLanguageRequest"
},
"LanguagesResource": {
"type": "object",
@@ -419,6 +147,7 @@
"id": "GetSupportedLanguagesRequest"
},
"LanguagesListResponse": {
+ "type": "object",
"properties": {
"languages": {
"description": "List of source/target languages supported by the translation API. If target parameter is unspecified, the list is sorted by the ASCII code point order of the language code. If target parameter is specified, the list is sorted by the collation order of the language name in the target language.",
@@ -428,13 +157,284 @@
}
}
},
- "id": "LanguagesListResponse",
- "type": "object"
+ "id": "LanguagesListResponse"
}
},
+ "protocol": "rest",
"icons": {
- "x32": "https://www.google.com/images/icons/product/translate-32.png",
- "x16": "https://www.google.com/images/icons/product/translate-16.png"
+ "x16": "https://www.google.com/images/icons/product/translate-16.png",
+ "x32": "https://www.google.com/images/icons/product/translate-32.png"
},
- "protocol": "rest"
+ "canonicalName": "Translate",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-translation": {
+ "description": "Translate text from one language to another using Google Translate"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "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": {
+ "description": "Returns a list of supported languages for translation.",
+ "response": {
+ "$ref": "LanguagesListResponse"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "target": {
+ "description": "The language to use to return localized, human readable names of supported\nlanguages.",
+ "type": "string",
+ "location": "query"
+ },
+ "model": {
+ "location": "query",
+ "description": "The model type for which supported languages should be returned.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "path": "v2/languages",
+ "id": "language.languages.list"
+ }
+ }
+ },
+ "translations": {
+ "methods": {
+ "translate": {
+ "description": "Translates input text, returning translated text.",
+ "request": {
+ "$ref": "TranslateTextRequest"
+ },
+ "response": {
+ "$ref": "TranslationsListResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "path": "v2",
+ "id": "language.translations.translate"
+ },
+ "list": {
+ "path": "v2",
+ "id": "language.translations.list",
+ "description": "Translates input text, returning translated text.",
+ "response": {
+ "$ref": "TranslationsListResponse"
+ },
+ "parameterOrder": [
+ "q",
+ "target"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "q": {
+ "location": "query",
+ "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.",
+ "type": "string",
+ "required": true,
+ "repeated": true
+ },
+ "source": {
+ "location": "query",
+ "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"
+ },
+ "cid": {
+ "description": "The customization id for translate",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "target": {
+ "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
+ "type": "string",
+ "required": true,
+ "location": "query"
+ },
+ "format": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "detections": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "DetectionsListResponse"
+ },
+ "parameterOrder": [
+ "q"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "q": {
+ "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,
+ "repeated": 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"
+ }
+ }
+ }
+ }
+ },
+ "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. Overrides userIp if both are provided.",
+ "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"
+ },
+ "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"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ }
+ },
+ "version": "v2"
}
diff --git a/vault/v1/vault-api.json b/vault/v1/vault-api.json
index 7254e47..fa088be 100644
--- a/vault/v1/vault-api.json
+++ b/vault/v1/vault-api.json
@@ -1,106 +1,22 @@
{
+ "version": "v1",
+ "baseUrl": "https://vault.googleapis.com/",
+ "servicePath": "",
+ "description": "Archiving and eDiscovery for G Suite.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
"id": "vault:v1",
"documentationLink": "https://developers.google.com/vault",
"revision": "20171026",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "UndeleteMatterRequest": {
- "description": "Undelete a matter by ID.",
- "type": "object",
- "properties": {},
- "id": "UndeleteMatterRequest"
- },
- "ListHeldAccountsResponse": {
- "description": "Returns a list of held accounts for a hold.",
- "type": "object",
- "properties": {
- "accounts": {
- "description": "The held accounts on a hold.",
- "type": "array",
- "items": {
- "$ref": "HeldAccount"
- }
- }
- },
- "id": "ListHeldAccountsResponse"
- },
- "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": {
- "properties": {},
- "id": "ReopenMatterRequest",
- "description": "Reopen a matter by ID.",
- "type": "object"
- },
- "RemoveMatterPermissionsRequest": {
- "description": "Remove an account as a matter collaborator.",
- "type": "object",
- "properties": {
- "accountId": {
- "description": "The account ID.",
- "type": "string"
- }
- },
- "id": "RemoveMatterPermissionsRequest"
- },
- "MatterPermission": {
- "description": "Currently each matter only has one owner, and all others are collaborators.\nWhen an account is purged, its corresponding MatterPermission resources\ncease to exist.",
- "type": "object",
- "properties": {
- "accountId": {
- "description": "The account id, as provided by \u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.",
- "type": "string"
- },
- "role": {
- "enum": [
- "ROLE_UNSPECIFIED",
- "COLLABORATOR",
- "OWNER"
- ],
- "description": "The user's role in this matter.",
- "type": "string",
- "enumDescriptions": [
- "No role assigned.",
- "A collaborator to the matter.",
- "The owner of the matter."
- ]
- }
- },
- "id": "MatterPermission"
- },
- "ListMattersResponse": {
- "description": "Provides the list of matters.",
- "type": "object",
- "properties": {
- "matters": {
- "description": "List of matters.",
- "type": "array",
- "items": {
- "$ref": "Matter"
- }
- },
- "nextPageToken": {
- "description": "Page token to retrieve the next page of results in the list.",
- "type": "string"
- }
- },
- "id": "ListMattersResponse"
- },
"HeldMailQuery": {
- "description": "Query options for mail holds.",
- "type": "object",
"properties": {
+ "terms": {
+ "description": "The search terms for the hold.",
+ "type": "string"
+ },
"endTime": {
"description": "The end time range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
"format": "google-datetime",
@@ -110,21 +26,19 @@
"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"
+ "id": "HeldMailQuery",
+ "description": "Query options for mail holds.",
+ "type": "object"
},
"CloseMatterResponse": {
"description": "Response to a CloseMatterRequest.",
"type": "object",
"properties": {
"matter": {
- "description": "The updated matter, with state CLOSED.",
- "$ref": "Matter"
+ "$ref": "Matter",
+ "description": "The updated matter, with state CLOSED."
}
},
"id": "CloseMatterResponse"
@@ -141,6 +55,8 @@
"id": "HeldDriveQuery"
},
"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.",
@@ -157,9 +73,7 @@
"type": "string"
}
},
- "id": "HeldGroupsQuery",
- "description": "Query options for group holds.",
- "type": "object"
+ "id": "HeldGroupsQuery"
},
"HeldOrgUnit": {
"description": "A organizational unit being held in a particular hold.\nThis structure is immutable.",
@@ -181,6 +95,10 @@
"description": "Add an account with the permission specified. The role cannot be owner.\nIf an account already has a role in the matter, it will be\noverwritten.",
"type": "object",
"properties": {
+ "ccMe": {
+ "description": "Only relevant if send_emails is true.\nTrue to CC requestor in the email message.\nFalse to not CC requestor.",
+ "type": "boolean"
+ },
"sendEmails": {
"description": "True to send notification email to the added account.\nFalse to not send notification email.",
"type": "boolean"
@@ -188,10 +106,6 @@
"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"
@@ -200,9 +114,15 @@
"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"
+ },
"state": {
- "description": "The state of the matter.",
- "type": "string",
"enumDescriptions": [
"The matter has no specified state.",
"This matter is open.",
@@ -214,7 +134,9 @@
"OPEN",
"CLOSED",
"DELETED"
- ]
+ ],
+ "description": "The state of the matter.",
+ "type": "string"
},
"name": {
"description": "The name of the matter.",
@@ -226,41 +148,33 @@
"items": {
"$ref": "MatterPermission"
}
- },
- "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"
}
},
"id": "Matter"
},
"HeldAccount": {
+ "description": "An account being held in a particular hold. This structure is immutable.\nThis can be either a single user or a google group, depending on the corpus.",
+ "type": "object",
"properties": {
+ "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"
- },
- "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"
}
},
- "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"
+ "id": "HeldAccount"
},
"ReopenMatterResponse": {
"description": "Response to a ReopenMatterRequest.",
"type": "object",
"properties": {
"matter": {
- "$ref": "Matter",
- "description": "The updated matter, with state OPEN."
+ "description": "The updated matter, with state OPEN.",
+ "$ref": "Matter"
}
},
"id": "ReopenMatterResponse"
@@ -274,12 +188,12 @@
"$ref": "HeldMailQuery"
},
"groupsQuery": {
- "$ref": "HeldGroupsQuery",
- "description": "Details pertaining to Groups holds. If set, corpus must be Groups."
+ "description": "Details pertaining to Groups holds. If set, corpus must be Groups.",
+ "$ref": "HeldGroupsQuery"
},
"driveQuery": {
- "description": "Details pertaining to Drive holds. If set, corpus must be Drive.",
- "$ref": "HeldDriveQuery"
+ "$ref": "HeldDriveQuery",
+ "description": "Details pertaining to Drive holds. If set, corpus must be Drive."
}
},
"id": "CorpusQuery"
@@ -294,20 +208,14 @@
}
},
"query": {
- "description": "The corpus-specific query. If set, the corpusQuery must match corpus\ntype.",
- "$ref": "CorpusQuery"
+ "$ref": "CorpusQuery",
+ "description": "The corpus-specific query. If set, the corpusQuery must match corpus\ntype."
},
"orgUnit": {
"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": [
@@ -315,6 +223,12 @@
"Drive.",
"Mail.",
"Groups."
+ ],
+ "enum": [
+ "CORPUS_TYPE_UNSPECIFIED",
+ "DRIVE",
+ "MAIL",
+ "GROUPS"
]
},
"updateTime": {
@@ -339,19 +253,111 @@
"description": "The holds for a matter.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Page token to retrieve the next page of results in the list.\nIf this is empty, then there are no more holds to list.",
- "type": "string"
- },
"holds": {
"description": "The list of holds.",
"type": "array",
"items": {
"$ref": "Hold"
}
+ },
+ "nextPageToken": {
+ "description": "Page token to retrieve the next page of results in the list.\nIf this is empty, then there are no more holds to list.",
+ "type": "string"
}
},
"id": "ListHoldsResponse"
+ },
+ "UndeleteMatterRequest": {
+ "description": "Undelete a matter by ID.",
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteMatterRequest"
+ },
+ "ListHeldAccountsResponse": {
+ "description": "Returns a list of held accounts for a hold.",
+ "type": "object",
+ "properties": {
+ "accounts": {
+ "description": "The held accounts on a hold.",
+ "type": "array",
+ "items": {
+ "$ref": "HeldAccount"
+ }
+ }
+ },
+ "id": "ListHeldAccountsResponse"
+ },
+ "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": {
+ "description": "Close a matter by ID.",
+ "type": "object",
+ "properties": {},
+ "id": "CloseMatterRequest"
+ },
+ "ReopenMatterRequest": {
+ "description": "Reopen a matter by ID.",
+ "type": "object",
+ "properties": {},
+ "id": "ReopenMatterRequest"
+ },
+ "RemoveMatterPermissionsRequest": {
+ "properties": {
+ "accountId": {
+ "description": "The account ID.",
+ "type": "string"
+ }
+ },
+ "id": "RemoveMatterPermissionsRequest",
+ "description": "Remove an account as a matter collaborator.",
+ "type": "object"
+ },
+ "MatterPermission": {
+ "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",
+ "description": "Currently each matter only has one owner, and all others are collaborators.\nWhen an account is purged, its corresponding MatterPermission resources\ncease to exist.",
+ "type": "object"
+ },
+ "ListMattersResponse": {
+ "description": "Provides the list of matters.",
+ "type": "object",
+ "properties": {
+ "matters": {
+ "description": "List of matters.",
+ "type": "array",
+ "items": {
+ "$ref": "Matter"
+ }
+ },
+ "nextPageToken": {
+ "description": "Page token to retrieve the next page of results in the list.",
+ "type": "string"
+ }
+ },
+ "id": "ListMattersResponse"
}
},
"icons": {
@@ -381,299 +387,77 @@
"ownerName": "Google",
"resources": {
"matters": {
- "methods": {
- "create": {
- "path": "v1/matters",
- "id": "vault.matters.create",
- "request": {
- "$ref": "Matter"
- },
- "description": "Creates a new matter with the given name and description. The initial state\nis open, and the owner is the method caller. Returns the created matter\nwith default view.",
- "response": {
- "$ref": "Matter"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters"
- },
- "removePermissions": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "matterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "matterId": {
- "description": "The matter ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters/{matterId}:removePermissions",
- "path": "v1/matters/{matterId}:removePermissions",
- "id": "vault.matters.removePermissions",
- "request": {
- "$ref": "RemoveMatterPermissionsRequest"
- },
- "description": "Removes an account as a matter collaborator."
- },
- "reopen": {
- "response": {
- "$ref": "ReopenMatterResponse"
- },
- "parameterOrder": [
- "matterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "matterId": {
- "description": "The matter ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters/{matterId}:reopen",
- "path": "v1/matters/{matterId}:reopen",
- "id": "vault.matters.reopen",
- "request": {
- "$ref": "ReopenMatterRequest"
- },
- "description": "Reopens the specified matter. Returns matter with updated state."
- },
- "close": {
- "path": "v1/matters/{matterId}:close",
- "id": "vault.matters.close",
- "request": {
- "$ref": "CloseMatterRequest"
- },
- "description": "Closes the specified matter. Returns matter with updated state.",
- "response": {
- "$ref": "CloseMatterResponse"
- },
- "parameterOrder": [
- "matterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters/{matterId}:close"
- },
- "undelete": {
- "request": {
- "$ref": "UndeleteMatterRequest"
- },
- "description": "Undeletes the specified matter. Returns matter with updated state.",
- "httpMethod": "POST",
- "parameterOrder": [
- "matterId"
- ],
- "response": {
- "$ref": "Matter"
- },
- "parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters/{matterId}:undelete",
- "id": "vault.matters.undelete",
- "path": "v1/matters/{matterId}:undelete"
- },
- "get": {
- "path": "v1/matters/{matterId}",
- "id": "vault.matters.get",
- "description": "Gets the specified matter.",
- "response": {
- "$ref": "Matter"
- },
- "parameterOrder": [
- "matterId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "view": {
- "location": "query",
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "Specifies which parts of the Matter to return in the response.",
- "type": "string"
- },
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery",
- "https://www.googleapis.com/auth/ediscovery.readonly"
- ],
- "flatPath": "v1/matters/{matterId}"
- },
- "update": {
- "flatPath": "v1/matters/{matterId}",
- "id": "vault.matters.update",
- "path": "v1/matters/{matterId}",
- "request": {
- "$ref": "Matter"
- },
- "description": "Updates the specified matter.\nThis updates only the name and description of the matter, identified by\nmatter id. Changes to any other fields are ignored.\nReturns the default view of the matter.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "matterId"
- ],
- "response": {
- "$ref": "Matter"
- },
- "parameters": {
- "matterId": {
- "description": "The matter ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ]
- },
- "delete": {
- "description": "Deletes the specified matter. Returns matter with updated state.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Matter"
- },
- "parameterOrder": [
- "matterId"
- ],
- "parameters": {
- "matterId": {
- "description": "The matter ID",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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",
- "request": {
- "$ref": "AddMatterPermissionsRequest"
- },
- "description": "Adds an account as a matter collaborator.",
- "response": {
- "$ref": "MatterPermission"
- },
- "parameterOrder": [
- "matterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters/{matterId}:addPermissions"
- },
- "list": {
- "response": {
- "$ref": "ListMattersResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "state": {
- "location": "query",
- "enum": [
- "STATE_UNSPECIFIED",
- "OPEN",
- "CLOSED",
- "DELETED"
- ],
- "description": "If set, list only matters with that specific state. The default is listing\nmatters of all states.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The pagination token as returned in the response.",
- "type": "string"
- },
- "pageSize": {
- "description": "The number of matters to return in the response.\nDefault and maximum are 100.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "Specifies which parts of the matter to return in response.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery",
- "https://www.googleapis.com/auth/ediscovery.readonly"
- ],
- "flatPath": "v1/matters",
- "path": "v1/matters",
- "id": "vault.matters.list",
- "description": "Lists matters the user has access to."
- }
- },
"resources": {
"holds": {
"methods": {
+ "get": {
+ "response": {
+ "$ref": "Hold"
+ },
+ "parameterOrder": [
+ "matterId",
+ "holdId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery",
+ "https://www.googleapis.com/auth/ediscovery.readonly"
+ ],
+ "parameters": {
+ "holdId": {
+ "location": "path",
+ "description": "The hold ID.",
+ "required": true,
+ "type": "string"
+ },
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}",
+ "path": "v1/matters/{matterId}/holds/{holdId}",
+ "id": "vault.matters.holds.get",
+ "description": "Gets a hold by ID."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListHoldsResponse"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The pagination token as returned in the response.\nAn empty token means start from the beginning.",
+ "type": "string"
+ },
+ "pageSize": {
+ "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",
+ "location": "query"
+ },
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery",
+ "https://www.googleapis.com/auth/ediscovery.readonly"
+ ],
+ "flatPath": "v1/matters/{matterId}/holds",
+ "id": "vault.matters.holds.list",
+ "path": "v1/matters/{matterId}/holds",
+ "description": "Lists holds within a matter. An empty page token in ListHoldsResponse\ndenotes no more holds to list."
+ },
"update": {
"request": {
"$ref": "Hold"
@@ -709,6 +493,8 @@
"id": "vault.matters.holds.update"
},
"create": {
+ "path": "v1/matters/{matterId}/holds",
+ "id": "vault.matters.holds.create",
"description": "Creates a hold in the given matter.",
"request": {
"$ref": "Hold"
@@ -731,9 +517,7 @@
"location": "path"
}
},
- "flatPath": "v1/matters/{matterId}/holds",
- "path": "v1/matters/{matterId}/holds",
- "id": "vault.matters.holds.create"
+ "flatPath": "v1/matters/{matterId}/holds"
},
"delete": {
"response": {
@@ -745,14 +529,14 @@
],
"httpMethod": "DELETE",
"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"
@@ -765,80 +549,15 @@
"path": "v1/matters/{matterId}/holds/{holdId}",
"id": "vault.matters.holds.delete",
"description": "Removes a hold by ID. This will release any HeldAccounts on this Hold."
- },
- "get": {
- "response": {
- "$ref": "Hold"
- },
- "parameterOrder": [
- "matterId",
- "holdId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery",
- "https://www.googleapis.com/auth/ediscovery.readonly"
- ],
- "parameters": {
- "holdId": {
- "description": "The hold ID.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/matters/{matterId}/holds/{holdId}",
- "path": "v1/matters/{matterId}/holds/{holdId}",
- "id": "vault.matters.holds.get",
- "description": "Gets a hold by ID."
- },
- "list": {
- "description": "Lists holds within a matter. An empty page token in ListHoldsResponse\ndenotes no more holds to list.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListHoldsResponse"
- },
- "parameterOrder": [
- "matterId"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "The number of holds to return in the response, between 0 and 100 inclusive.\nLeaving this empty, or as 0, is the same as page_size = 100.",
- "format": "int32",
- "type": "integer"
- },
- "matterId": {
- "description": "The matter ID.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The pagination token as returned in the response.\nAn empty token means start from the beginning.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery",
- "https://www.googleapis.com/auth/ediscovery.readonly"
- ],
- "flatPath": "v1/matters/{matterId}/holds",
- "id": "vault.matters.holds.list",
- "path": "v1/matters/{matterId}/holds"
}
},
"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,22 +578,19 @@
"type": "string"
},
"accountId": {
- "location": "path",
"description": "The ID of the account to remove from the hold.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"matterId": {
- "location": "path",
"description": "The matter ID.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
- "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."
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}"
},
"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.",
@@ -891,17 +607,17 @@
"https://www.googleapis.com/auth/ediscovery.readonly"
],
"parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "required": true,
- "type": "string"
- },
"holdId": {
- "location": "path",
"description": "The hold ID.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
+ },
+ "matterId": {
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts",
@@ -909,6 +625,13 @@
"id": "vault.matters.holds.accounts.list"
},
"create": {
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts",
+ "path": "v1/matters/{matterId}/holds/{holdId}/accounts",
+ "id": "vault.matters.holds.accounts.create",
+ "request": {
+ "$ref": "HeldAccount"
+ },
+ "description": "Adds a HeldAccount to a hold. Accounts can only be added to a hold that\nhas no held_org_unit set. Attempting to add an account to an OU-based\nhold will result in an error.",
"response": {
"$ref": "HeldAccount"
},
@@ -925,35 +648,318 @@
"location": "path"
},
"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}/holds/{holdId}/accounts",
- "path": "v1/matters/{matterId}/holds/{holdId}/accounts",
- "id": "vault.matters.holds.accounts.create",
- "request": {
- "$ref": "HeldAccount"
- },
- "description": "Adds a HeldAccount to a hold. Accounts can only be added to a hold that\nhas no held_org_unit set. Attempting to add an account to an OU-based\nhold will result in an error."
+ ]
}
}
}
}
}
+ },
+ "methods": {
+ "close": {
+ "request": {
+ "$ref": "CloseMatterRequest"
+ },
+ "description": "Closes the specified matter. Returns matter with updated state.",
+ "response": {
+ "$ref": "CloseMatterResponse"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "flatPath": "v1/matters/{matterId}:close",
+ "path": "v1/matters/{matterId}:close",
+ "id": "vault.matters.close"
+ },
+ "undelete": {
+ "id": "vault.matters.undelete",
+ "path": "v1/matters/{matterId}:undelete",
+ "request": {
+ "$ref": "UndeleteMatterRequest"
+ },
+ "description": "Undeletes the specified matter. Returns matter with updated state.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "matterId"
+ ],
+ "response": {
+ "$ref": "Matter"
+ },
+ "parameters": {
+ "matterId": {
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "flatPath": "v1/matters/{matterId}:undelete"
+ },
+ "get": {
+ "path": "v1/matters/{matterId}",
+ "id": "vault.matters.get",
+ "description": "Gets the specified matter.",
+ "response": {
+ "$ref": "Matter"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Specifies which parts of the Matter to return in the response.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery",
+ "https://www.googleapis.com/auth/ediscovery.readonly"
+ ],
+ "flatPath": "v1/matters/{matterId}"
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "matterId"
+ ],
+ "response": {
+ "$ref": "Matter"
+ },
+ "parameters": {
+ "matterId": {
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "flatPath": "v1/matters/{matterId}",
+ "id": "vault.matters.update",
+ "path": "v1/matters/{matterId}",
+ "request": {
+ "$ref": "Matter"
+ },
+ "description": "Updates the specified matter.\nThis updates only the name and description of the matter, identified by\nmatter id. Changes to any other fields are ignored.\nReturns the default view of the matter."
+ },
+ "delete": {
+ "flatPath": "v1/matters/{matterId}",
+ "id": "vault.matters.delete",
+ "path": "v1/matters/{matterId}",
+ "description": "Deletes the specified matter. Returns matter with updated state.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Matter"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "parameters": {
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ]
+ },
+ "addPermissions": {
+ "response": {
+ "$ref": "MatterPermission"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "matterId": {
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "flatPath": "v1/matters/{matterId}:addPermissions",
+ "path": "v1/matters/{matterId}:addPermissions",
+ "id": "vault.matters.addPermissions",
+ "request": {
+ "$ref": "AddMatterPermissionsRequest"
+ },
+ "description": "Adds an account as a matter collaborator."
+ },
+ "list": {
+ "description": "Lists matters the user has access to.",
+ "response": {
+ "$ref": "ListMattersResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "state": {
+ "location": "query",
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "OPEN",
+ "CLOSED",
+ "DELETED"
+ ],
+ "description": "If set, list only matters with that specific state. The default is listing\nmatters of all states.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The pagination token as returned in the response.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The number of matters to return in the response.\nDefault and maximum are 100.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Specifies which parts of the matter to return in response.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery",
+ "https://www.googleapis.com/auth/ediscovery.readonly"
+ ],
+ "flatPath": "v1/matters",
+ "path": "v1/matters",
+ "id": "vault.matters.list"
+ },
+ "create": {
+ "request": {
+ "$ref": "Matter"
+ },
+ "description": "Creates a new matter with the given name and description. The initial state\nis open, and the owner is the method caller. Returns the created matter\nwith default view.",
+ "response": {
+ "$ref": "Matter"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "flatPath": "v1/matters",
+ "path": "v1/matters",
+ "id": "vault.matters.create"
+ },
+ "removePermissions": {
+ "flatPath": "v1/matters/{matterId}:removePermissions",
+ "path": "v1/matters/{matterId}:removePermissions",
+ "id": "vault.matters.removePermissions",
+ "request": {
+ "$ref": "RemoveMatterPermissionsRequest"
+ },
+ "description": "Removes an account as a matter collaborator.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ]
+ },
+ "reopen": {
+ "flatPath": "v1/matters/{matterId}:reopen",
+ "path": "v1/matters/{matterId}:reopen",
+ "id": "vault.matters.reopen",
+ "request": {
+ "$ref": "ReopenMatterRequest"
+ },
+ "description": "Reopens the specified matter. Returns matter with updated state.",
+ "response": {
+ "$ref": "ReopenMatterResponse"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "matterId": {
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ]
+ }
}
}
},
"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",
- "location": "query"
+ "type": "string"
},
"access_token": {
"location": "query",
@@ -982,15 +988,15 @@
"location": "query"
},
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
"location": "query",
@@ -998,9 +1004,9 @@
"type": "string"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"callback": {
"location": "query",
@@ -1008,19 +1014,24 @@
"type": "string"
},
"$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -1029,18 +1040,7 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "default": "json"
}
- },
- "version": "v1",
- "baseUrl": "https://vault.googleapis.com/",
- "servicePath": "",
- "description": "Archiving and eDiscovery for G Suite.",
- "kind": "discovery#restDescription",
- "basePath": ""
+ }
}
diff --git a/videointelligence/v1beta1/videointelligence-api.json b/videointelligence/v1beta1/videointelligence-api.json
index 58702a9..b603965 100644
--- a/videointelligence/v1beta1/videointelligence-api.json
+++ b/videointelligence/v1beta1/videointelligence-api.json
@@ -1,4 +1,117 @@
{
+ "ownerName": "Google",
+ "resources": {
+ "videos": {
+ "methods": {
+ "annotate": {
+ "request": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest"
+ },
+ "description": "Performs asynchronous video annotation. Progress and results can be\nretrieved through the `google.longrunning.Operations` interface.\n`Operation.metadata` contains `AnnotateVideoProgress` (progress).\n`Operation.response` contains `AnnotateVideoResponse` (results).",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "GoogleLongrunning_Operation"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/videos:annotate",
+ "id": "videointelligence.videos.annotate",
+ "path": "v1beta1/videos:annotate"
+ }
+ }
+ }
+ },
+ "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": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "key": {
+ "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": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
"version": "v1beta1",
"baseUrl": "https://videointelligence.googleapis.com/",
"kind": "discovery#restDescription",
@@ -11,10 +124,28 @@
"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": {
+ "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.",
@@ -28,8 +159,8 @@
"type": "string"
},
"error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "GoogleRpc_Status"
+ "$ref": "GoogleRpc_Status",
+ "description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
@@ -38,10 +169,6 @@
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
}
},
"id": "GoogleLongrunning_Operation"
@@ -50,10 +177,6 @@
"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",
@@ -68,14 +191,23 @@
"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"
@@ -97,20 +229,13 @@
"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"
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults",
+ "description": "Annotation results for a single video.",
+ "type": "object"
},
"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`.",
@@ -120,23 +245,9 @@
}
}
},
- "id": "GoogleCloudVideointelligenceV1_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"
+ "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.",
@@ -152,8 +263,30 @@
},
"id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse"
},
- "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress": {
+ "GoogleCloudVideointelligenceV1_LabelSegment": {
"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",
+ "description": "Video segment level annotation results for label detection.",
+ "type": "object"
+ },
+ "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",
@@ -168,15 +301,9 @@
"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": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress",
- "description": "Annotation progress for a single video.",
- "type": "object"
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress"
},
"GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame": {
"description": "Video frame level annotation results for explicit content.",
@@ -214,33 +341,6 @@
"description": "Video annotation request.",
"type": "object",
"properties": {
- "features": {
- "description": "Requested video annotation features.",
- "type": "array",
- "items": {
- "enum": [
- "FEATURE_UNSPECIFIED",
- "LABEL_DETECTION",
- "SHOT_CHANGE_DETECTION",
- "SAFE_SEARCH_DETECTION"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "Unspecified.",
- "Label detection. Detect objects, such as dog or flower.",
- "Shot change detection.",
- "Safe search detection."
- ]
- },
- "outputUri": {
- "description": "Optional location where the output (in JSON format) should be stored.\nCurrently, only [Google Cloud Storage](https://cloud.google.com/storage/)\nURIs are supported, which must be specified in the following format:\n`gs://bucket-id/object-id` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](/storage/docs/reference-uris).",
- "type": "string"
- },
- "videoContext": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_VideoContext",
- "description": "Additional video context and/or feature-specific parameters."
- },
"locationId": {
"description": "Optional cloud region where annotation should take place. Supported cloud\nregions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region\nis specified, a region will be determined based on video file location.",
"type": "string"
@@ -252,6 +352,33 @@
"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"
}
},
"id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest"
@@ -277,14 +404,14 @@
"description": "Video segment level annotation results for label detection.",
"type": "object",
"properties": {
- "segment": {
- "description": "Video segment where a label was detected.",
- "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment"
- },
"confidence": {
"description": "Confidence that the label is accurate. Range: [0, 1].",
"format": "float",
"type": "number"
+ },
+ "segment": {
+ "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment",
+ "description": "Video segment where a label was detected."
}
},
"id": "GoogleCloudVideointelligenceV1beta2_LabelSegment"
@@ -293,6 +420,13 @@
"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": {
"$ref": "GoogleCloudVideointelligenceV1beta2_Entity",
"description": "Detected entity."
@@ -310,21 +444,92 @@
"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"
},
"GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation": {
- "description": "Safe search annotation (based on per-frame visual signals only).\nIf no unsafe content has been detected in a frame, no annotations\nare present for that frame. If only some types of unsafe content\nhave been detected in a frame, the likelihood is set to `UNKNOWN`\nfor all other types of unsafe content.",
- "type": "object",
"properties": {
+ "violent": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood of violent content.",
+ "type": "string"
+ },
+ "spoof": {
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood that an obvious modification was made to the original\nversion to make it appear funny or offensive.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ]
+ },
+ "medical": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood of medical content.",
+ "type": "string"
+ },
+ "adult": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood of adult content.",
+ "type": "string"
+ },
"racy": {
"enumDescriptions": [
"Unknown likelihood.",
@@ -349,89 +554,11 @@
"description": "Video time offset in microseconds.",
"format": "int64",
"type": "string"
- },
- "spoof": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Likelihood that an obvious modification was made to the original\nversion to make it appear funny or offensive.",
- "type": "string"
- },
- "violent": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Likelihood of violent content.",
- "type": "string"
- },
- "medical": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Likelihood of medical content.",
- "type": "string"
- },
- "adult": {
- "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"
- ]
}
},
- "id": "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation"
+ "id": "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation",
+ "description": "Safe search annotation (based on per-frame visual signals only).\nIf no unsafe content has been detected in a frame, no annotations\nare present for that frame. If only some types of unsafe content\nhave been detected in a frame, the likelihood is set to `UNKNOWN`\nfor all other types of unsafe content.",
+ "type": "object"
},
"GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress": {
"properties": {
@@ -448,30 +575,7 @@
"type": "object"
},
"GoogleCloudVideointelligenceV1_Entity": {
- "description": "Detected entity from video analysis.",
- "type": "object",
"properties": {
- "languageCode": {
- "description": "Language code for `description` in BCP-47 format.",
- "type": "string"
- },
- "entityId": {
- "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).",
- "type": "string"
- },
- "description": {
- "description": "Textual description, e.g. `Fixed-gear bicycle`.",
- "type": "string"
- }
- },
- "id": "GoogleCloudVideointelligenceV1_Entity"
- },
- "GoogleCloudVideointelligenceV1beta2_Entity": {
- "properties": {
- "entityId": {
- "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).",
- "type": "string"
- },
"description": {
"description": "Textual description, e.g. `Fixed-gear bicycle`.",
"type": "string"
@@ -479,13 +583,38 @@
"languageCode": {
"description": "Language code for `description` in BCP-47 format.",
"type": "string"
+ },
+ "entityId": {
+ "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).",
+ "type": "string"
}
},
- "id": "GoogleCloudVideointelligenceV1beta2_Entity",
+ "id": "GoogleCloudVideointelligenceV1_Entity",
"description": "Detected entity from video analysis.",
"type": "object"
},
+ "GoogleCloudVideointelligenceV1beta2_Entity": {
+ "description": "Detected entity from video analysis.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Textual description, e.g. `Fixed-gear bicycle`.",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "Language code for `description` in BCP-47 format.",
+ "type": "string"
+ },
+ "entityId": {
+ "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta2_Entity"
+ },
"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).",
@@ -498,14 +627,19 @@
"type": "string"
}
},
- "id": "GoogleCloudVideointelligenceV1beta2_VideoSegment",
- "description": "Video segment.",
- "type": "object"
+ "id": "GoogleCloudVideointelligenceV1beta2_VideoSegment"
},
"GoogleCloudVideointelligenceV1_VideoAnnotationResults": {
"description": "Annotation results for a single video.",
"type": "object",
"properties": {
+ "shotLabelAnnotations": {
+ "description": "Label annotations on shot level.\nThere is exactly one element for each unique label.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1_LabelAnnotation"
+ }
+ },
"error": {
"$ref": "GoogleRpc_Status",
"description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail."
@@ -521,6 +655,10 @@
"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",
@@ -528,23 +666,12 @@
"$ref": "GoogleCloudVideointelligenceV1_LabelAnnotation"
}
},
- "explicitAnnotation": {
- "description": "Explicit content annotation.",
- "$ref": "GoogleCloudVideointelligenceV1_ExplicitContentAnnotation"
- },
"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",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1_LabelAnnotation"
- }
}
},
"id": "GoogleCloudVideointelligenceV1_VideoAnnotationResults"
@@ -564,13 +691,7 @@
"type": "object"
},
"GoogleCloudVideointelligenceV1beta1_LabelAnnotation": {
- "description": "Label annotation.",
- "type": "object",
"properties": {
- "languageCode": {
- "description": "Language code for `description` in BCP-47 format.",
- "type": "string"
- },
"description": {
"description": "Textual description, e.g. `Fixed-gear bicycle`.",
"type": "string"
@@ -581,53 +702,23 @@
"items": {
"$ref": "GoogleCloudVideointelligenceV1beta1_LabelLocation"
}
+ },
+ "languageCode": {
+ "description": "Language code for `description` in BCP-47 format.",
+ "type": "string"
}
},
- "id": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation"
- },
- "GoogleCloudVideointelligenceV1_LabelAnnotation": {
+ "id": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation",
"description": "Label annotation.",
- "type": "object",
- "properties": {
- "segments": {
- "description": "All video segments where a label was detected.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1_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": "GoogleCloudVideointelligenceV1_Entity"
- }
- },
- "entity": {
- "description": "Detected entity.",
- "$ref": "GoogleCloudVideointelligenceV1_Entity"
- },
- "frames": {
- "description": "All video frames where a label was detected.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1_LabelFrame"
- }
- }
- },
- "id": "GoogleCloudVideointelligenceV1_LabelAnnotation"
+ "type": "object"
},
"GoogleCloudVideointelligenceV1beta1_VideoContext": {
- "description": "Video context and/or feature-specific parameters.",
- "type": "object",
"properties": {
+ "shotChangeDetectionModel": {
+ "description": "Model to use for shot change detection.\nSupported values: \"latest\" and \"stable\" (the default).",
+ "type": "string"
+ },
"labelDetectionMode": {
- "enum": [
- "LABEL_DETECTION_MODE_UNSPECIFIED",
- "SHOT_MODE",
- "FRAME_MODE",
- "SHOT_AND_FRAME_MODE"
- ],
"description": "If label detection has been requested, what labels should be detected\nin addition to video-level labels or segment-level labels. If unspecified,\ndefaults to `SHOT_MODE`.",
"type": "string",
"enumDescriptions": [
@@ -635,6 +726,12 @@
"Detect shot-level labels.",
"Detect frame-level labels.",
"Detect both shot-level and frame-level labels."
+ ],
+ "enum": [
+ "LABEL_DETECTION_MODE_UNSPECIFIED",
+ "SHOT_MODE",
+ "FRAME_MODE",
+ "SHOT_AND_FRAME_MODE"
]
},
"stationaryCamera": {
@@ -655,27 +752,46 @@
"labelDetectionModel": {
"description": "Model to use for label detection.\nSupported values: \"latest\" and \"stable\" (the default).",
"type": "string"
- },
- "shotChangeDetectionModel": {
- "description": "Model to use for shot change detection.\nSupported values: \"latest\" and \"stable\" (the default).",
- "type": "string"
}
},
- "id": "GoogleCloudVideointelligenceV1beta1_VideoContext"
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoContext",
+ "description": "Video context and/or feature-specific parameters.",
+ "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.",
+ "GoogleCloudVideointelligenceV1_LabelAnnotation": {
+ "description": "Label annotation.",
"type": "object",
"properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
+ "entity": {
+ "description": "Detected entity.",
+ "$ref": "GoogleCloudVideointelligenceV1_Entity"
},
- "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"
+ "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",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1_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": "GoogleCloudVideointelligenceV1_Entity"
+ }
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1_LabelAnnotation"
+ },
+ "GoogleRpc_Status": {
+ "properties": {
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
@@ -686,9 +802,20 @@
},
"type": "object"
}
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
- "id": "GoogleRpc_Status"
+ "id": "GoogleRpc_Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
},
"GoogleCloudVideointelligenceV1_VideoSegment": {
"properties": {
@@ -708,8 +835,6 @@
"type": "object"
},
"GoogleCloudVideointelligenceV1_LabelFrame": {
- "description": "Video frame level annotation results for label detection.",
- "type": "object",
"properties": {
"confidence": {
"description": "Confidence that the label is accurate. Range: [0, 1].",
@@ -722,29 +847,15 @@
"type": "string"
}
},
- "id": "GoogleCloudVideointelligenceV1_LabelFrame"
+ "id": "GoogleCloudVideointelligenceV1_LabelFrame",
+ "description": "Video frame level annotation results for label detection.",
+ "type": "object"
},
"GoogleCloudVideointelligenceV1beta2_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": "GoogleCloudVideointelligenceV1beta2_VideoSegment"
- }
- },
- "shotLabelAnnotations": {
- "description": "Label annotations on shot level.\nThere is exactly one element for each unique label.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1beta2_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"
+ "$ref": "GoogleRpc_Status",
+ "description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail."
},
"frameLabelAnnotations": {
"description": "Label annotations on frame level.\nThere is exactly one element for each unique label.",
@@ -758,8 +869,8 @@
"type": "string"
},
"explicitAnnotation": {
- "$ref": "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation",
- "description": "Explicit content annotation."
+ "description": "Explicit content annotation.",
+ "$ref": "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation"
},
"segmentLabelAnnotations": {
"description": "Label annotations on video level or user specified segment level.\nThere is exactly one element for each unique label.",
@@ -767,11 +878,29 @@
"items": {
"$ref": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation"
}
+ },
+ "shotAnnotations": {
+ "description": "Shot annotations. Each shot is represented as a video segment.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment"
+ }
+ },
+ "shotLabelAnnotations": {
+ "description": "Label annotations on shot level.\nThere is exactly one element for each unique label.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation"
+ }
}
},
- "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults"
+ "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults",
+ "description": "Annotation results for a single video.",
+ "type": "object"
},
"GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation": {
+ "description": "Explicit content annotation (based on per-frame visual signals only).\nIf no explicit content has been detected in a frame, no annotations are\npresent for that frame.",
+ "type": "object",
"properties": {
"frames": {
"description": "All video frames where explicit content was detected.",
@@ -781,18 +910,12 @@
}
}
},
- "id": "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation",
- "description": "Explicit content annotation (based on per-frame visual signals only).\nIf no explicit content has been detected in a frame, no annotations are\npresent for that frame.",
- "type": "object"
+ "id": "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation"
},
"GoogleCloudVideointelligenceV1beta1_LabelLocation": {
"description": "Label location.",
"type": "object",
"properties": {
- "segment": {
- "description": "Video segment. Set to [-1, -1] for video-level labels.\nSet to [timestamp, timestamp] for frame-level labels.\nOtherwise, corresponds to one of `AnnotateSpec.segments`\n(if specified) or to shot boundaries (if requested).",
- "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
- },
"level": {
"enumDescriptions": [
"Unspecified.",
@@ -815,11 +938,17 @@
"description": "Confidence that the label is accurate. Range: [0, 1].",
"format": "float",
"type": "number"
+ },
+ "segment": {
+ "$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)."
}
},
"id": "GoogleCloudVideointelligenceV1beta1_LabelLocation"
},
"GoogleCloudVideointelligenceV1beta2_LabelFrame": {
+ "description": "Video frame level annotation results for label detection.",
+ "type": "object",
"properties": {
"confidence": {
"description": "Confidence that the label is accurate. Range: [0, 1].",
@@ -832,11 +961,11 @@
"type": "string"
}
},
- "id": "GoogleCloudVideointelligenceV1beta2_LabelFrame",
- "description": "Video frame level annotation results for label detection.",
- "type": "object"
+ "id": "GoogleCloudVideointelligenceV1beta2_LabelFrame"
},
"GoogleCloudVideointelligenceV1_ExplicitContentFrame": {
+ "description": "Video frame level annotation results for explicit content.",
+ "type": "object",
"properties": {
"pornographyLikelihood": {
"enum": [
@@ -864,13 +993,9 @@
"type": "string"
}
},
- "id": "GoogleCloudVideointelligenceV1_ExplicitContentFrame",
- "description": "Video frame level annotation results for explicit content.",
- "type": "object"
+ "id": "GoogleCloudVideointelligenceV1_ExplicitContentFrame"
},
"GoogleCloudVideointelligenceV1_ExplicitContentAnnotation": {
- "description": "Explicit content annotation (based on per-frame visual signals only).\nIf no explicit content has been detected in a frame, no annotations are\npresent for that frame.",
- "type": "object",
"properties": {
"frames": {
"description": "All video frames where explicit content was detected.",
@@ -880,7 +1005,9 @@
}
}
},
- "id": "GoogleCloudVideointelligenceV1_ExplicitContentAnnotation"
+ "id": "GoogleCloudVideointelligenceV1_ExplicitContentAnnotation",
+ "description": "Explicit content annotation (based on per-frame visual signals only).\nIf no explicit content has been detected in a frame, no annotations are\npresent for that frame.",
+ "type": "object"
},
"GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress": {
"description": "Video annotation progress. Included in the `metadata`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
@@ -897,13 +1024,7 @@
"id": "GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress"
},
"GoogleCloudVideointelligenceV1_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",
@@ -918,29 +1039,21 @@
"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": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress"
- },
- "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": {
- "description": "Video annotation progress. Included in the `metadata`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
- "type": "object",
- "properties": {
- "annotationProgress": {
- "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress"
- }
- }
- },
- "id": "GoogleCloudVideointelligenceV1_AnnotateVideoProgress"
+ "id": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress",
+ "description": "Annotation progress for a single video.",
+ "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 Video Intelligence",
"auth": {
@@ -957,118 +1070,5 @@
"name": "videointelligence",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Cloud Video Intelligence API",
- "ownerName": "Google",
- "resources": {
- "videos": {
- "methods": {
- "annotate": {
- "request": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest"
- },
- "description": "Performs asynchronous video annotation. Progress and results can be\nretrieved through the `google.longrunning.Operations` interface.\n`Operation.metadata` contains `AnnotateVideoProgress` (progress).\n`Operation.response` contains `AnnotateVideoResponse` (results).",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "GoogleLongrunning_Operation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/videos:annotate",
- "id": "videointelligence.videos.annotate",
- "path": "v1beta1/videos:annotate"
- }
- }
- }
- },
- "parameters": {
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.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": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "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"
- }
- }
+ "title": "Cloud Video Intelligence API"
}
diff --git a/vision/v1/vision-api.json b/vision/v1/vision-api.json
index abe9236..59a98e9 100644
--- a/vision/v1/vision-api.json
+++ b/vision/v1/vision-api.json
@@ -1,32 +1,37 @@
{
- "id": "vision:v1",
- "documentationLink": "https://cloud.google.com/vision/",
- "revision": "20180122",
- "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "CropHintsParams": {
- "description": "Parameters for crop hints annotation request.",
- "type": "object",
- "properties": {
- "aspectRatios": {
- "description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored.",
- "type": "array",
- "items": {
- "format": "float",
- "type": "number"
- }
- }
- },
- "id": "CropHintsParams"
- },
"Block": {
"description": "Logical element on the page.",
"type": "object",
"properties": {
+ "property": {
+ "description": "Additional information detected for the block.",
+ "$ref": "TextProperty"
+ },
+ "blockType": {
+ "enumDescriptions": [
+ "Unknown block type.",
+ "Regular text block.",
+ "Table block.",
+ "Image block.",
+ "Horizontal/vertical line box.",
+ "Barcode block."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "TEXT",
+ "TABLE",
+ "PICTURE",
+ "RULER",
+ "BARCODE"
+ ],
+ "description": "Detected block type (text, image etc) for this block.",
+ "type": "string"
+ },
"boundingBox": {
- "$ref": "BoundingPoly",
- "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertice order will still be (0, 1, 2, 3)."
+ "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertice order will still be (0, 1, 2, 3).",
+ "$ref": "BoundingPoly"
},
"confidence": {
"description": "Confidence of the OCR results on the block. Range [0, 1].",
@@ -39,30 +44,6 @@
"items": {
"$ref": "Paragraph"
}
- },
- "property": {
- "$ref": "TextProperty",
- "description": "Additional information detected for the block."
- },
- "blockType": {
- "enum": [
- "UNKNOWN",
- "TEXT",
- "TABLE",
- "PICTURE",
- "RULER",
- "BARCODE"
- ],
- "description": "Detected block type (text, image etc) for this block.",
- "type": "string",
- "enumDescriptions": [
- "Unknown block type.",
- "Regular text block.",
- "Table block.",
- "Image block.",
- "Horizontal/vertical line box.",
- "Barcode block."
- ]
}
},
"id": "Block"
@@ -98,35 +79,6 @@
},
"id": "LocationInfo"
},
- "ImageSource": {
- "properties": {
- "gcsImageUri": {
- "description": "**Use `image_uri` instead.**\n\nThe Google Cloud Storage URI of the form\n`gs://bucket_name/object_name`. Object versioning is not supported. See\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris) for more info.",
- "type": "string"
- },
- "imageUri": {
- "description": "The URI of the source image. Can be either:\n\n1. A Google Cloud Storage URI of the form\n `gs://bucket_name/object_name`. Object versioning is not supported. See\n [Google Cloud Storage Request\n URIs](https://cloud.google.com/storage/docs/reference-uris) for more\n info.\n\n2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from\n HTTP/HTTPS URLs, Google cannot guarantee that the request will be\n completed. Your request may fail if the specified host denies the\n request (e.g. due to request throttling or DOS prevention), or if Google\n throttles requests to the site for abuse prevention. You should not\n depend on externally-hosted images for production applications.\n\nWhen both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence.",
- "type": "string"
- }
- },
- "id": "ImageSource",
- "description": "External image source (Google Cloud Storage or web URL image location).",
- "type": "object"
- },
- "BatchAnnotateImagesResponse": {
- "description": "Response to a batch image annotation request.",
- "type": "object",
- "properties": {
- "responses": {
- "description": "Individual responses to image annotation requests within the batch.",
- "type": "array",
- "items": {
- "$ref": "AnnotateImageResponse"
- }
- }
- },
- "id": "BatchAnnotateImagesResponse"
- },
"WebDetection": {
"description": "Relevant information for the image from the Internet.",
"type": "object",
@@ -176,10 +128,44 @@
},
"id": "WebDetection"
},
+ "BatchAnnotateImagesResponse": {
+ "description": "Response to a batch image annotation request.",
+ "type": "object",
+ "properties": {
+ "responses": {
+ "description": "Individual responses to image annotation requests within the batch.",
+ "type": "array",
+ "items": {
+ "$ref": "AnnotateImageResponse"
+ }
+ }
+ },
+ "id": "BatchAnnotateImagesResponse"
+ },
+ "ImageSource": {
+ "description": "External image source (Google Cloud Storage or web URL image location).",
+ "type": "object",
+ "properties": {
+ "gcsImageUri": {
+ "description": "**Use `image_uri` instead.**\n\nThe Google Cloud Storage URI of the form\n`gs://bucket_name/object_name`. Object versioning is not supported. See\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris) for more info.",
+ "type": "string"
+ },
+ "imageUri": {
+ "description": "The URI of the source image. Can be either:\n\n1. A Google Cloud Storage URI of the form\n `gs://bucket_name/object_name`. Object versioning is not supported. See\n [Google Cloud Storage Request\n URIs](https://cloud.google.com/storage/docs/reference-uris) for more\n info.\n\n2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from\n HTTP/HTTPS URLs, Google cannot guarantee that the request will be\n completed. Your request may fail if the specified host denies the\n request (e.g. due to request throttling or DOS prevention), or if Google\n throttles requests to the site for abuse prevention. You should not\n depend on externally-hosted images for production applications.\n\nWhen both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence.",
+ "type": "string"
+ }
+ },
+ "id": "ImageSource"
+ },
"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": {
"description": "X coordinate.",
"format": "float",
@@ -189,11 +175,6 @@
"description": "Z coordinate (or depth).",
"format": "float",
"type": "number"
- },
- "y": {
- "description": "Y coordinate.",
- "format": "float",
- "type": "number"
}
},
"id": "Position"
@@ -202,36 +183,27 @@
"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",
"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].",
+ "format": "float",
+ "type": "number"
}
},
"id": "ColorInfo"
},
"WebPage": {
+ "description": "Metadata for web pages.",
+ "type": "object",
"properties": {
- "pageTitle": {
- "description": "Title for the web page, may contain HTML markups.",
- "type": "string"
- },
- "fullMatchingImages": {
- "description": "Fully matching images on the page.\nCan include resized copies of the query image.",
- "type": "array",
- "items": {
- "$ref": "WebImage"
- }
- },
"score": {
"description": "(Deprecated) Overall relevancy score for the web page.",
"format": "float",
@@ -247,16 +219,34 @@
"url": {
"description": "The result web page URL.",
"type": "string"
+ },
+ "pageTitle": {
+ "description": "Title for the web page, may contain HTML markups.",
+ "type": "string"
+ },
+ "fullMatchingImages": {
+ "description": "Fully matching images on the page.\nCan include resized copies of the query image.",
+ "type": "array",
+ "items": {
+ "$ref": "WebImage"
+ }
}
},
- "id": "WebPage",
- "description": "Metadata for web pages.",
- "type": "object"
+ "id": "WebPage"
},
"EntityAnnotation": {
"description": "Set of detected entity features.",
"type": "object",
"properties": {
+ "topicality": {
+ "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "description": {
+ "description": "Entity textual description, expressed in its `locale` language.",
+ "type": "string"
+ },
"properties": {
"description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.",
"type": "array",
@@ -290,17 +280,8 @@
"type": "string"
},
"boundingPoly": {
- "$ref": "BoundingPoly",
- "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features."
- },
- "description": {
- "description": "Entity textual description, expressed in its `locale` language.",
- "type": "string"
- },
- "topicality": {
- "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].",
- "format": "float",
- "type": "number"
+ "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features.",
+ "$ref": "BoundingPoly"
}
},
"id": "EntityAnnotation"
@@ -330,7 +311,48 @@
"description": "A face-specific landmark (for example, a face feature).",
"type": "object",
"properties": {
+ "position": {
+ "$ref": "Position",
+ "description": "Face landmark position."
+ },
"type": {
+ "enumDescriptions": [
+ "Unknown face landmark detected. Should not be filled.",
+ "Left eye.",
+ "Right eye.",
+ "Left of left eyebrow.",
+ "Right of left eyebrow.",
+ "Left of right eyebrow.",
+ "Right of right eyebrow.",
+ "Midpoint between eyes.",
+ "Nose tip.",
+ "Upper lip.",
+ "Lower lip.",
+ "Mouth left.",
+ "Mouth right.",
+ "Mouth center.",
+ "Nose, bottom right.",
+ "Nose, bottom left.",
+ "Nose, bottom center.",
+ "Left eye, top boundary.",
+ "Left eye, right corner.",
+ "Left eye, bottom boundary.",
+ "Left eye, left corner.",
+ "Right eye, top boundary.",
+ "Right eye, right corner.",
+ "Right eye, bottom boundary.",
+ "Right eye, left corner.",
+ "Left eyebrow, upper midpoint.",
+ "Right eyebrow, upper midpoint.",
+ "Left ear tragion.",
+ "Right ear tragion.",
+ "Left eye pupil.",
+ "Right eye pupil.",
+ "Forehead glabella.",
+ "Chin gnathion.",
+ "Chin left gonion.",
+ "Chin right gonion."
+ ],
"enum": [
"UNKNOWN_LANDMARK",
"LEFT_EYE",
@@ -369,48 +391,7 @@
"CHIN_RIGHT_GONION"
],
"description": "Face landmark type.",
- "type": "string",
- "enumDescriptions": [
- "Unknown face landmark detected. Should not be filled.",
- "Left eye.",
- "Right eye.",
- "Left of left eyebrow.",
- "Right of left eyebrow.",
- "Left of right eyebrow.",
- "Right of right eyebrow.",
- "Midpoint between eyes.",
- "Nose tip.",
- "Upper lip.",
- "Lower lip.",
- "Mouth left.",
- "Mouth right.",
- "Mouth center.",
- "Nose, bottom right.",
- "Nose, bottom left.",
- "Nose, bottom center.",
- "Left eye, top boundary.",
- "Left eye, right corner.",
- "Left eye, bottom boundary.",
- "Left eye, left corner.",
- "Right eye, top boundary.",
- "Right eye, right corner.",
- "Right eye, bottom boundary.",
- "Right eye, left corner.",
- "Left eyebrow, upper midpoint.",
- "Right eyebrow, upper midpoint.",
- "Left ear tragion.",
- "Right ear tragion.",
- "Left eye pupil.",
- "Right eye pupil.",
- "Forehead glabella.",
- "Chin gnathion.",
- "Chin left gonion.",
- "Chin right gonion."
- ]
- },
- "position": {
- "description": "Face landmark position.",
- "$ref": "Position"
+ "type": "string"
}
},
"id": "Landmark"
@@ -435,15 +416,6 @@
"description": "A word representation.",
"type": "object",
"properties": {
- "boundingBox": {
- "$ref": "BoundingPoly",
- "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
- },
- "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",
@@ -454,6 +426,15 @@
"property": {
"description": "Additional information detected for the word.",
"$ref": "TextProperty"
+ },
+ "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)."
+ },
+ "confidence": {
+ "description": "Confidence of the OCR results for the word. Range [0, 1].",
+ "format": "float",
+ "type": "number"
}
},
"id": "Word"
@@ -467,8 +448,8 @@
"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)."
},
"confidence": {
"description": "Confidence of the OCR results for the paragraph. Range [0, 1].",
@@ -486,6 +467,8 @@
"id": "Paragraph"
},
"Image": {
+ "description": "Client image to perform Google Cloud Vision API tasks over.",
+ "type": "object",
"properties": {
"content": {
"description": "Image content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.",
@@ -497,18 +480,62 @@
"$ref": "ImageSource"
}
},
- "id": "Image",
- "description": "Client image to perform Google Cloud Vision API tasks over.",
- "type": "object"
+ "id": "Image"
},
"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"
+ "fdBoundingPoly": {
+ "$ref": "BoundingPoly",
+ "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe \u003ccode\u003efd\u003c/code\u003e (face detection) prefix."
+ },
+ "angerLikelihood": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Anger likelihood.",
+ "type": "string"
+ },
+ "landmarks": {
+ "description": "Detected face landmarks.",
+ "type": "array",
+ "items": {
+ "$ref": "Landmark"
+ }
+ },
+ "surpriseLikelihood": {
+ "description": "Surprise likelihood.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ]
},
"joyLikelihood": {
"enumDescriptions": [
@@ -530,6 +557,11 @@
"description": "Joy likelihood.",
"type": "string"
},
+ "landmarkingConfidence": {
+ "description": "Face landmarking confidence. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
"underExposedLikelihood": {
"description": "Under-exposed likelihood.",
"type": "string",
@@ -601,8 +633,8 @@
"type": "string"
},
"boundingPoly": {
- "$ref": "BoundingPoly",
- "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated."
+ "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated.",
+ "$ref": "BoundingPoly"
},
"rollAngle": {
"description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].",
@@ -610,44 +642,7 @@
"type": "number"
},
"sorrowLikelihood": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
"description": "Sorrow likelihood.",
- "type": "string"
- },
- "tiltAngle": {
- "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].",
- "format": "float",
- "type": "number"
- },
- "fdBoundingPoly": {
- "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"
- },
- "angerLikelihood": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Anger likelihood.",
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
@@ -656,23 +651,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."
- ]
- },
- "landmarks": {
- "description": "Detected face landmarks.",
- "type": "array",
- "items": {
- "$ref": "Landmark"
- }
- },
- "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",
@@ -681,9 +659,12 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ],
- "description": "Surprise likelihood.",
- "type": "string"
+ ]
+ },
+ "tiltAngle": {
+ "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].",
+ "format": "float",
+ "type": "number"
}
},
"id": "FaceAnnotation"
@@ -706,11 +687,9 @@
"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.",
@@ -726,9 +705,11 @@
"EOL_SURE_SPACE",
"HYPHEN",
"LINE_BREAK"
- ],
- "description": "Detected break type.",
- "type": "string"
+ ]
+ },
+ "isPrefix": {
+ "description": "True if break prepends the element.",
+ "type": "boolean"
}
},
"id": "DetectedBreak"
@@ -737,6 +718,10 @@
"description": "Image context and/or feature-specific parameters.",
"type": "object",
"properties": {
+ "cropHintsParams": {
+ "$ref": "CropHintsParams",
+ "description": "Parameters for crop hints annotation request."
+ },
"languageHints": {
"description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automatic language detection. For\nlanguages based on the Latin alphabet, setting `language_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerror if one or more of the specified languages is not one of the\n[supported languages](/vision/docs/languages).",
"type": "array",
@@ -745,16 +730,12 @@
}
},
"webDetectionParams": {
- "description": "Parameters for web detection.",
- "$ref": "WebDetectionParams"
+ "$ref": "WebDetectionParams",
+ "description": "Parameters for web detection."
},
"latLongRect": {
"$ref": "LatLongRect",
"description": "lat/long rectangle that specifies the location of the image."
- },
- "cropHintsParams": {
- "$ref": "CropHintsParams",
- "description": "Parameters for crop hints annotation request."
}
},
"id": "ImageContext"
@@ -763,20 +744,6 @@
"description": "Detected page from OCR.",
"type": "object",
"properties": {
- "property": {
- "$ref": "TextProperty",
- "description": "Additional information detected on the page."
- },
- "confidence": {
- "description": "Confidence of the OCR results on the page. Range [0, 1].",
- "format": "float",
- "type": "number"
- },
- "height": {
- "description": "Page height in pixels.",
- "format": "int32",
- "type": "integer"
- },
"width": {
"description": "Page width in pixels.",
"format": "int32",
@@ -788,6 +755,20 @@
"items": {
"$ref": "Block"
}
+ },
+ "property": {
+ "description": "Additional information detected on the page.",
+ "$ref": "TextProperty"
+ },
+ "confidence": {
+ "description": "Confidence of the OCR results on the page. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "height": {
+ "description": "Page height in pixels.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "Page"
@@ -796,13 +777,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.",
@@ -810,6 +787,10 @@
"items": {
"$ref": "Feature"
}
+ },
+ "imageContext": {
+ "$ref": "ImageContext",
+ "description": "Additional context that may accompany the image."
}
},
"id": "AnnotateImageRequest"
@@ -818,10 +799,6 @@
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
@@ -837,6 +814,10 @@
"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"
@@ -845,13 +826,13 @@
"description": "Rectangle determined by min and max `LatLng` pairs.",
"type": "object",
"properties": {
+ "minLatLng": {
+ "$ref": "LatLng",
+ "description": "Min lat/long pair."
+ },
"maxLatLng": {
"$ref": "LatLng",
"description": "Max lat/long pair."
- },
- "minLatLng": {
- "description": "Min lat/long pair.",
- "$ref": "LatLng"
}
},
"id": "LatLongRect"
@@ -869,8 +850,8 @@
"description": "Additional information detected for the symbol."
},
"boundingBox": {
- "$ref": "BoundingPoly",
- "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
+ "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"
},
"confidence": {
"description": "Confidence of the OCR results for the symbol. Range [0, 1].",
@@ -892,6 +873,8 @@
"id": "WebDetectionParams"
},
"CropHintsAnnotation": {
+ "description": "Set of crop hints that are used to generate new crops when serving images.",
+ "type": "object",
"properties": {
"cropHints": {
"description": "Crop hint results.",
@@ -901,9 +884,7 @@
}
}
},
- "id": "CropHintsAnnotation",
- "description": "Set of crop hints that are used to generate new crops when serving images.",
- "type": "object"
+ "id": "CropHintsAnnotation"
},
"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.",
@@ -949,22 +930,13 @@
},
"id": "Color"
},
- "ImageProperties": {
- "description": "Stores image properties, such as dominant colors.",
- "type": "object",
- "properties": {
- "dominantColors": {
- "$ref": "DominantColorsAnnotation",
- "description": "If present, dominant colors completed successfully."
- }
- },
- "id": "ImageProperties"
- },
"Feature": {
"description": "The type of Google Cloud Vision API detection to perform, and the maximum\nnumber of results to return for that type. Multiple `Feature` objects can\nbe specified in the `features` list.",
"type": "object",
"properties": {
"type": {
+ "description": "The feature type.",
+ "type": "string",
"enumDescriptions": [
"Unspecified feature type.",
"Run face detection.",
@@ -990,9 +962,7 @@
"IMAGE_PROPERTIES",
"CROP_HINTS",
"WEB_DETECTION"
- ],
- "description": "The feature type.",
- "type": "string"
+ ]
},
"maxResults": {
"description": "Maximum number of results of this type. Does not apply to\n`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.",
@@ -1006,70 +976,21 @@
},
"id": "Feature"
},
+ "ImageProperties": {
+ "description": "Stores image properties, such as dominant colors.",
+ "type": "object",
+ "properties": {
+ "dominantColors": {
+ "description": "If present, dominant colors completed successfully.",
+ "$ref": "DominantColorsAnnotation"
+ }
+ },
+ "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": {
- "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"
- ]
- },
- "adult": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.",
- "type": "string"
- },
- "spoof": {
- "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "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"
- ]
- },
"medical": {
"enumDescriptions": [
"Unknown likelihood.",
@@ -1091,6 +1012,14 @@
"type": "string"
},
"racy": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
@@ -1100,6 +1029,30 @@
"VERY_LIKELY"
],
"description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.",
+ "type": "string"
+ },
+ "violence": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood that this image contains violent content.",
+ "type": "string"
+ },
+ "adult": {
+ "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.",
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
@@ -1108,7 +1061,35 @@
"It is possible that the image belongs to the specified vertical.",
"It is likely that the image belongs to the specified vertical.",
"It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
]
+ },
+ "spoof": {
+ "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.",
+ "type": "string"
}
},
"id": "SafeSearchAnnotation"
@@ -1145,7 +1126,26 @@
},
"id": "TextAnnotation"
},
+ "Vertex": {
+ "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.",
+ "type": "object",
+ "properties": {
+ "x": {
+ "description": "X coordinate.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "y": {
+ "description": "Y coordinate.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "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.",
@@ -1157,41 +1157,22 @@
"type": "number"
}
},
- "id": "DetectedLanguage",
- "description": "Detected language for a structural component.",
- "type": "object"
- },
- "Vertex": {
- "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.",
- "type": "object",
- "properties": {
- "y": {
- "description": "Y coordinate.",
- "format": "int32",
- "type": "integer"
- },
- "x": {
- "description": "X coordinate.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Vertex"
+ "id": "DetectedLanguage"
},
"WebLabel": {
+ "description": "Label to provide extra metadata for the web detection.",
+ "type": "object",
"properties": {
- "label": {
- "description": "Label for extra metadata.",
- "type": "string"
- },
"languageCode": {
"description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
"type": "string"
+ },
+ "label": {
+ "description": "Label for extra metadata.",
+ "type": "string"
}
},
- "id": "WebLabel",
- "description": "Label to provide extra metadata for the web detection.",
- "type": "object"
+ "id": "WebLabel"
},
"TextProperty": {
"description": "Additional information detected on the structural component.",
@@ -1205,13 +1186,15 @@
}
},
"detectedBreak": {
- "description": "Detected start or end of a text segment.",
- "$ref": "DetectedBreak"
+ "$ref": "DetectedBreak",
+ "description": "Detected start or end of a text segment."
}
},
"id": "TextProperty"
},
"BoundingPoly": {
+ "description": "A bounding polygon for the detected image annotation.",
+ "type": "object",
"properties": {
"vertices": {
"description": "The bounding polygon vertices.",
@@ -1221,16 +1204,12 @@
}
}
},
- "id": "BoundingPoly",
- "description": "A bounding polygon for the detected image annotation.",
- "type": "object"
+ "id": "BoundingPoly"
},
"WebEntity": {
+ "description": "Entity deduced from similar images on the Internet.",
+ "type": "object",
"properties": {
- "entityId": {
- "description": "Opaque entity ID.",
- "type": "string"
- },
"description": {
"description": "Canonical description of the entity, in English.",
"type": "string"
@@ -1239,16 +1218,25 @@
"description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.",
"format": "float",
"type": "number"
+ },
+ "entityId": {
+ "description": "Opaque entity ID.",
+ "type": "string"
}
},
- "id": "WebEntity",
- "description": "Entity deduced from similar images on the Internet.",
- "type": "object"
+ "id": "WebEntity"
},
"AnnotateImageResponse": {
"description": "Response to an image annotation request.",
"type": "object",
"properties": {
+ "landmarkAnnotations": {
+ "description": "If present, landmark detection has completed successfully.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityAnnotation"
+ }
+ },
"textAnnotations": {
"description": "If present, text (OCR) detection has completed successfully.",
"type": "array",
@@ -1279,8 +1267,8 @@
"$ref": "CropHintsAnnotation"
},
"webDetection": {
- "$ref": "WebDetection",
- "description": "If present, web detection has completed successfully."
+ "description": "If present, web detection has completed successfully.",
+ "$ref": "WebDetection"
},
"labelAnnotations": {
"description": "If present, label detection has completed successfully.",
@@ -1290,8 +1278,8 @@
}
},
"safeSearchAnnotation": {
- "description": "If present, safe-search annotation has completed successfully.",
- "$ref": "SafeSearchAnnotation"
+ "$ref": "SafeSearchAnnotation",
+ "description": "If present, safe-search annotation has completed successfully."
},
"error": {
"$ref": "Status",
@@ -1300,23 +1288,31 @@
"fullTextAnnotation": {
"description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext.",
"$ref": "TextAnnotation"
- },
- "landmarkAnnotations": {
- "description": "If present, landmark detection has completed successfully.",
- "type": "array",
- "items": {
- "$ref": "EntityAnnotation"
- }
}
},
"id": "AnnotateImageResponse"
+ },
+ "CropHintsParams": {
+ "description": "Parameters for crop hints annotation request.",
+ "type": "object",
+ "properties": {
+ "aspectRatios": {
+ "description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored.",
+ "type": "array",
+ "items": {
+ "format": "float",
+ "type": "number"
+ }
+ }
+ },
+ "id": "CropHintsParams"
}
},
+ "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": {
@@ -1341,23 +1337,23 @@
"images": {
"methods": {
"annotate": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "BatchAnnotateImagesResponse"
},
- "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.",
+ "path": "v1/images:annotate",
"request": {
"$ref": "BatchAnnotateImagesRequest"
- }
+ },
+ "description": "Run image detection and annotation for a batch of images."
}
}
}
@@ -1375,9 +1371,9 @@
"default": "true"
},
"fields": {
+ "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
@@ -1385,8 +1381,6 @@
"location": "query"
},
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1395,28 +1389,30 @@
"enum": [
"1",
"2"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
+ ],
+ "description": "V1 error format.",
"type": "string"
},
- "alt": {
+ "callback": {
+ "description": "JSONP",
"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"
+ },
+ "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.",
@@ -1424,36 +1420,40 @@
"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": {
+ "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"
+ "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"
+ "type": "string",
+ "location": "query"
}
},
"version": "v1",
"baseUrl": "https://vision.googleapis.com/",
- "servicePath": "",
"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.",
- "basePath": ""
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20180122",
+ "documentationLink": "https://cloud.google.com/vision/",
+ "id": "vision:v1",
+ "discoveryVersion": "v1"
}
diff --git a/vision/v1p1beta1/vision-api.json b/vision/v1p1beta1/vision-api.json
index be27b1f..d5b0b04 100644
--- a/vision/v1p1beta1/vision-api.json
+++ b/vision/v1p1beta1/vision-api.json
@@ -1,73 +1,34 @@
{
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud Vision API",
"ownerName": "Google",
"resources": {
"images": {
"methods": {
"annotate": {
+ "flatPath": "v1p1beta1/images:annotate",
+ "id": "vision.images.annotate",
+ "path": "v1p1beta1/images:annotate",
+ "request": {
+ "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest"
+ },
+ "description": "Run image detection and annotation for a batch of images.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
- ],
- "parameters": {},
- "flatPath": "v1p1beta1/images:annotate",
- "path": "v1p1beta1/images:annotate",
- "id": "vision.images.annotate",
- "description": "Run image detection and annotation for a batch of images.",
- "request": {
- "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest"
- }
+ ]
}
}
}
},
"parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "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",
@@ -87,12 +48,6 @@
"location": "query"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -100,7 +55,13 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
},
"access_token": {
"description": "OAuth access token.",
@@ -108,23 +69,188 @@
"location": "query"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "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": "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": "",
+ "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "id": "vision:v1p1beta1",
- "documentationLink": "https://cloud.google.com/vision/",
"revision": "20180122",
+ "documentationLink": "https://cloud.google.com/vision/",
+ "id": "vision:v1p1beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "GoogleCloudVisionV1p1beta1WebDetectionWebLabel": {
+ "description": "Label to provide extra metadata for the web detection.",
+ "type": "object",
+ "properties": {
+ "label": {
+ "description": "Label for extra metadata.",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel"
+ },
+ "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage": {
+ "description": "Detected language for a structural component.",
+ "type": "object",
+ "properties": {
+ "languageCode": {
+ "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
+ "type": "string"
+ },
+ "confidence": {
+ "description": "Confidence of detected language. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage"
+ },
+ "GoogleCloudVisionV1p1beta1Symbol": {
+ "description": "A single symbol representation.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "description": "Additional information detected for the symbol.",
+ "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty"
+ },
+ "boundingBox": {
+ "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).",
+ "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly"
+ },
+ "confidence": {
+ "description": "Confidence of the OCR results for the symbol. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "text": {
+ "description": "The actual UTF-8 representation of the symbol.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1Symbol"
+ },
+ "GoogleCloudVisionV1p1beta1ImageProperties": {
+ "description": "Stores image properties, such as dominant colors.",
+ "type": "object",
+ "properties": {
+ "dominantColors": {
+ "$ref": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation",
+ "description": "If present, dominant colors completed successfully."
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1ImageProperties"
+ },
+ "GoogleCloudVisionV1p1beta1Image": {
+ "description": "Client image to perform Google Cloud Vision API tasks over.",
+ "type": "object",
+ "properties": {
+ "content": {
+ "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, or publicly-accessible image\nURL. If both `content` and `source` are provided for an image, `content`\ntakes precedence and is used to perform the image annotation request."
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1Image"
+ },
+ "GoogleCloudVisionV1p1beta1WebDetectionWebEntity": {
+ "description": "Entity deduced from similar images on the Internet.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Canonical description of the entity, in English.",
+ "type": "string"
+ },
+ "score": {
+ "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.",
+ "format": "float",
+ "type": "number"
+ },
+ "entityId": {
+ "description": "Opaque entity ID.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity"
+ },
+ "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",
+ "type": "number"
+ },
+ "color": {
+ "description": "RGB components of the color.",
+ "$ref": "Color"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1ColorInfo"
+ },
"GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": {
"description": "A face-specific landmark (for example, a face feature).",
"type": "object",
@@ -218,13 +344,6 @@
"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",
@@ -259,6 +378,13 @@
"items": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebPage"
}
+ },
+ "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"
+ }
}
},
"id": "GoogleCloudVisionV1p1beta1WebDetection"
@@ -282,8 +408,8 @@
}
},
"imagePropertiesAnnotation": {
- "description": "If present, image properties were extracted successfully.",
- "$ref": "GoogleCloudVisionV1p1beta1ImageProperties"
+ "$ref": "GoogleCloudVisionV1p1beta1ImageProperties",
+ "description": "If present, image properties were extracted successfully."
},
"faceAnnotations": {
"description": "If present, face detection has completed successfully.",
@@ -304,8 +430,8 @@
"$ref": "GoogleCloudVisionV1p1beta1CropHintsAnnotation"
},
"webDetection": {
- "$ref": "GoogleCloudVisionV1p1beta1WebDetection",
- "description": "If present, web detection has completed successfully."
+ "description": "If present, web detection has completed successfully.",
+ "$ref": "GoogleCloudVisionV1p1beta1WebDetection"
},
"labelAnnotations": {
"description": "If present, label detection has completed successfully.",
@@ -315,12 +441,12 @@
}
},
"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": {
"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.",
@@ -333,59 +459,43 @@
"description": "A face annotation object contains the results of face detection.",
"type": "object",
"properties": {
- "fdBoundingPoly": {
- "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
- "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe \u003ccode\u003efd\u003c/code\u003e (face detection) prefix."
- },
- "angerLikelihood": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Anger likelihood.",
- "type": "string"
- },
- "landmarks": {
- "description": "Detected face landmarks.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark"
- }
- },
- "surpriseLikelihood": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Surprise likelihood.",
- "type": "string"
+ "landmarkingConfidence": {
+ "description": "Face landmarking confidence. Range [0, 1].",
+ "format": "float",
+ "type": "number"
},
"joyLikelihood": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
"description": "Joy likelihood.",
+ "type": "string"
+ },
+ "detectionConfidence": {
+ "description": "Detection confidence. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "panAngle": {
+ "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"
+ },
+ "underExposedLikelihood": {
+ "description": "Under-exposed likelihood.",
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
@@ -404,41 +514,6 @@
"VERY_LIKELY"
]
},
- "landmarkingConfidence": {
- "description": "Face landmarking confidence. Range [0, 1].",
- "format": "float",
- "type": "number"
- },
- "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": {
"enumDescriptions": [
"Unknown likelihood.",
@@ -460,6 +535,8 @@
"type": "string"
},
"headwearLikelihood": {
+ "description": "Headwear likelihood.",
+ "type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely that the image belongs to the specified vertical.",
@@ -475,9 +552,7 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ],
- "description": "Headwear likelihood.",
- "type": "string"
+ ]
},
"boundingPoly": {
"description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated.",
@@ -489,6 +564,62 @@
"type": "number"
},
"sorrowLikelihood": {
+ "description": "Sorrow likelihood.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ]
+ },
+ "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": {
+ "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"
+ },
+ "surpriseLikelihood": {
+ "description": "Surprise likelihood.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ]
+ },
+ "landmarks": {
+ "description": "Detected face landmarks.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark"
+ }
+ },
+ "angerLikelihood": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely that the image belongs to the specified vertical.",
@@ -505,13 +636,8 @@
"LIKELY",
"VERY_LIKELY"
],
- "description": "Sorrow likelihood.",
+ "description": "Anger likelihood.",
"type": "string"
- },
- "tiltAngle": {
- "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].",
- "format": "float",
- "type": "number"
}
},
"id": "GoogleCloudVisionV1p1beta1FaceAnnotation"
@@ -520,6 +646,46 @@
"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": {
+ "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ]
+ },
+ "spoof": {
+ "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ]
+ },
"medical": {
"enumDescriptions": [
"Unknown likelihood.",
@@ -561,14 +727,6 @@
"type": "string"
},
"violence": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
"description": "Likelihood that this image contains violent content.",
"type": "string",
"enumDescriptions": [
@@ -578,36 +736,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."
- ]
- },
- "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": {
- "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",
@@ -616,9 +744,7 @@
"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"
+ ]
}
},
"id": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation"
@@ -670,45 +796,12 @@
}
},
"imageContext": {
- "$ref": "GoogleCloudVisionV1p1beta1ImageContext",
- "description": "Additional context that may accompany the image."
+ "description": "Additional context that may accompany the image.",
+ "$ref": "GoogleCloudVisionV1p1beta1ImageContext"
}
},
"id": "GoogleCloudVisionV1p1beta1AnnotateImageRequest"
},
- "GoogleCloudVisionV1p1beta1Page": {
- "description": "Detected page from OCR.",
- "type": "object",
- "properties": {
- "property": {
- "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
- "description": "Additional information detected on the page."
- },
- "confidence": {
- "description": "Confidence of the OCR results on the page. Range [0, 1].",
- "format": "float",
- "type": "number"
- },
- "height": {
- "description": "Page height in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "width": {
- "description": "Page width in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "blocks": {
- "description": "List of blocks of text, images etc on this page.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVisionV1p1beta1Block"
- }
- }
- },
- "id": "GoogleCloudVisionV1p1beta1Page"
- },
"GoogleCloudVisionV1p1beta1Block": {
"description": "Logical element on the page.",
"type": "object",
@@ -718,8 +811,6 @@
"description": "Additional information detected for the block."
},
"blockType": {
- "description": "Detected block type (text, image etc) for this block.",
- "type": "string",
"enumDescriptions": [
"Unknown block type.",
"Regular text block.",
@@ -735,7 +826,9 @@
"PICTURE",
"RULER",
"BARCODE"
- ]
+ ],
+ "description": "Detected block type (text, image etc) for this block.",
+ "type": "string"
},
"boundingBox": {
"description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertice order will still be (0, 1, 2, 3).",
@@ -756,6 +849,39 @@
},
"id": "GoogleCloudVisionV1p1beta1Block"
},
+ "GoogleCloudVisionV1p1beta1Page": {
+ "description": "Detected page from OCR.",
+ "type": "object",
+ "properties": {
+ "width": {
+ "description": "Page width in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "blocks": {
+ "description": "List of blocks of text, images etc on this page.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVisionV1p1beta1Block"
+ }
+ },
+ "property": {
+ "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
+ "description": "Additional information detected on the page."
+ },
+ "confidence": {
+ "description": "Confidence of the OCR results on the page. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "height": {
+ "description": "Page height in pixels.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1Page"
+ },
"GoogleCloudVisionV1p1beta1Paragraph": {
"description": "Structural unit of text representing a number of words in certain order.",
"type": "object",
@@ -783,38 +909,10 @@
},
"id": "GoogleCloudVisionV1p1beta1Paragraph"
},
- "GoogleCloudVisionV1p1beta1TextAnnotation": {
- "properties": {
- "pages": {
- "description": "List of pages detected by OCR.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVisionV1p1beta1Page"
- }
- },
- "text": {
- "description": "UTF-8 text detected on the pages.",
- "type": "string"
- }
- },
- "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"
- },
"GoogleCloudVisionV1p1beta1EntityAnnotation": {
+ "description": "Set of detected entity features.",
+ "type": "object",
"properties": {
- "score": {
- "description": "Overall score of the result. Range [0, 1].",
- "format": "float",
- "type": "number"
- },
- "locations": {
- "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVisionV1p1beta1LocationInfo"
- }
- },
"mid": {
"description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).",
"type": "string"
@@ -847,11 +945,39 @@
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Property"
}
+ },
+ "score": {
+ "description": "Overall score of the result. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "locations": {
+ "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVisionV1p1beta1LocationInfo"
+ }
}
},
- "id": "GoogleCloudVisionV1p1beta1EntityAnnotation",
- "description": "Set of detected entity features.",
- "type": "object"
+ "id": "GoogleCloudVisionV1p1beta1EntityAnnotation"
+ },
+ "GoogleCloudVisionV1p1beta1TextAnnotation": {
+ "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.",
+ "type": "object",
+ "properties": {
+ "pages": {
+ "description": "List of pages detected by OCR.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVisionV1p1beta1Page"
+ }
+ },
+ "text": {
+ "description": "UTF-8 text detected on the pages.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1TextAnnotation"
},
"GoogleCloudVisionV1p1beta1BoundingPoly": {
"description": "A bounding polygon for the detected image annotation.",
@@ -879,6 +1005,8 @@
"id": "GoogleCloudVisionV1p1beta1WebDetectionParams"
},
"GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest": {
+ "description": "Multiple image annotation requests are batched into a single service call.",
+ "type": "object",
"properties": {
"requests": {
"description": "Individual image annotation requests for this batch.",
@@ -888,9 +1016,7 @@
}
}
},
- "id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest",
- "description": "Multiple image annotation requests are batched into a single service call.",
- "type": "object"
+ "id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest"
},
"GoogleCloudVisionV1p1beta1LocationInfo": {
"description": "Detected entity location information.",
@@ -907,16 +1033,16 @@
"description": "Additional information detected on the structural component.",
"type": "object",
"properties": {
- "detectedBreak": {
- "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak",
- "description": "Detected start or end of a text segment."
- },
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage"
}
+ },
+ "detectedBreak": {
+ "description": "Detected start or end of a text segment.",
+ "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak"
}
},
"id": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty"
@@ -937,6 +1063,8 @@
"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.",
@@ -947,17 +1075,19 @@
}
}
},
- "id": "GoogleCloudVisionV1p1beta1CropHintsParams",
- "description": "Parameters for crop hints annotation request.",
- "type": "object"
+ "id": "GoogleCloudVisionV1p1beta1CropHintsParams"
},
"GoogleCloudVisionV1p1beta1Word": {
"description": "A word representation.",
"type": "object",
"properties": {
+ "property": {
+ "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
+ "description": "Additional information detected for the word."
+ },
"boundingBox": {
- "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).",
- "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly"
+ "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
+ "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
},
"confidence": {
"description": "Confidence of the OCR results for the word. Range [0, 1].",
@@ -970,10 +1100,6 @@
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Symbol"
}
- },
- "property": {
- "description": "Additional information detected for the word.",
- "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty"
}
},
"id": "GoogleCloudVisionV1p1beta1Word"
@@ -986,11 +1112,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": {
@@ -1026,13 +1152,13 @@
"description": "Rectangle determined by min and max `LatLng` pairs.",
"type": "object",
"properties": {
+ "maxLatLng": {
+ "$ref": "LatLng",
+ "description": "Max lat/long pair."
+ },
"minLatLng": {
"$ref": "LatLng",
"description": "Min lat/long pair."
- },
- "maxLatLng": {
- "description": "Max lat/long pair.",
- "$ref": "LatLng"
}
},
"id": "GoogleCloudVisionV1p1beta1LatLongRect"
@@ -1085,32 +1211,13 @@
},
"id": "GoogleCloudVisionV1p1beta1WebDetectionWebPage"
},
- "GoogleCloudVisionV1p1beta1CropHint": {
- "description": "Single crop hint that is used to generate a new crop when serving an image.",
- "type": "object",
- "properties": {
- "confidence": {
- "description": "Confidence of this being a salient region. Range [0, 1].",
- "format": "float",
- "type": "number"
- },
- "importanceFraction": {
- "description": "Fraction of importance of this salient region with respect to the original\nimage.",
- "format": "float",
- "type": "number"
- },
- "boundingPoly": {
- "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale, as returned in `ImageParams`.",
- "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1CropHint"
- },
"GoogleCloudVisionV1p1beta1Feature": {
"description": "The type of Google Cloud Vision API detection to perform, and the maximum\nnumber of results to return for that type. Multiple `Feature` objects can\nbe specified in the `features` list.",
"type": "object",
"properties": {
"type": {
+ "description": "The feature type.",
+ "type": "string",
"enumDescriptions": [
"Unspecified feature type.",
"Run face detection.",
@@ -1136,9 +1243,7 @@
"IMAGE_PROPERTIES",
"CROP_HINTS",
"WEB_DETECTION"
- ],
- "description": "The feature type.",
- "type": "string"
+ ]
},
"maxResults": {
"description": "Maximum number of results of this type. Does not apply to\n`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.",
@@ -1152,6 +1257,27 @@
},
"id": "GoogleCloudVisionV1p1beta1Feature"
},
+ "GoogleCloudVisionV1p1beta1CropHint": {
+ "description": "Single crop hint that is used to generate a new crop when serving an image.",
+ "type": "object",
+ "properties": {
+ "confidence": {
+ "description": "Confidence of this being a salient region. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "importanceFraction": {
+ "description": "Fraction of importance of this salient region with respect to the original\nimage.",
+ "format": "float",
+ "type": "number"
+ },
+ "boundingPoly": {
+ "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale, as returned in `ImageParams`.",
+ "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1CropHint"
+ },
"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",
@@ -1169,34 +1295,9 @@
},
"id": "LatLng"
},
- "Color": {
- "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
- "type": "object",
- "properties": {
- "red": {
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
- "green": {
- "description": "The amount of green in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
- "blue": {
- "description": "The amount of blue in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
- "alpha": {
- "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
- "format": "float",
- "type": "number"
- }
- },
- "id": "Color"
- },
"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": {
"x": {
"description": "X coordinate.",
@@ -1214,9 +1315,34 @@
"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"
+ "id": "GoogleCloudVisionV1p1beta1Position"
+ },
+ "Color": {
+ "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
+ "type": "object",
+ "properties": {
+ "green": {
+ "description": "The amount of green in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "blue": {
+ "description": "The amount of blue in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "alpha": {
+ "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
+ "format": "float",
+ "type": "number"
+ },
+ "red": {
+ "description": "The amount of red in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "Color"
},
"GoogleCloudVisionV1p1beta1CropHintsAnnotation": {
"description": "Set of crop hints that are used to generate new crops when serving images.",
@@ -1232,48 +1358,6 @@
},
"id": "GoogleCloudVisionV1p1beta1CropHintsAnnotation"
},
- "GoogleCloudVisionV1p1beta1WebDetectionWebImage": {
- "description": "Metadata for online images.",
- "type": "object",
- "properties": {
- "score": {
- "description": "(Deprecated) Overall relevancy score for the image.",
- "format": "float",
- "type": "number"
- },
- "url": {
- "description": "The result image URL.",
- "type": "string"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
- },
- "GoogleCloudVisionV1p1beta1ImageContext": {
- "description": "Image context and/or feature-specific parameters.",
- "type": "object",
- "properties": {
- "latLongRect": {
- "description": "lat/long rectangle that specifies the location of the image.",
- "$ref": "GoogleCloudVisionV1p1beta1LatLongRect"
- },
- "cropHintsParams": {
- "$ref": "GoogleCloudVisionV1p1beta1CropHintsParams",
- "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"
- }
- },
- "webDetectionParams": {
- "$ref": "GoogleCloudVisionV1p1beta1WebDetectionParams",
- "description": "Parameters for web detection."
- }
- },
- "id": "GoogleCloudVisionV1p1beta1ImageContext"
- },
"GoogleCloudVisionV1p1beta1Property": {
"description": "A `Property` consists of a user-supplied name/value pair.",
"type": "object",
@@ -1294,6 +1378,48 @@
},
"id": "GoogleCloudVisionV1p1beta1Property"
},
+ "GoogleCloudVisionV1p1beta1ImageContext": {
+ "description": "Image context and/or feature-specific parameters.",
+ "type": "object",
+ "properties": {
+ "cropHintsParams": {
+ "$ref": "GoogleCloudVisionV1p1beta1CropHintsParams",
+ "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"
+ }
+ },
+ "webDetectionParams": {
+ "$ref": "GoogleCloudVisionV1p1beta1WebDetectionParams",
+ "description": "Parameters for web detection."
+ },
+ "latLongRect": {
+ "$ref": "GoogleCloudVisionV1p1beta1LatLongRect",
+ "description": "lat/long rectangle that specifies the location of the image."
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1ImageContext"
+ },
+ "GoogleCloudVisionV1p1beta1WebDetectionWebImage": {
+ "description": "Metadata for online images.",
+ "type": "object",
+ "properties": {
+ "score": {
+ "description": "(Deprecated) Overall relevancy score for the image.",
+ "format": "float",
+ "type": "number"
+ },
+ "url": {
+ "description": "The result image URL.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
+ },
"GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse": {
"description": "Response to a batch image annotation request.",
"type": "object",
@@ -1307,136 +1433,13 @@
}
},
"id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse"
- },
- "GoogleCloudVisionV1p1beta1WebDetectionWebLabel": {
- "description": "Label to provide extra metadata for the web detection.",
- "type": "object",
- "properties": {
- "label": {
- "description": "Label for extra metadata.",
- "type": "string"
- },
- "languageCode": {
- "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
- "type": "string"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel"
- },
- "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage": {
- "description": "Detected language for a structural component.",
- "type": "object",
- "properties": {
- "languageCode": {
- "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
- "type": "string"
- },
- "confidence": {
- "description": "Confidence of detected language. Range [0, 1].",
- "format": "float",
- "type": "number"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage"
- },
- "GoogleCloudVisionV1p1beta1Symbol": {
- "properties": {
- "text": {
- "description": "The actual UTF-8 representation of the symbol.",
- "type": "string"
- },
- "property": {
- "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
- "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": "GoogleCloudVisionV1p1beta1BoundingPoly"
- },
- "confidence": {
- "description": "Confidence of the OCR results for the symbol. Range [0, 1].",
- "format": "float",
- "type": "number"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1Symbol",
- "description": "A single symbol representation.",
- "type": "object"
- },
- "GoogleCloudVisionV1p1beta1ImageProperties": {
- "properties": {
- "dominantColors": {
- "description": "If present, dominant colors completed successfully.",
- "$ref": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1ImageProperties",
- "description": "Stores image properties, such as dominant colors.",
- "type": "object"
- },
- "GoogleCloudVisionV1p1beta1Image": {
- "description": "Client image to perform Google Cloud Vision API tasks over.",
- "type": "object",
- "properties": {
- "content": {
- "description": "Image content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.",
- "format": "byte",
- "type": "string"
- },
- "source": {
- "description": "Google Cloud Storage image location, or publicly-accessible image\nURL. If both `content` and `source` are provided for an image, `content`\ntakes precedence and is used to perform the image annotation request.",
- "$ref": "GoogleCloudVisionV1p1beta1ImageSource"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1Image"
- },
- "GoogleCloudVisionV1p1beta1ColorInfo": {
- "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.",
- "type": "object",
- "properties": {
- "pixelFraction": {
- "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].",
- "format": "float",
- "type": "number"
- },
- "color": {
- "description": "RGB components of the color.",
- "$ref": "Color"
- },
- "score": {
- "description": "Image-specific score for this color. Value in range [0, 1].",
- "format": "float",
- "type": "number"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1ColorInfo"
- },
- "GoogleCloudVisionV1p1beta1WebDetectionWebEntity": {
- "description": "Entity deduced from similar images on the Internet.",
- "type": "object",
- "properties": {
- "entityId": {
- "description": "Opaque entity ID.",
- "type": "string"
- },
- "description": {
- "description": "Canonical description of the entity, in English.",
- "type": "string"
- },
- "score": {
- "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.",
- "format": "float",
- "type": "number"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity"
}
},
- "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": "Vision",
"auth": {
"oauth2": {
@@ -1452,8 +1455,5 @@
},
"rootUrl": "https://vision.googleapis.com/",
"ownerDomain": "google.com",
- "name": "vision",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Vision API"
+ "name": "vision"
}
diff --git a/youtube/v3/youtube-api.json b/youtube/v3/youtube-api.json
index b044098..194014c 100644
--- a/youtube/v3/youtube-api.json
+++ b/youtube/v3/youtube-api.json
@@ -1,12 +1,12 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/IPcVNse7nmUQLqz58rbBGkdlX1c\"",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/2Tjh3liYXkmR8GH8r-QlP8dkxp4\"",
"discoveryVersion": "v1",
"id": "youtube:v3",
"name": "youtube",
"canonicalName": "YouTube",
"version": "v3",
- "revision": "20171215",
+ "revision": "20180125",
"title": "YouTube Data API",
"description": "Supports core YouTube features, such as uploading videos, creating and managing playlists, searching for content, and much more.",
"ownerDomain": "google.com",
@@ -1370,7 +1370,7 @@
"ChannelSnippet": {
"id": "ChannelSnippet",
"type": "object",
- "description": "Basic details about a channel, including title, description and thumbnails. Next available id: 15.",
+ "description": "Basic details about a channel, including title, description and thumbnails.",
"properties": {
"country": {
"type": "string",
@@ -6243,7 +6243,7 @@
},
"processingDetails": {
"$ref": "VideoProcessingDetails",
- "description": "The processingProgress object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.\n\nThe processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner."
+ "description": "The processingDetails object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.\n\nThe processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner."
},
"projectDetails": {
"$ref": "VideoProjectDetails",
diff --git a/youtube/v3/youtube-gen.go b/youtube/v3/youtube-gen.go
index e655dad..e81e578 100644
--- a/youtube/v3/youtube-gen.go
+++ b/youtube/v3/youtube-gen.go
@@ -2247,7 +2247,7 @@
}
// ChannelSnippet: Basic details about a channel, including title,
-// description and thumbnails. Next available id: 15.
+// description and thumbnails.
type ChannelSnippet struct {
// Country: The country of the channel.
Country string `json:"country,omitempty"`
@@ -8028,7 +8028,7 @@
// play the video in an embedded player.
Player *VideoPlayer `json:"player,omitempty"`
- // ProcessingDetails: The processingProgress object encapsulates
+ // ProcessingDetails: The processingDetails object encapsulates
// information about YouTube's progress in processing the uploaded video
// file. The properties in the object identify the current processing
// status and an estimate of the time remaining until YouTube finishes
diff --git a/youtubereporting/v1/youtubereporting-api.json b/youtubereporting/v1/youtubereporting-api.json
index 5009374..c9b926e 100644
--- a/youtubereporting/v1/youtubereporting-api.json
+++ b/youtubereporting/v1/youtubereporting-api.json
@@ -1,6 +1,4 @@
{
- "version": "v1",
- "baseUrl": "https://youtubereporting.googleapis.com/",
"canonicalName": "YouTube Reporting",
"auth": {
"oauth2": {
@@ -26,55 +24,18 @@
"documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
"id": "youtubereporting:v1",
"title": "YouTube Reporting API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"jobs": {
"methods": {
- "delete": {
- "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": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
- }
- },
- "flatPath": "v1/jobs/{jobId}",
- "path": "v1/jobs/{jobId}",
- "id": "youtubereporting.jobs.delete",
- "description": "Deletes a job."
- },
"list": {
- "flatPath": "v1/jobs",
- "path": "v1/jobs",
- "id": "youtubereporting.jobs.list",
"description": "Lists jobs.",
+ "httpMethod": "GET",
"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": {
"location": "query",
@@ -93,54 +54,6 @@
"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"
- }
- }
- },
- "get": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "jobId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "jobId": {
- "description": "The ID of the job to retrieve.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "onBehalfOfContentOwner": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
- "flatPath": "v1/jobs/{jobId}",
- "path": "v1/jobs/{jobId}",
- "id": "youtubereporting.jobs.get",
- "description": "Gets a job."
- },
- "create": {
- "request": {
- "$ref": "Job"
- },
- "description": "Creates a job and returns it.",
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {
- "onBehalfOfContentOwner": {
"location": "query",
"description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
"type": "string"
@@ -151,16 +64,99 @@
"https://www.googleapis.com/auth/yt-analytics.readonly"
],
"flatPath": "v1/jobs",
+ "id": "youtubereporting.jobs.list",
+ "path": "v1/jobs"
+ },
+ "get": {
+ "path": "v1/jobs/{jobId}",
+ "id": "youtubereporting.jobs.get",
+ "description": "Gets a job.",
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1/jobs/{jobId}"
+ },
+ "create": {
"path": "v1/jobs",
- "id": "youtubereporting.jobs.create"
+ "id": "youtubereporting.jobs.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"
+ },
+ "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": {
+ "onBehalfOfContentOwner": {
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
+ "type": "string",
+ "location": "query"
+ },
+ "jobId": {
+ "description": "The ID of the job to delete.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/jobs/{jobId}",
+ "path": "v1/jobs/{jobId}",
+ "id": "youtubereporting.jobs.delete"
}
},
"resources": {
"reports": {
"methods": {
"list": {
- "path": "v1/jobs/{jobId}/reports",
- "id": "youtubereporting.jobs.reports.list",
"description": "Lists reports created by a specific job.\nReturns NOT_FOUND if the job does not exist.",
"response": {
"$ref": "ListReportsResponse"
@@ -175,16 +171,16 @@
],
"parameters": {
"createdAfter": {
- "location": "query",
"description": "If set, only reports created after the specified date/time are returned.",
"format": "google-datetime",
- "type": "string"
+ "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"
+ "type": "string",
+ "location": "query"
},
"pageToken": {
"location": "query",
@@ -192,21 +188,21 @@
"type": "string"
},
"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",
+ "type": "integer",
"location": "query"
},
- "startTimeBefore": {
+ "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"
+ },
+ "startTimeBefore": {
"description": "If set, only reports whose start time is smaller than the specified\ndate/time are returned.",
"format": "google-datetime",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"jobId": {
"description": "The ID of the job.",
@@ -215,10 +211,11 @@
"location": "path"
}
},
- "flatPath": "v1/jobs/{jobId}/reports"
+ "flatPath": "v1/jobs/{jobId}/reports",
+ "path": "v1/jobs/{jobId}/reports",
+ "id": "youtubereporting.jobs.reports.list"
},
"get": {
- "httpMethod": "GET",
"response": {
"$ref": "Report"
},
@@ -226,13 +223,12 @@
"jobId",
"reportId"
],
+ "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.",
- "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",
@@ -243,15 +239,17 @@
"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}",
+ "id": "youtubereporting.jobs.reports.get",
"description": "Gets the metadata of a specific report."
}
}
@@ -261,33 +259,32 @@
"reportTypes": {
"methods": {
"list": {
- "description": "Lists report types.",
"response": {
"$ref": "ListReportTypesResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "onBehalfOfContentOwner": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
- },
"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": {
- "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"
+ "type": "boolean",
+ "location": "query"
},
"pageSize": {
- "location": "query",
"description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
+ },
+ "onBehalfOfContentOwner": {
+ "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": [
@@ -296,28 +293,30 @@
],
"flatPath": "v1/reportTypes",
"path": "v1/reportTypes",
- "id": "youtubereporting.reportTypes.list"
+ "id": "youtubereporting.reportTypes.list",
+ "description": "Lists report types."
}
}
},
"media": {
"methods": {
"download": {
+ "description": "Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`.",
"supportsMediaDownload": true,
- "response": {
- "$ref": "GdataMedia"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"resourceName"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "GdataMedia"
+ },
"parameters": {
"resourceName": {
+ "location": "path",
"description": "Name of the media that is being downloaded.",
"required": true,
"type": "string",
- "pattern": "^.+$",
- "location": "path"
+ "pattern": "^.+$"
}
},
"scopes": [
@@ -325,15 +324,44 @@
"https://www.googleapis.com/auth/yt-analytics.readonly"
],
"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`."
+ "path": "v1/media/{+resourceName}"
}
}
}
},
"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": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -345,20 +373,18 @@
"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"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
},
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
@@ -370,13 +396,13 @@
"default": "true",
"location": "query"
},
- "bearer_token": {
+ "oauth_token": {
"location": "query",
- "description": "OAuth bearer token.",
+ "description": "OAuth 2.0 token for the current user.",
"type": "string"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
@@ -386,49 +412,133 @@
"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"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "default": "true"
}
},
"schemas": {
+ "GdataDiffChecksumsResponse": {
+ "description": "gdata",
+ "type": "object",
+ "properties": {
+ "chunkSizeBytes": {
+ "description": "gdata",
+ "format": "int64",
+ "type": "string"
+ },
+ "checksumsLocation": {
+ "$ref": "GdataCompositeMedia",
+ "description": "gdata"
+ },
+ "objectSizeBytes": {
+ "description": "gdata",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectLocation": {
+ "$ref": "GdataCompositeMedia",
+ "description": "gdata"
+ },
+ "objectVersion": {
+ "description": "gdata",
+ "type": "string"
+ }
+ },
+ "id": "GdataDiffChecksumsResponse"
+ },
+ "Report": {
+ "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",
+ "description": "A report's metadata including the URL from which the report itself can be\ndownloaded.",
+ "type": "object"
+ },
+ "GdataDownloadParameters": {
+ "description": "gdata",
+ "type": "object",
+ "properties": {
+ "allowGzipCompression": {
+ "description": "gdata",
+ "type": "boolean"
+ },
+ "ignoreRange": {
+ "description": "gdata",
+ "type": "boolean"
+ }
+ },
+ "id": "GdataDownloadParameters"
+ },
+ "Job": {
+ "description": "A job creating reports of a specific type.",
+ "type": "object",
+ "properties": {
+ "createTime": {
+ "description": "The creation date/time of the job.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "reportTypeId": {
+ "description": "The type of reports this job creates. Corresponds to the ID of a\nReportType.",
+ "type": "string"
+ },
+ "expireTime": {
+ "description": "The date/time when this job will expire/expired. After a job expired, no\nnew reports are generated.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the job (max. 100 characters).",
+ "type": "string"
+ },
+ "systemManaged": {
+ "description": "True if this a system-managed job that cannot be modified by the user;\notherwise false.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The server-generated ID of the job (max. 40 characters).",
+ "type": "string"
+ }
+ },
+ "id": "Job"
+ },
"GdataObjectId": {
"description": "gdata",
"type": "object",
"properties": {
- "bucketName": {
- "description": "gdata",
- "type": "string"
- },
"generation": {
"description": "gdata",
"format": "int64",
@@ -437,30 +547,103 @@
"objectName": {
"description": "gdata",
"type": "string"
+ },
+ "bucketName": {
+ "description": "gdata",
+ "type": "string"
}
},
"id": "GdataObjectId"
},
"GdataMedia": {
- "description": "gdata",
- "type": "object",
"properties": {
+ "compositeMedia": {
+ "description": "gdata",
+ "type": "array",
+ "items": {
+ "$ref": "GdataCompositeMedia"
+ }
+ },
+ "blobRef": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
+ "diffUploadResponse": {
+ "$ref": "GdataDiffUploadResponse",
+ "description": "gdata"
+ },
+ "diffVersionResponse": {
+ "description": "gdata",
+ "$ref": "GdataDiffVersionResponse"
+ },
+ "timestamp": {
+ "description": "gdata",
+ "format": "uint64",
+ "type": "string"
+ },
+ "token": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "hash": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "blobstore2Info": {
+ "description": "gdata",
+ "$ref": "GdataBlobstore2Info"
+ },
+ "filename": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "hashVerified": {
+ "description": "gdata",
+ "type": "boolean"
+ },
+ "diffDownloadResponse": {
+ "$ref": "GdataDiffDownloadResponse",
+ "description": "gdata"
+ },
+ "cosmoBinaryReference": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
+ "isPotentialRetry": {
+ "description": "gdata",
+ "type": "boolean",
+ "default": "true"
+ },
+ "md5Hash": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
+ "sha256Hash": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
+ "algorithm": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "gdata",
+ "$ref": "GdataObjectId"
+ },
+ "path": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "bigstoreObjectRef": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
"referenceType": {
- "enum": [
- "PATH",
- "BLOB_REF",
- "INLINE",
- "GET_MEDIA",
- "COMPOSITE_MEDIA",
- "BIGSTORE_REF",
- "DIFF_VERSION_RESPONSE",
- "DIFF_CHECKSUMS_RESPONSE",
- "DIFF_DOWNLOAD_RESPONSE",
- "DIFF_UPLOAD_REQUEST",
- "DIFF_UPLOAD_RESPONSE",
- "COSMO_BINARY_REFERENCE",
- "ARBITRARY_BYTES"
- ],
"description": "gdata",
"type": "string",
"enumDescriptions": [
@@ -477,6 +660,21 @@
"gdata",
"gdata",
"gdata"
+ ],
+ "enum": [
+ "PATH",
+ "BLOB_REF",
+ "INLINE",
+ "GET_MEDIA",
+ "COMPOSITE_MEDIA",
+ "BIGSTORE_REF",
+ "DIFF_VERSION_RESPONSE",
+ "DIFF_CHECKSUMS_RESPONSE",
+ "DIFF_DOWNLOAD_RESPONSE",
+ "DIFF_UPLOAD_REQUEST",
+ "DIFF_UPLOAD_RESPONSE",
+ "COSMO_BINARY_REFERENCE",
+ "ARBITRARY_BYTES"
]
},
"inline": {
@@ -523,95 +721,11 @@
"description": "gdata",
"format": "byte",
"type": "string"
- },
- "compositeMedia": {
- "description": "gdata",
- "type": "array",
- "items": {
- "$ref": "GdataCompositeMedia"
- }
- },
- "blobRef": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
- "diffUploadResponse": {
- "$ref": "GdataDiffUploadResponse",
- "description": "gdata"
- },
- "diffVersionResponse": {
- "$ref": "GdataDiffVersionResponse",
- "description": "gdata"
- },
- "timestamp": {
- "description": "gdata",
- "format": "uint64",
- "type": "string"
- },
- "token": {
- "description": "gdata",
- "type": "string"
- },
- "hash": {
- "description": "gdata",
- "type": "string"
- },
- "filename": {
- "description": "gdata",
- "type": "string"
- },
- "blobstore2Info": {
- "description": "gdata",
- "$ref": "GdataBlobstore2Info"
- },
- "hashVerified": {
- "description": "gdata",
- "type": "boolean"
- },
- "diffDownloadResponse": {
- "description": "gdata",
- "$ref": "GdataDiffDownloadResponse"
- },
- "cosmoBinaryReference": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
- "isPotentialRetry": {
- "description": "gdata",
- "type": "boolean",
- "default": "true"
- },
- "md5Hash": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
- "algorithm": {
- "description": "gdata",
- "type": "string"
- },
- "sha256Hash": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
- "objectId": {
- "$ref": "GdataObjectId",
- "description": "gdata"
- },
- "path": {
- "description": "gdata",
- "type": "string"
- },
- "bigstoreObjectRef": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
}
},
- "id": "GdataMedia"
+ "id": "GdataMedia",
+ "description": "gdata",
+ "type": "object"
},
"GdataDiffVersionResponse": {
"description": "gdata",
@@ -634,8 +748,8 @@
"type": "object",
"properties": {
"objectLocation": {
- "$ref": "GdataCompositeMedia",
- "description": "gdata"
+ "description": "gdata",
+ "$ref": "GdataCompositeMedia"
}
},
"id": "GdataDiffDownloadResponse"
@@ -644,15 +758,15 @@
"description": "gdata",
"type": "object",
"properties": {
+ "checksumsInfo": {
+ "$ref": "GdataCompositeMedia",
+ "description": "gdata"
+ },
"objectVersion": {
"description": "gdata",
"type": "string"
},
"objectInfo": {
- "$ref": "GdataCompositeMedia",
- "description": "gdata"
- },
- "checksumsInfo": {
"description": "gdata",
"$ref": "GdataCompositeMedia"
}
@@ -660,9 +774,11 @@
"id": "GdataDiffUploadRequest"
},
"GdataBlobstore2Info": {
- "description": "gdata",
- "type": "object",
"properties": {
+ "readToken": {
+ "description": "gdata",
+ "type": "string"
+ },
"uploadMetadataContainer": {
"description": "gdata",
"format": "byte",
@@ -681,17 +797,13 @@
"description": "gdata",
"format": "byte",
"type": "string"
- },
- "readToken": {
- "description": "gdata",
- "type": "string"
}
},
- "id": "GdataBlobstore2Info"
+ "id": "GdataBlobstore2Info",
+ "description": "gdata",
+ "type": "object"
},
"ListReportTypesResponse": {
- "description": "Response message for ReportingService.ListReportTypes.",
- "type": "object",
"properties": {
"reportTypes": {
"description": "The list of report types.",
@@ -705,14 +817,14 @@
"type": "string"
}
},
- "id": "ListReportTypesResponse"
+ "id": "ListReportTypesResponse",
+ "description": "Response message for ReportingService.ListReportTypes.",
+ "type": "object"
},
"ReportType": {
+ "description": "A report type.",
+ "type": "object",
"properties": {
- "name": {
- "description": "The name of the report type (max. 100 characters).",
- "type": "string"
- },
"id": {
"description": "The ID of the report type (max. 100 characters).",
"type": "string"
@@ -725,11 +837,13 @@
"description": "The date/time when this report type was/will be deprecated.",
"format": "google-datetime",
"type": "string"
+ },
+ "name": {
+ "description": "The name of the report type (max. 100 characters).",
+ "type": "string"
}
},
- "id": "ReportType",
- "description": "A report type.",
- "type": "object"
+ "id": "ReportType"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
@@ -741,16 +855,16 @@
"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"
@@ -759,14 +873,46 @@
"description": "gdata",
"type": "object",
"properties": {
+ "referenceType": {
+ "description": "gdata",
+ "type": "string",
+ "enumDescriptions": [
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata"
+ ],
+ "enum": [
+ "PATH",
+ "BLOB_REF",
+ "INLINE",
+ "BIGSTORE_REF",
+ "COSMO_BINARY_REFERENCE"
+ ]
+ },
+ "md5Hash": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
+ "inline": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
+ "blobstore2Info": {
+ "$ref": "GdataBlobstore2Info",
+ "description": "gdata"
+ },
"blobRef": {
"description": "gdata",
"format": "byte",
"type": "string"
},
"objectId": {
- "description": "gdata",
- "$ref": "GdataObjectId"
+ "$ref": "GdataObjectId",
+ "description": "gdata"
},
"crc32cHash": {
"description": "gdata",
@@ -791,38 +937,6 @@
"description": "gdata",
"format": "byte",
"type": "string"
- },
- "referenceType": {
- "enumDescriptions": [
- "gdata",
- "gdata",
- "gdata",
- "gdata",
- "gdata"
- ],
- "enum": [
- "PATH",
- "BLOB_REF",
- "INLINE",
- "BIGSTORE_REF",
- "COSMO_BINARY_REFERENCE"
- ],
- "description": "gdata",
- "type": "string"
- },
- "md5Hash": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
- "inline": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
- "blobstore2Info": {
- "$ref": "GdataBlobstore2Info",
- "description": "gdata"
}
},
"id": "GdataCompositeMedia"
@@ -831,16 +945,16 @@
"description": "Response message for ReportingService.ListReports.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the\nListReportsRequest.page_token\nfield in the subsequent call to `ListReports` method to retrieve the next\npage of results.",
- "type": "string"
- },
"reports": {
"description": "The list of report types.",
"type": "array",
"items": {
"$ref": "Report"
}
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the\nListReportsRequest.page_token\nfield in the subsequent call to `ListReports` method to retrieve the next\npage of results.",
+ "type": "string"
}
},
"id": "ListReportsResponse"
@@ -849,6 +963,14 @@
"description": "gdata",
"type": "object",
"properties": {
+ "fromBytes": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "fromFileName": {
+ "description": "gdata",
+ "type": "string"
+ },
"bestGuess": {
"description": "gdata",
"type": "string"
@@ -860,14 +982,6 @@
"fromHeader": {
"description": "gdata",
"type": "string"
- },
- "fromBytes": {
- "description": "gdata",
- "type": "string"
- },
- "fromFileName": {
- "description": "gdata",
- "type": "string"
}
},
"id": "GdataContentTypeInfo"
@@ -886,127 +1000,13 @@
"id": "GdataDiffUploadResponse",
"description": "gdata",
"type": "object"
- },
- "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"
- },
- "endTime": {
- "description": "The end of the time period that the report instance covers. The value is\nexclusive.",
- "format": "google-datetime",
- "type": "string"
- },
- "jobExpireTime": {
- "description": "The date/time when the job this report belongs to will expire/expired.",
- "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"
- },
- "GdataDiffChecksumsResponse": {
- "description": "gdata",
- "type": "object",
- "properties": {
- "objectSizeBytes": {
- "description": "gdata",
- "format": "int64",
- "type": "string"
- },
- "objectLocation": {
- "description": "gdata",
- "$ref": "GdataCompositeMedia"
- },
- "objectVersion": {
- "description": "gdata",
- "type": "string"
- },
- "chunkSizeBytes": {
- "description": "gdata",
- "format": "int64",
- "type": "string"
- },
- "checksumsLocation": {
- "$ref": "GdataCompositeMedia",
- "description": "gdata"
- }
- },
- "id": "GdataDiffChecksumsResponse"
- },
- "GdataDownloadParameters": {
- "properties": {
- "ignoreRange": {
- "description": "gdata",
- "type": "boolean"
- },
- "allowGzipCompression": {
- "description": "gdata",
- "type": "boolean"
- }
- },
- "id": "GdataDownloadParameters",
- "description": "gdata",
- "type": "object"
- },
- "Job": {
- "description": "A job creating reports of a specific type.",
- "type": "object",
- "properties": {
- "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"
- },
- "createTime": {
- "description": "The creation date/time of the job.",
- "format": "google-datetime",
- "type": "string"
- },
- "reportTypeId": {
- "description": "The type of reports this job creates. Corresponds to the ID of a\nReportType.",
- "type": "string"
- },
- "expireTime": {
- "description": "The date/time when this job will expire/expired. After a job expired, no\nnew reports are generated.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "The name of the job (max. 100 characters).",
- "type": "string"
- }
- },
- "id": "Job"
}
},
"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://youtubereporting.googleapis.com/"
}
