OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update JSON files

Browse Source
This commit is contained in:
Guy Taylor
2019-04-04 15:49:54 +01:00
committed by Sebastian Thiel
parent 7467f81594
commit 86a884c48b
244 changed files with 663236 additions and 543902 deletions
Download Patch File Download Diff File Expand all files Collapse all files

464
etc/api/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
View File

@@ -1,239 +1,239 @@
{
"canonicalName": "Abusive Experience Report",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/xapi.zoo": {
"description": "Test scope for access to the Zoo service"
}
}
}
},
"rootUrl": "https://abusiveexperiencereport.googleapis.com/",
"ownerDomain": "google.com",
"name": "abusiveexperiencereport",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Abusive Experience Report API",
"ownerName": "Google",
"resources": {
"sites": {
"methods": {
"get": {
"response": {
"$ref": "SiteSummaryResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/xapi.zoo"
],
"parameters": {
"name": {
"description": "The required site name. This is the site property whose abusive\nexperiences have been reviewed, and it must be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field\nreturned by the API will lead to the verification page, prompting the user\nto go through that process before they can gain access to the Abusive\nExperience Report.",
"required": true,
"type": "string",
"pattern": "^sites/[^/]+$",
"location": "path"
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/xapi.zoo": {
"description": "Test scope for access to the Zoo service"
}
}
},
"flatPath": "v1/sites/{sitesId}",
"path": "v1/{+name}",
"id": "abusiveexperiencereport.sites.get",
"description": "Gets a summary of the abusive experience rating of a site."
}
}
},
"violatingSites": {
"methods": {
"list": {
"flatPath": "v1/violatingSites",
"path": "v1/violatingSites",
"id": "abusiveexperiencereport.violatingSites.list",
"description": "Lists sites with Abusive Experience Report statuses of \"Failing\".",
"response": {
"$ref": "ViolatingSitesResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/xapi.zoo"
],
"parameters": {}
},
"basePath": "",
"baseUrl": "https://abusiveexperiencereport.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Abusive Experience Report",
"description": "Views Abusive Experience Report data, and gets a list of sites that have a significant number of abusive experiences.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/abusive-experience-report/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "abusiveexperiencereport:v1",
"kind": "discovery#restDescription",
"name": "abusiveexperiencereport",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
}
}
},
"parameters": {
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"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": {
"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."
},
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
"location": "query"
}
},
"version": "v1",
"baseUrl": "https://abusiveexperiencereport.googleapis.com/",
"kind": "discovery#restDescription",
"description": "View Abusive Experience Report data, and get a list of sites that have a significant number of abusive experiences.",
"servicePath": "",
"basePath": "",
"id": "abusiveexperiencereport:v1",
"documentationLink": "https://developers.google.com/abusive-experience-report/",
"revision": "20180904",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"ViolatingSitesResponse": {
"description": "Response message for ListViolatingSites.",
"type": "object",
"properties": {
},
"protocol": "rest",
"resources": {
"sites": {
"methods": {
"get": {
"description": "Gets a summary of the abusive experience rating of a site.",
"flatPath": "v1/sites/{sitesId}",
"httpMethod": "GET",
"id": "abusiveexperiencereport.sites.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The required site name. This is the site property whose abusive\nexperiences have been reviewed, and it must be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field\nreturned by the API will lead to the verification page, prompting the user\nto go through that process before they can gain access to the Abusive\nExperience Report.",
"location": "path",
"pattern": "^sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "SiteSummaryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/xapi.zoo"
]
}
}
},
"violatingSites": {
"description": "A list of summaries of violating sites.",
"type": "array",
"items": {
"$ref": "SiteSummaryResponse"
}
"methods": {
"list": {
"description": "Lists sites with Abusive Experience Report statuses of \"Failing\".",
"flatPath": "v1/violatingSites",
"httpMethod": "GET",
"id": "abusiveexperiencereport.violatingSites.list",
"parameterOrder": [],
"parameters": {},
"path": "v1/violatingSites",
"response": {
"$ref": "ViolatingSitesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/xapi.zoo"
]
}
}
}
},
"id": "ViolatingSitesResponse"
},
"SiteSummaryResponse": {
"id": "SiteSummaryResponse",
"description": "Response message for GetSiteSummary.\nDo not confuse with same message in google.ads.experiencereport.v1",
"type": "object",
"properties": {
"underReview": {
"description": "Whether the site is currently under review.",
"type": "boolean"
},
"reportUrl": {
"description": "A link that leads to a full abusive experience report.",
"type": "string"
},
"lastChangeTime": {
"description": "The last time that the site changed status.",
"format": "google-datetime",
"type": "string"
},
"reviewedSite": {
"description": "The name of the site reviewed.",
"type": "string"
},
"abusiveStatus": {
"description": "The status of the site reviewed for the abusive experiences.",
"type": "string",
"enumDescriptions": [
"Not reviewed.",
"Passing.",
"Failing."
],
"enum": [
"UNKNOWN",
"PASSING",
"FAILING"
]
},
"enforcementTime": {
"description": "The date on which enforcement begins.",
"format": "google-datetime",
"type": "string"
},
"filterStatus": {
"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."
],
"enum": [
"UNKNOWN",
"ON",
"OFF",
"PAUSED",
"PENDING"
]
},
"revision": "20190401",
"rootUrl": "https://abusiveexperiencereport.googleapis.com/",
"schemas": {
"SiteSummaryResponse": {
"description": "Response message for GetSiteSummary.",
"id": "SiteSummaryResponse",
"properties": {
"abusiveStatus": {
"description": "The status of the site reviewed for the abusive experiences.",
"enum": [
"UNKNOWN",
"PASSING",
"FAILING"
],
"enumDescriptions": [
"Not reviewed.",
"Passing.",
"Failing."
],
"type": "string"
},
"enforcementTime": {
"description": "The date on which enforcement begins.",
"format": "google-datetime",
"type": "string"
},
"filterStatus": {
"description": "The abusive experience enforcement status of the site.",
"enum": [
"UNKNOWN",
"ON",
"OFF",
"PAUSED",
"PENDING"
],
"enumDescriptions": [
"N/A.",
"Ad filtering is on.",
"Ad filtering is off.",
"Ad filtering is paused.",
"Ad filtering is pending."
],
"type": "string"
},
"lastChangeTime": {
"description": "The last time that the site changed status.",
"format": "google-datetime",
"type": "string"
},
"reportUrl": {
"description": "A link that leads to a full abusive experience report.",
"type": "string"
},
"reviewedSite": {
"description": "The name of the site reviewed.",
"type": "string"
},
"underReview": {
"description": "Whether the site is currently under review.",
"type": "boolean"
}
},
"type": "object"
},
"ViolatingSitesResponse": {
"description": "Response message for ListViolatingSites.",
"id": "ViolatingSitesResponse",
"properties": {
"violatingSites": {
"description": "A list of summaries of violating sites.",
"items": {
"$ref": "SiteSummaryResponse"
},
"type": "array"
}
},
"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"
}
}
},
"servicePath": "",
"title": "Abusive Experience Report API",
"version": "v1",
"version_module": true
}

444
etc/api/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
View File

@@ -1,225 +1,225 @@
{
"discoveryVersion": "v1",
"ownerName": "Google",
"version_module": true,
"resources": {
"ampUrls": {
"methods": {
"batchGet": {
"request": {
"$ref": "BatchGetAmpUrlsRequest"
},
"description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).",
"response": {
"$ref": "BatchGetAmpUrlsResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
"parameters": {},
"flatPath": "v1/ampUrls:batchGet",
"path": "v1/ampUrls:batchGet",
"id": "acceleratedmobilepageurl.ampUrls.batchGet"
}
}
}
},
"parameters": {
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
},
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
"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": {
"type": "string",
"location": "query",
"description": "Selector specifying which fields to include in a partial response."
},
"callback": {
"type": "string",
"location": "query",
"description": "JSONP"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"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"
]
}
},
"schemas": {
"BatchGetAmpUrlsResponse": {
"properties": {
"ampUrls": {
"description": "For each URL in BatchAmpUrlsRequest, the URL response. The response might\nnot be in the same order as URLs in the batch request.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly once.",
"type": "array",
"items": {
"$ref": "AmpUrl"
}
},
"urlErrors": {
"description": "The errors for requested URLs that have no AMP URL.",
"type": "array",
"items": {
"$ref": "AmpUrlError"
}
}
},
"id": "BatchGetAmpUrlsResponse",
"description": "Batch AMP URL response.",
"type": "object"
},
"AmpUrl": {
"description": "AMP URL response for a requested URL.",
"type": "object",
"properties": {
"cdnAmpUrl": {
"description": "The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to\nthe cached document in the Google AMP Cache.",
"type": "string"
},
"originalUrl": {
"description": "The original non-AMP URL.",
"type": "string"
},
"ampUrl": {
"description": "The AMP URL pointing to the publisher's web server.",
"type": "string"
}
},
"id": "AmpUrl"
},
"AmpUrlError": {
"description": "AMP URL Error resource for a requested URL that couldn't be found.",
"type": "object",
"properties": {
"errorCode": {
"enumDescriptions": [
"Not specified error.",
"Indicates the requested URL is not found in the index, possibly because\nit's unable to be found, not able to be accessed by Googlebot, or some\nother error.",
"Indicates no AMP URL has been found that corresponds to the requested\nURL.",
"Indicates some kind of application error occurred at the server.\nClient advised to retry.",
"DEPRECATED: Indicates the requested URL is a valid AMP URL. This is a\nnon-error state, should not be relied upon as a sign of success or\nfailure. It will be removed in future versions of the API.",
"Indicates that an AMP URL has been found that corresponds to the request\nURL, but it is not valid AMP HTML."
],
"enum": [
"ERROR_CODE_UNSPECIFIED",
"INPUT_URL_NOT_FOUND",
"NO_AMP_URL",
"APPLICATION_ERROR",
"URL_IS_VALID_AMP",
"URL_IS_INVALID_AMP"
],
"description": "The error code of an API call.",
"type": "string"
},
"originalUrl": {
"description": "The original non-AMP URL.",
"type": "string"
},
"errorMessage": {
"description": "An optional descriptive error message.",
"type": "string"
}
},
"id": "AmpUrlError"
},
"BatchGetAmpUrlsRequest": {
"description": "AMP URL request for a batch of URLs.",
"type": "object",
"properties": {
"urls": {
"description": "List of URLs to look up for the paired AMP URLs.\nThe URLs are case-sensitive. Up to 50 URLs per lookup\n(see [Usage Limits](/amp/cache/reference/limits)).",
"type": "array",
"items": {
"basePath": "",
"baseUrl": "https://acceleratedmobilepageurl.googleapis.com/",
"batchPath": "batch",
"description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).\n",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/amp/cache/",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "acceleratedmobilepageurl:v1",
"kind": "discovery#restDescription",
"name": "acceleratedmobilepageurl",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"lookupStrategy": {
"description": "The lookup_strategy being requested.",
"type": "string",
"enumDescriptions": [
"FETCH_LIVE_DOC strategy involves live document fetch of URLs not found in\nthe index. Any request URL not found in the index is crawled in realtime\nto validate if there is a corresponding AMP URL. This strategy has higher\ncoverage but with extra latency introduced by realtime crawling. This is\nthe default strategy. Applications using this strategy should set higher\nHTTP timeouts of the API calls.",
"IN_INDEX_DOC strategy skips fetching live documents of URL(s) not found\nin index. For applications which need low latency use of IN_INDEX_DOC\nstrategy is recommended."
],
"enum": [
"FETCH_LIVE_DOC",
"IN_INDEX_DOC"
]
}
},
"id": "BatchGetAmpUrlsRequest"
}
},
"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://acceleratedmobilepageurl.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).\n",
"servicePath": "",
"rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "acceleratedmobilepageurl",
"batchPath": "batch",
"id": "acceleratedmobilepageurl:v1",
"documentationLink": "https://developers.google.com/amp/cache/",
"revision": "20180917",
"title": "Accelerated Mobile Pages (AMP) URL API"
}
},
"protocol": "rest",
"resources": {
"ampUrls": {
"methods": {
"batchGet": {
"description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).",
"flatPath": "v1/ampUrls:batchGet",
"httpMethod": "POST",
"id": "acceleratedmobilepageurl.ampUrls.batchGet",
"parameterOrder": [],
"parameters": {},
"path": "v1/ampUrls:batchGet",
"request": {
"$ref": "BatchGetAmpUrlsRequest"
},
"response": {
"$ref": "BatchGetAmpUrlsResponse"
}
}
}
}
},
"revision": "20190330",
"rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
"schemas": {
"AmpUrl": {
"description": "AMP URL response for a requested URL.",
"id": "AmpUrl",
"properties": {
"ampUrl": {
"description": "The AMP URL pointing to the publisher's web server.",
"type": "string"
},
"cdnAmpUrl": {
"description": "The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to\nthe cached document in the Google AMP Cache.",
"type": "string"
},
"originalUrl": {
"description": "The original non-AMP URL.",
"type": "string"
}
},
"type": "object"
},
"AmpUrlError": {
"description": "AMP URL Error resource for a requested URL that couldn't be found.",
"id": "AmpUrlError",
"properties": {
"errorCode": {
"description": "The error code of an API call.",
"enum": [
"ERROR_CODE_UNSPECIFIED",
"INPUT_URL_NOT_FOUND",
"NO_AMP_URL",
"APPLICATION_ERROR",
"URL_IS_VALID_AMP",
"URL_IS_INVALID_AMP"
],
"enumDescriptions": [
"Not specified error.",
"Indicates the requested URL is not found in the index, possibly because\nit's unable to be found, not able to be accessed by Googlebot, or some\nother error.",
"Indicates no AMP URL has been found that corresponds to the requested\nURL.",
"Indicates some kind of application error occurred at the server.\nClient advised to retry.",
"DEPRECATED: Indicates the requested URL is a valid AMP URL. This is a\nnon-error state, should not be relied upon as a sign of success or\nfailure. It will be removed in future versions of the API.",
"Indicates that an AMP URL has been found that corresponds to the request\nURL, but it is not valid AMP HTML."
],
"type": "string"
},
"errorMessage": {
"description": "An optional descriptive error message.",
"type": "string"
},
"originalUrl": {
"description": "The original non-AMP URL.",
"type": "string"
}
},
"type": "object"
},
"BatchGetAmpUrlsRequest": {
"description": "AMP URL request for a batch of URLs.",
"id": "BatchGetAmpUrlsRequest",
"properties": {
"lookupStrategy": {
"description": "The lookup_strategy being requested.",
"enum": [
"FETCH_LIVE_DOC",
"IN_INDEX_DOC"
],
"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."
],
"type": "string"
},
"urls": {
"description": "List of URLs to look up for the paired AMP URLs.\nThe URLs are case-sensitive. Up to 50 URLs per lookup\n(see [Usage Limits](/amp/cache/reference/limits)).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BatchGetAmpUrlsResponse": {
"description": "Batch AMP URL response.",
"id": "BatchGetAmpUrlsResponse",
"properties": {
"ampUrls": {
"description": "For each URL in BatchAmpUrlsRequest, the URL response. The response might\nnot be in the same order as URLs in the batch request.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly once.",
"items": {
"$ref": "AmpUrl"
},
"type": "array"
},
"urlErrors": {
"description": "The errors for requested URLs that have no AMP URL.",
"items": {
"$ref": "AmpUrlError"
},
"type": "array"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Accelerated Mobile Pages (AMP) URL API",
"version": "v1",
"version_module": true
}

1150
etc/api/accesscontextmanager/v1/accesscontextmanager-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

2031
etc/api/accesscontextmanager/v1beta/accesscontextmanager-api.json
View File

File diff suppressed because it is too large Load Diff

1184
etc/api/adexchangebuyer/v1.2/adexchangebuyer-api.json
View File

File diff suppressed because it is too large Load Diff

3326
etc/api/adexchangebuyer/v1.3/adexchangebuyer-api.json
View File

File diff suppressed because it is too large Load Diff

7358
etc/api/adexchangebuyer/v1.4/adexchangebuyer-api.json
View File

File diff suppressed because it is too large Load Diff

11715
etc/api/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
View File

File diff suppressed because it is too large Load Diff

540
etc/api/adexperiencereport/v1/adexperiencereport-api.json
View File

@@ -1,274 +1,274 @@
{
"revision": "20180911",
"documentationLink": "https://developers.google.com/ad-experience-report/",
"id": "adexperiencereport:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"PlatformSummary": {
"id": "PlatformSummary",
"description": "Summary of the ad experience rating of a site for a specific platform.",
"type": "object",
"properties": {
"filterStatus": {
"description": "The ad filtering status of the site.",
"type": "string",
"enumDescriptions": [
"N/A.",
"Ad filtering is on.",
"Ad filtering is off.",
"Ad filtering is paused.",
"Ad filtering is pending."
],
"enum": [
"UNKNOWN",
"ON",
"OFF",
"PAUSED",
"PENDING"
]
},
"underReview": {
"description": "Whether the site is currently under review.",
"type": "boolean"
},
"reportUrl": {
"description": "A link that leads to a full ad experience report.",
"type": "string"
},
"lastChangeTime": {
"description": "The last time that the site changed status.",
"format": "google-datetime",
"type": "string"
},
"betterAdsStatus": {
"type": "string",
"enumDescriptions": [
"Not reviewed.",
"Passing.",
"Warning.",
"Failing."
],
"enum": [
"UNKNOWN",
"PASSING",
"WARNING",
"FAILING"
],
"description": "The status of the site reviewed for the Better Ads Standards."
},
"enforcementTime": {
"description": "The date on which ad filtering begins.",
"format": "google-datetime",
"type": "string"
},
"region": {
"enumDescriptions": [
"Ad standard not yet defined for your region.",
"Region A.",
"Region B.",
"Region C."
],
"description": "The assigned regions for the site and platform.",
"type": "array",
"items": {
"enum": [
"REGION_UNKNOWN",
"REGION_A",
"REGION_B",
"REGION_C"
],
"type": "string"
}
}
}
},
"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"
}
},
"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": "Ad Experience Report",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/xapi.zoo": {
"description": "Test scope for access to the Zoo service"
}
}
}
},
"rootUrl": "https://adexperiencereport.googleapis.com/",
"ownerDomain": "google.com",
"name": "adexperiencereport",
"batchPath": "batch",
"title": "Ad Experience Report API",
"ownerName": "Google",
"resources": {
"sites": {
"methods": {
"get": {
"description": "Gets a summary of the ad experience rating of a site.",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "SiteSummaryResponse"
},
"parameters": {
"name": {
"description": "The required site name. It should be the site property whose ad experiences\nmay have been reviewed, and it should be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field returned by the\nAPI will lead to the verification page, prompting the user to go through\nthat process before they can gain access to the Ad Experience Report.",
"required": true,
"type": "string",
"pattern": "^sites/[^/]+$",
"location": "path"
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/xapi.zoo": {
"description": "Test scope for access to the Zoo service"
}
}
},
"scopes": [
"https://www.googleapis.com/auth/xapi.zoo"
],
"flatPath": "v1/sites/{sitesId}",
"id": "adexperiencereport.sites.get",
"path": "v1/{+name}"
}
}
},
"violatingSites": {
"methods": {
"list": {
"path": "v1/violatingSites",
"id": "adexperiencereport.violatingSites.list",
"description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\".",
"response": {
"$ref": "ViolatingSitesResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/xapi.zoo"
],
"flatPath": "v1/violatingSites"
},
"basePath": "",
"baseUrl": "https://adexperiencereport.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Ad Experience Report",
"description": "Views Ad Experience Report data, and gets a list of sites that have a significant number of annoying ads.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/ad-experience-report/",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "adexperiencereport:v1",
"kind": "discovery#restDescription",
"name": "adexperiencereport",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
}
}
},
"parameters": {
"alt": {
"enum": [
"json",
"media",
"proto"
],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"description": "Data format for response.",
"default": "json"
},
"key": {
"location": "query",
"description": "API key. Your API 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"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"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"
},
"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": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
]
}
},
"version": "v1",
"baseUrl": "https://adexperiencereport.googleapis.com/",
"kind": "discovery#restDescription",
"description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.",
"servicePath": "",
"basePath": ""
}
},
"protocol": "rest",
"resources": {
"sites": {
"methods": {
"get": {
"description": "Gets a summary of the ad experience rating of a site.",
"flatPath": "v1/sites/{sitesId}",
"httpMethod": "GET",
"id": "adexperiencereport.sites.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The required site name. It should be the site property whose ad experiences\nmay have been reviewed, and it should be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field returned by the\nAPI will lead to the verification page, prompting the user to go through\nthat process before they can gain access to the Ad Experience Report.",
"location": "path",
"pattern": "^sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "SiteSummaryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/xapi.zoo"
]
}
}
},
"violatingSites": {
"methods": {
"list": {
"description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\".",
"flatPath": "v1/violatingSites",
"httpMethod": "GET",
"id": "adexperiencereport.violatingSites.list",
"parameterOrder": [],
"parameters": {},
"path": "v1/violatingSites",
"response": {
"$ref": "ViolatingSitesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/xapi.zoo"
]
}
}
}
},
"revision": "20190401",
"rootUrl": "https://adexperiencereport.googleapis.com/",
"schemas": {
"PlatformSummary": {
"description": "Summary of the ad experience rating of a site for a specific platform.",
"id": "PlatformSummary",
"properties": {
"betterAdsStatus": {
"description": "The status of the site reviewed for the Better Ads Standards.",
"enum": [
"UNKNOWN",
"PASSING",
"WARNING",
"FAILING"
],
"enumDescriptions": [
"Not reviewed.",
"Passing.",
"Warning.",
"Failing."
],
"type": "string"
},
"enforcementTime": {
"description": "The date on which ad filtering begins.",
"format": "google-datetime",
"type": "string"
},
"filterStatus": {
"description": "The ad filtering status of the site.",
"enum": [
"UNKNOWN",
"ON",
"OFF",
"PAUSED",
"PENDING"
],
"enumDescriptions": [
"N/A.",
"Ad filtering is on.",
"Ad filtering is off.",
"Ad filtering is paused.",
"Ad filtering is pending."
],
"type": "string"
},
"lastChangeTime": {
"description": "The last time that the site changed status.",
"format": "google-datetime",
"type": "string"
},
"region": {
"description": "The assigned regions for the site and platform.",
"enumDescriptions": [
"Ad standard not yet defined for your region.",
"Region A.",
"Region B.",
"Region C."
],
"items": {
"enum": [
"REGION_UNKNOWN",
"REGION_A",
"REGION_B",
"REGION_C"
],
"type": "string"
},
"type": "array"
},
"reportUrl": {
"description": "A link that leads to a full ad experience report.",
"type": "string"
},
"underReview": {
"description": "Whether the site is currently under review.",
"type": "boolean"
}
},
"type": "object"
},
"SiteSummaryResponse": {
"description": "Response message for GetSiteSummary.",
"id": "SiteSummaryResponse",
"properties": {
"desktopSummary": {
"$ref": "PlatformSummary",
"description": "Summary for the desktop review of the site."
},
"mobileSummary": {
"$ref": "PlatformSummary",
"description": "Summary for the mobile review of the site."
},
"reviewedSite": {
"description": "The name of the site reviewed.",
"type": "string"
}
},
"type": "object"
},
"ViolatingSitesResponse": {
"description": "Response message for ListViolatingSites.",
"id": "ViolatingSitesResponse",
"properties": {
"violatingSites": {
"description": "A list of summaries of violating sites.",
"items": {
"$ref": "SiteSummaryResponse"
},
"type": "array"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Ad Experience Report API",
"version": "v1",
"version_module": true
}

820
etc/api/admin/datatransfer_v1/admin-api.json
View File

@@ -1,411 +1,411 @@
{
"kind": "discovery#restDescription",
"etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/PJB_zqya-G8YVADxM394C0jmFUA\"",
"discoveryVersion": "v1",
"id": "admin:datatransfer_v1",
"name": "admin",
"canonicalName": "DataTransfer",
"version": "datatransfer_v1",
"revision": "20160223",
"title": "Admin Data Transfer API",
"description": "Transfers user data from one user to another.",
"ownerDomain": "google.com",
"ownerName": "Google",
"packagePath": "admin",
"icons": {
"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
"documentationLink": "https://developers.google.com/admin-sdk/data-transfer/",
"protocol": "rest",
"baseUrl": "https://www.googleapis.com/admin/datatransfer/v1/",
"basePath": "/admin/datatransfer/v1/",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "admin/datatransfer/v1/",
"batchPath": "batch/admin/datatransfer_v1",
"parameters": {
"alt": {
"type": "string",
"description": "Data format for the response.",
"default": "json",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"key": {
"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.",
"location": "query"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query"
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead.",
"location": "query"
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/admin.datatransfer": {
"description": "View and manage data transfers between users in your organization"
},
"https://www.googleapis.com/auth/admin.datatransfer.readonly": {
"description": "View data transfers between users in your organization"
}
}
}
},
"schemas": {
"Application": {
"id": "Application",
"type": "object",
"description": "The JSON template for an Application resource.",
"properties": {
"etag": {
"type": "string",
"description": "Etag of the resource."
},
"id": {
"type": "string",
"description": "The application's ID.",
"format": "int64"
},
"kind": {
"type": "string",
"description": "Identifies the resource as a DataTransfer Application Resource.",
"default": "admin#datatransfer#ApplicationResource"
},
"name": {
"type": "string",
"description": "The application's name."
},
"transferParams": {
"type": "array",
"description": "The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered.",
"items": {
"$ref": "ApplicationTransferParam"
}
}
}
},
"ApplicationDataTransfer": {
"id": "ApplicationDataTransfer",
"type": "object",
"description": "Template to map fields of ApplicationDataTransfer resource.",
"properties": {
"applicationId": {
"type": "string",
"description": "The application's ID.",
"format": "int64"
},
"applicationTransferParams": {
"type": "array",
"description": "The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.",
"items": {
"$ref": "ApplicationTransferParam"
}
},
"applicationTransferStatus": {
"type": "string",
"description": "Current status of transfer for this application. (Read-only)"
}
}
},
"ApplicationTransferParam": {
"id": "ApplicationTransferParam",
"type": "object",
"description": "Template for application transfer parameters.",
"properties": {
"key": {
"type": "string",
"description": "The type of the transfer parameter. eg: 'PRIVACY_LEVEL'"
},
"value": {
"type": "array",
"description": "The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'",
"items": {
"type": "string"
}
}
}
},
"ApplicationsListResponse": {
"id": "ApplicationsListResponse",
"type": "object",
"description": "Template for a collection of Applications.",
"properties": {
"applications": {
"type": "array",
"description": "List of applications that support data transfer and are also installed for the customer.",
"items": {
"$ref": "Application"
}
},
"etag": {
"type": "string",
"description": "ETag of the resource."
},
"kind": {
"type": "string",
"description": "Identifies the resource as a collection of Applications.",
"default": "admin#datatransfer#applicationsList"
},
"nextPageToken": {
"type": "string",
"description": "Continuation token which will be used to specify next page in list API."
}
}
},
"DataTransfer": {
"id": "DataTransfer",
"type": "object",
"description": "The JSON template for a DataTransfer resource.",
"properties": {
"applicationDataTransfers": {
"type": "array",
"description": "List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.",
"items": {
"$ref": "ApplicationDataTransfer"
}
},
"etag": {
"type": "string",
"description": "ETag of the resource."
},
"id": {
"type": "string",
"description": "The transfer's ID (Read-only)."
},
"kind": {
"type": "string",
"description": "Identifies the resource as a DataTransfer request.",
"default": "admin#datatransfer#DataTransfer"
},
"newOwnerUserId": {
"type": "string",
"description": "ID of the user to whom the data is being transfered."
},
"oldOwnerUserId": {
"type": "string",
"description": "ID of the user whose data is being transfered."
},
"overallTransferStatusCode": {
"type": "string",
"description": "Overall transfer status (Read-only)."
},
"requestTime": {
"type": "string",
"description": "The time at which the data transfer was requested (Read-only).",
"format": "date-time"
}
}
},
"DataTransfersListResponse": {
"id": "DataTransfersListResponse",
"type": "object",
"description": "Template for a collection of DataTransfer resources.",
"properties": {
"dataTransfers": {
"type": "array",
"description": "List of data transfer requests.",
"items": {
"$ref": "DataTransfer"
}
},
"etag": {
"type": "string",
"description": "ETag of the resource."
},
"kind": {
"type": "string",
"description": "Identifies the resource as a collection of data transfer requests.",
"default": "admin#datatransfer#dataTransfersList"
},
"nextPageToken": {
"type": "string",
"description": "Continuation token which will be used to specify next page in list API."
}
}
}
},
"resources": {
"applications": {
"methods": {
"get": {
"id": "datatransfer.applications.get",
"path": "applications/{applicationId}",
"httpMethod": "GET",
"description": "Retrieves information about an application for the given application ID.",
"parameters": {
"applicationId": {
"type": "string",
"description": "ID of the application resource to be retrieved.",
"required": true,
"format": "int64",
"location": "path"
}
},
"parameterOrder": [
"applicationId"
],
"response": {
"$ref": "Application"
},
"scopes": [
"https://www.googleapis.com/auth/admin.datatransfer",
"https://www.googleapis.com/auth/admin.datatransfer.readonly"
]
},
"list": {
"id": "datatransfer.applications.list",
"path": "applications",
"httpMethod": "GET",
"description": "Lists the applications available for data transfer for a customer.",
"parameters": {
"customerId": {
"type": "string",
"description": "Immutable ID of the Google Apps account.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return. Default is 100.",
"format": "int32",
"minimum": "1",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Token to specify next page in the list.",
"location": "query"
}
},
"response": {
"$ref": "ApplicationsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admin.datatransfer",
"https://www.googleapis.com/auth/admin.datatransfer.readonly"
]
}
}
},
"transfers": {
"methods": {
"get": {
"id": "datatransfer.transfers.get",
"path": "transfers/{dataTransferId}",
"httpMethod": "GET",
"description": "Retrieves a data transfer request by its resource ID.",
"parameters": {
"dataTransferId": {
"type": "string",
"description": "ID of the resource to be retrieved. This is returned in the response from the insert method.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"dataTransferId"
],
"response": {
"$ref": "DataTransfer"
},
"scopes": [
"https://www.googleapis.com/auth/admin.datatransfer",
"https://www.googleapis.com/auth/admin.datatransfer.readonly"
]
},
"insert": {
"id": "datatransfer.transfers.insert",
"path": "transfers",
"httpMethod": "POST",
"description": "Inserts a data transfer request.",
"request": {
"$ref": "DataTransfer"
},
"response": {
"$ref": "DataTransfer"
},
"scopes": [
"https://www.googleapis.com/auth/admin.datatransfer"
]
},
"list": {
"id": "datatransfer.transfers.list",
"path": "transfers",
"httpMethod": "GET",
"description": "Lists the transfers for a customer by source user, destination user, or status.",
"parameters": {
"customerId": {
"type": "string",
"description": "Immutable ID of the Google Apps account.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return. Default is 100.",
"format": "int32",
"minimum": "1",
"maximum": "500",
"location": "query"
},
"newOwnerUserId": {
"type": "string",
"description": "Destination user's profile ID.",
"location": "query"
},
"oldOwnerUserId": {
"type": "string",
"description": "Source user's profile ID.",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Token to specify the next page in the list.",
"location": "query"
},
"status": {
"type": "string",
"description": "Status of the transfer.",
"location": "query"
}
},
"response": {
"$ref": "DataTransfersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admin.datatransfer",
"https://www.googleapis.com/auth/admin.datatransfer.readonly"
]
}
}
}
}
}
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/admin.datatransfer": {
"description": "View and manage data transfers between users in your organization"
},
"https://www.googleapis.com/auth/admin.datatransfer.readonly": {
"description": "View data transfers between users in your organization"
}
}
}
},
"basePath": "/admin/datatransfer/v1/",
"baseUrl": "https://www.googleapis.com/admin/datatransfer/v1/",
"batchPath": "batch/admin/datatransfer_v1",
"canonicalName": "DataTransfer",
"description": "Transfers user data from one user to another.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/admin-sdk/data-transfer/",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/sO76R3ImJWyHTWFAs7zvdNuGNOQ\"",
"icons": {
"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
"id": "admin:datatransfer_v1",
"kind": "discovery#restDescription",
"name": "admin",
"ownerDomain": "google.com",
"ownerName": "Google",
"packagePath": "admin",
"parameters": {
"alt": {
"default": "json",
"description": "Data format for the response.",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query",
"type": "string"
},
"userIp": {
"description": "Deprecated. Please use quotaUser instead.",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"applications": {
"methods": {
"get": {
"description": "Retrieves information about an application for the given application ID.",
"httpMethod": "GET",
"id": "datatransfer.applications.get",
"parameterOrder": [
"applicationId"
],
"parameters": {
"applicationId": {
"description": "ID of the application resource to be retrieved.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "applications/{applicationId}",
"response": {
"$ref": "Application"
},
"scopes": [
"https://www.googleapis.com/auth/admin.datatransfer",
"https://www.googleapis.com/auth/admin.datatransfer.readonly"
]
},
"list": {
"description": "Lists the applications available for data transfer for a customer.",
"httpMethod": "GET",
"id": "datatransfer.applications.list",
"parameters": {
"customerId": {
"description": "Immutable ID of the Google Apps account.",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "Maximum number of results to return. Default is 100.",
"format": "int32",
"location": "query",
"maximum": "500",
"minimum": "1",
"type": "integer"
},
"pageToken": {
"description": "Token to specify next page in the list.",
"location": "query",
"type": "string"
}
},
"path": "applications",
"response": {
"$ref": "ApplicationsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admin.datatransfer",
"https://www.googleapis.com/auth/admin.datatransfer.readonly"
]
}
}
},
"transfers": {
"methods": {
"get": {
"description": "Retrieves a data transfer request by its resource ID.",
"httpMethod": "GET",
"id": "datatransfer.transfers.get",
"parameterOrder": [
"dataTransferId"
],
"parameters": {
"dataTransferId": {
"description": "ID of the resource to be retrieved. This is returned in the response from the insert method.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "transfers/{dataTransferId}",
"response": {
"$ref": "DataTransfer"
},
"scopes": [
"https://www.googleapis.com/auth/admin.datatransfer",
"https://www.googleapis.com/auth/admin.datatransfer.readonly"
]
},
"insert": {
"description": "Inserts a data transfer request.",
"httpMethod": "POST",
"id": "datatransfer.transfers.insert",
"path": "transfers",
"request": {
"$ref": "DataTransfer"
},
"response": {
"$ref": "DataTransfer"
},
"scopes": [
"https://www.googleapis.com/auth/admin.datatransfer"
]
},
"list": {
"description": "Lists the transfers for a customer by source user, destination user, or status.",
"httpMethod": "GET",
"id": "datatransfer.transfers.list",
"parameters": {
"customerId": {
"description": "Immutable ID of the Google Apps account.",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "Maximum number of results to return. Default is 100.",
"format": "int32",
"location": "query",
"maximum": "500",
"minimum": "1",
"type": "integer"
},
"newOwnerUserId": {
"description": "Destination user's profile ID.",
"location": "query",
"type": "string"
},
"oldOwnerUserId": {
"description": "Source user's profile ID.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Token to specify the next page in the list.",
"location": "query",
"type": "string"
},
"status": {
"description": "Status of the transfer.",
"location": "query",
"type": "string"
}
},
"path": "transfers",
"response": {
"$ref": "DataTransfersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admin.datatransfer",
"https://www.googleapis.com/auth/admin.datatransfer.readonly"
]
}
}
}
},
"revision": "20160223",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Application": {
"description": "The JSON template for an Application resource.",
"id": "Application",
"properties": {
"etag": {
"description": "Etag of the resource.",
"type": "string"
},
"id": {
"description": "The application's ID.",
"format": "int64",
"type": "string"
},
"kind": {
"default": "admin#datatransfer#ApplicationResource",
"description": "Identifies the resource as a DataTransfer Application Resource.",
"type": "string"
},
"name": {
"description": "The application's name.",
"type": "string"
},
"transferParams": {
"description": "The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered.",
"items": {
"$ref": "ApplicationTransferParam"
},
"type": "array"
}
},
"type": "object"
},
"ApplicationDataTransfer": {
"description": "Template to map fields of ApplicationDataTransfer resource.",
"id": "ApplicationDataTransfer",
"properties": {
"applicationId": {
"description": "The application's ID.",
"format": "int64",
"type": "string"
},
"applicationTransferParams": {
"description": "The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.",
"items": {
"$ref": "ApplicationTransferParam"
},
"type": "array"
},
"applicationTransferStatus": {
"description": "Current status of transfer for this application. (Read-only)",
"type": "string"
}
},
"type": "object"
},
"ApplicationTransferParam": {
"description": "Template for application transfer parameters.",
"id": "ApplicationTransferParam",
"properties": {
"key": {
"description": "The type of the transfer parameter. eg: 'PRIVACY_LEVEL'",
"type": "string"
},
"value": {
"description": "The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ApplicationsListResponse": {
"description": "Template for a collection of Applications.",
"id": "ApplicationsListResponse",
"properties": {
"applications": {
"description": "List of applications that support data transfer and are also installed for the customer.",
"items": {
"$ref": "Application"
},
"type": "array"
},
"etag": {
"description": "ETag of the resource.",
"type": "string"
},
"kind": {
"default": "admin#datatransfer#applicationsList",
"description": "Identifies the resource as a collection of Applications.",
"type": "string"
},
"nextPageToken": {
"description": "Continuation token which will be used to specify next page in list API.",
"type": "string"
}
},
"type": "object"
},
"DataTransfer": {
"description": "The JSON template for a DataTransfer resource.",
"id": "DataTransfer",
"properties": {
"applicationDataTransfers": {
"description": "List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.",
"items": {
"$ref": "ApplicationDataTransfer"
},
"type": "array"
},
"etag": {
"description": "ETag of the resource.",
"type": "string"
},
"id": {
"description": "The transfer's ID (Read-only).",
"type": "string"
},
"kind": {
"default": "admin#datatransfer#DataTransfer",
"description": "Identifies the resource as a DataTransfer request.",
"type": "string"
},
"newOwnerUserId": {
"description": "ID of the user to whom the data is being transfered.",
"type": "string"
},
"oldOwnerUserId": {
"description": "ID of the user whose data is being transfered.",
"type": "string"
},
"overallTransferStatusCode": {
"description": "Overall transfer status (Read-only).",
"type": "string"
},
"requestTime": {
"description": "The time at which the data transfer was requested (Read-only).",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"DataTransfersListResponse": {
"description": "Template for a collection of DataTransfer resources.",
"id": "DataTransfersListResponse",
"properties": {
"dataTransfers": {
"description": "List of data transfer requests.",
"items": {
"$ref": "DataTransfer"
},
"type": "array"
},
"etag": {
"description": "ETag of the resource.",
"type": "string"
},
"kind": {
"default": "admin#datatransfer#dataTransfersList",
"description": "Identifies the resource as a collection of data transfer requests.",
"type": "string"
},
"nextPageToken": {
"description": "Continuation token which will be used to specify next page in list API.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "admin/datatransfer/v1/",
"title": "Admin Data Transfer API",
"version": "datatransfer_v1"
}

13905
etc/api/admin/directory_v1/admin-api.json
View File

File diff suppressed because it is too large Load Diff

1655
etc/api/admin/reports_v1/admin-api.json
View File

File diff suppressed because it is too large Load Diff

4882
etc/api/adsense/v1.4/adsense-api.json
View File

File diff suppressed because it is too large Load Diff

3128
etc/api/adsensehost/v4.1/adsensehost-api.json
View File

File diff suppressed because it is too large Load Diff

1708
etc/api/alertcenter/v1beta1/alertcenter-api.json
View File

File diff suppressed because it is too large Load Diff

724
etc/api/analytics/v2.4/analytics-api.json
View File

@@ -1,366 +1,366 @@
{
"kind": "discovery#restDescription",
"etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/hmO83jgNTOCnU85JSkMPWj7Ip_M\"",
"discoveryVersion": "v1",
"id": "analytics:v2.4",
"name": "analytics",
"version": "v2.4",
"revision": "20180622",
"title": "Google Analytics API",
"description": "Views and manages your Google Analytics data.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
"x16": "https://www.google.com/images/icons/product/analytics-16.png",
"x32": "https://www.google.com/images/icons/product/analytics-32.png"
},
"documentationLink": "https://developers.google.com/analytics/",
"protocol": "rest",
"baseUrl": "https://www.googleapis.com/analytics/v2.4/",
"basePath": "/analytics/v2.4/",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "analytics/v2.4/",
"batchPath": "batch/analytics/v2.4",
"parameters": {
"alt": {
"type": "string",
"description": "Data format for the response.",
"default": "atom",
"enum": [
"atom"
],
"enumDescriptions": [
"Responses with Content-Type of application/atom+xml"
],
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"key": {
"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.",
"location": "query"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "false",
"location": "query"
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query"
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead.",
"location": "query"
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/analytics": {
"description": "View and manage your Google Analytics data"
},
"https://www.googleapis.com/auth/analytics.readonly": {
"description": "View your Google Analytics data"
}
}
}
},
"resources": {
"data": {
"methods": {
"get": {
"id": "analytics.data.get",
"path": "data",
"httpMethod": "GET",
"description": "Returns Analytics report data for a view (profile).",
"parameters": {
"dimensions": {
"type": "string",
"description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.",
"pattern": "(ga:.+)?",
"location": "query"
},
"end-date": {
"type": "string",
"description": "End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD.",
"required": true,
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
"location": "query"
},
"filters": {
"type": "string",
"description": "A comma-separated list of dimension or metric filters to be applied to the report data.",
"pattern": "ga:.+",
"location": "query"
},
"ids": {
"type": "string",
"description": "Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
"required": true,
"pattern": "ga:[0-9]+",
"location": "query"
},
"max-results": {
"type": "integer",
"description": "The maximum number of entries to include in this feed.",
"format": "int32",
"location": "query"
},
"metrics": {
"type": "string",
"description": "A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report.",
"required": true,
"pattern": "ga:.+",
"location": "query"
},
"segment": {
"type": "string",
"description": "An Analytics advanced segment to be applied to the report data.",
"location": "query"
},
"sort": {
"type": "string",
"description": "A comma-separated list of dimensions or metrics that determine the sort order for the report data.",
"pattern": "(-)?ga:.+",
"location": "query"
},
"start-date": {
"type": "string",
"description": "Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD.",
"required": true,
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
"location": "query"
},
"start-index": {
"type": "integer",
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"minimum": "1",
"location": "query"
}
},
"parameterOrder": [
"ids",
"start-date",
"end-date",
"metrics"
],
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"management": {
"resources": {
"accounts": {
"methods": {
"list": {
"id": "analytics.management.accounts.list",
"path": "management/accounts",
"httpMethod": "GET",
"description": "Lists all accounts to which the user has access.",
"parameters": {
"max-results": {
"type": "integer",
"description": "The maximum number of accounts to include in this response.",
"format": "int32",
"location": "query"
},
"start-index": {
"type": "integer",
"description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"minimum": "1",
"location": "query"
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/analytics": {
"description": "View and manage your Google Analytics data"
},
"https://www.googleapis.com/auth/analytics.readonly": {
"description": "View your Google Analytics data"
}
}
}
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"goals": {
"methods": {
"list": {
"id": "analytics.management.goals.list",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
"httpMethod": "GET",
"description": "Lists goals to which the user has access.",
"parameters": {
"accountId": {
"type": "string",
"description": "Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
"required": true,
"location": "path"
},
"max-results": {
"type": "integer",
"description": "The maximum number of goals to include in this response.",
"format": "int32",
"location": "query"
},
"profileId": {
"type": "string",
"description": "View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.",
"required": true,
"location": "path"
},
"start-index": {
"type": "integer",
"description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"minimum": "1",
"location": "query"
},
"webPropertyId": {
"type": "string",
"description": "Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
"required": true,
"location": "path"
},
"basePath": "/analytics/v2.4/",
"baseUrl": "https://www.googleapis.com/analytics/v2.4/",
"batchPath": "batch/analytics/v2.4",
"description": "Views and manages your Google Analytics data.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/analytics/",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/B4sj54YbZa4aQo8XJHngizOjfDQ\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/analytics-16.png",
"x32": "https://www.google.com/images/icons/product/analytics-32.png"
},
"id": "analytics:v2.4",
"kind": "discovery#restDescription",
"name": "analytics",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"alt": {
"default": "atom",
"description": "Data format for the response.",
"enum": [
"atom"
],
"enumDescriptions": [
"Responses with Content-Type of application/atom+xml"
],
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "false",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query",
"type": "string"
},
"userIp": {
"description": "Deprecated. Please use quotaUser instead.",
"location": "query",
"type": "string"
}
},
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"profiles": {
"methods": {
"list": {
"id": "analytics.management.profiles.list",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
"httpMethod": "GET",
"description": "Lists views (profiles) to which the user has access.",
"parameters": {
"accountId": {
"type": "string",
"description": "Account ID for the views (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.",
"required": true,
"location": "path"
},
"max-results": {
"type": "integer",
"description": "The maximum number of views (profiles) to include in this response.",
"format": "int32",
"location": "query"
},
"start-index": {
"type": "integer",
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"minimum": "1",
"location": "query"
},
"webPropertyId": {
"type": "string",
"description": "Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.",
"required": true,
"location": "path"
},
"protocol": "rest",
"resources": {
"data": {
"methods": {
"get": {
"description": "Returns Analytics report data for a view (profile).",
"httpMethod": "GET",
"id": "analytics.data.get",
"parameterOrder": [
"ids",
"start-date",
"end-date",
"metrics"
],
"parameters": {
"dimensions": {
"description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.",
"location": "query",
"pattern": "(ga:.+)?",
"type": "string"
},
"end-date": {
"description": "End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD.",
"location": "query",
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
"required": true,
"type": "string"
},
"filters": {
"description": "A comma-separated list of dimension or metric filters to be applied to the report data.",
"location": "query",
"pattern": "ga:.+",
"type": "string"
},
"ids": {
"description": "Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
"location": "query",
"pattern": "ga:[0-9]+",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of entries to include in this feed.",
"format": "int32",
"location": "query",
"type": "integer"
},
"metrics": {
"description": "A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report.",
"location": "query",
"pattern": "ga:.+",
"required": true,
"type": "string"
},
"segment": {
"description": "An Analytics advanced segment to be applied to the report data.",
"location": "query",
"type": "string"
},
"sort": {
"description": "A comma-separated list of dimensions or metrics that determine the sort order for the report data.",
"location": "query",
"pattern": "(-)?ga:.+",
"type": "string"
},
"start-date": {
"description": "Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD.",
"location": "query",
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
"required": true,
"type": "string"
},
"start-index": {
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
}
},
"path": "data",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"management": {
"resources": {
"accounts": {
"methods": {
"list": {
"description": "Lists all accounts to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.accounts.list",
"parameters": {
"max-results": {
"description": "The maximum number of accounts to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"start-index": {
"description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
}
},
"path": "management/accounts",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"goals": {
"methods": {
"list": {
"description": "Lists goals to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.goals.list",
"parameterOrder": [
"accountId",
"webPropertyId",
"profileId"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
"location": "path",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of goals to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"profileId": {
"description": "View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.",
"location": "path",
"required": true,
"type": "string"
},
"start-index": {
"description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
},
"webPropertyId": {
"description": "Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"profiles": {
"methods": {
"list": {
"description": "Lists views (profiles) to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.profiles.list",
"parameterOrder": [
"accountId",
"webPropertyId"
],
"parameters": {
"accountId": {
"description": "Account ID for the views (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.",
"location": "path",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of views (profiles) to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"start-index": {
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
},
"webPropertyId": {
"description": "Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"segments": {
"methods": {
"list": {
"description": "Lists advanced segments to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.segments.list",
"parameters": {
"max-results": {
"description": "The maximum number of advanced segments to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"start-index": {
"description": "An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
}
},
"path": "management/segments",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"webproperties": {
"methods": {
"list": {
"description": "Lists web properties to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.webproperties.list",
"parameterOrder": [
"accountId"
],
"parameters": {
"accountId": {
"description": "Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
"location": "path",
"required": true,
"type": "string"
},
"max-results": {
"description": "The maximum number of web properties to include in this response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"start-index": {
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
}
},
"path": "management/accounts/{accountId}/webproperties",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
}
}
}
},
"parameterOrder": [
"accountId",
"webPropertyId"
],
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"segments": {
"methods": {
"list": {
"id": "analytics.management.segments.list",
"path": "management/segments",
"httpMethod": "GET",
"description": "Lists advanced segments to which the user has access.",
"parameters": {
"max-results": {
"type": "integer",
"description": "The maximum number of advanced segments to include in this response.",
"format": "int32",
"location": "query"
},
"start-index": {
"type": "integer",
"description": "An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"minimum": "1",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"webproperties": {
"methods": {
"list": {
"id": "analytics.management.webproperties.list",
"path": "management/accounts/{accountId}/webproperties",
"httpMethod": "GET",
"description": "Lists web properties to which the user has access.",
"parameters": {
"accountId": {
"type": "string",
"description": "Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
"required": true,
"location": "path"
},
"max-results": {
"type": "integer",
"description": "The maximum number of web properties to include in this response.",
"format": "int32",
"location": "query"
},
"start-index": {
"type": "integer",
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
"format": "int32",
"minimum": "1",
"location": "query"
}
},
"parameterOrder": [
"accountId"
],
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
}
}
}
}
}
},
"revision": "20180730",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "analytics/v2.4/",
"title": "Google Analytics API",
"version": "v2.4"
}

14932
etc/api/analytics/v3/analytics-api.json
View File

File diff suppressed because it is too large Load Diff

2830
etc/api/analyticsreporting/v4/analyticsreporting-api.json
View File

File diff suppressed because it is too large Load Diff

3500
etc/api/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
View File

File diff suppressed because it is too large Load Diff

9185
etc/api/androidenterprise/v1/androidenterprise-api.json
View File

File diff suppressed because it is too large Load Diff

6370
etc/api/androidmanagement/v1/androidmanagement-api.json
View File

File diff suppressed because it is too large Load Diff

528
etc/api/androidpublisher/v1.1/androidpublisher-api.json
View File

@@ -1,265 +1,265 @@
{
"kind": "discovery#restDescription",
"etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/wbdcynonJja7tRoJFzOo01Xdrh4\"",
"discoveryVersion": "v1",
"id": "androidpublisher:v1.1",
"name": "androidpublisher",
"canonicalName": "Android Publisher",
"version": "v1.1",
"revision": "20181009",
"title": "Google Play Developer API",
"description": "Accesses Android application developers' Google Play accounts.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
"x16": "https://www.google.com/images/icons/product/android-16.png",
"x32": "https://www.google.com/images/icons/product/android-32.png"
},
"documentationLink": "https://developers.google.com/android-publisher",
"protocol": "rest",
"baseUrl": "https://www.googleapis.com/androidpublisher/v1.1/applications/",
"basePath": "/androidpublisher/v1.1/applications/",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "androidpublisher/v1.1/applications/",
"batchPath": "batch/androidpublisher/v1.1",
"parameters": {
"alt": {
"type": "string",
"description": "Data format for the response.",
"default": "json",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"key": {
"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.",
"location": "query"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query"
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead.",
"location": "query"
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/androidpublisher": {
"description": "View and manage your Google Play Developer account"
}
}
}
},
"schemas": {
"InappPurchase": {
"id": "InappPurchase",
"type": "object",
"description": "An InappPurchase resource indicates the status of a user's inapp product purchase.",
"properties": {
"consumptionState": {
"type": "integer",
"description": "The consumption state of the inapp product. Possible values are: \n- Yet to be consumed \n- Consumed",
"format": "int32"
},
"developerPayload": {
"type": "string",
"description": "A developer-specified string that contains supplemental information about an order."
},
"kind": {
"type": "string",
"description": "This kind represents an inappPurchase object in the androidpublisher service.",
"default": "androidpublisher#inappPurchase"
},
"orderId": {
"type": "string",
"description": "The order id associated with the purchase of the inapp product."
},
"purchaseState": {
"type": "integer",
"description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled",
"format": "int32"
},
"purchaseTime": {
"type": "string",
"description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).",
"format": "int64"
},
"purchaseType": {
"type": "integer",
"description": "The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: \n- Test (i.e. purchased from a license testing account) \n- Promo (i.e. purchased using a promo code)",
"format": "int32"
}
}
},
"SubscriptionPurchase": {
"id": "SubscriptionPurchase",
"type": "object",
"description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
"properties": {
"autoRenewing": {
"type": "boolean",
"description": "Whether the subscription will automatically be renewed when it reaches its current expiry time."
},
"initiationTimestampMsec": {
"type": "string",
"description": "Time at which the subscription was granted, in milliseconds since the Epoch.",
"format": "int64"
},
"kind": {
"type": "string",
"description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
"default": "androidpublisher#subscriptionPurchase"
},
"validUntilTimestampMsec": {
"type": "string",
"description": "Time at which the subscription will expire, in milliseconds since the Epoch.",
"format": "int64"
}
}
}
},
"resources": {
"inapppurchases": {
"methods": {
"get": {
"id": "androidpublisher.inapppurchases.get",
"path": "{packageName}/inapp/{productId}/purchases/{token}",
"httpMethod": "GET",
"description": "Checks the purchase and consumption status of an inapp item.",
"parameters": {
"packageName": {
"type": "string",
"description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
"required": true,
"location": "path"
},
"productId": {
"type": "string",
"description": "The inapp product SKU (for example, 'com.some.thing.inapp1').",
"required": true,
"location": "path"
},
"token": {
"type": "string",
"description": "The token provided to the user's device when the inapp product was purchased.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"packageName",
"productId",
"token"
],
"response": {
"$ref": "InappPurchase"
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
}
}
},
"purchases": {
"methods": {
"cancel": {
"id": "androidpublisher.purchases.cancel",
"path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel",
"httpMethod": "POST",
"description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
"parameters": {
"packageName": {
"type": "string",
"description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
"required": true,
"location": "path"
},
"subscriptionId": {
"type": "string",
"description": "The purchased subscription ID (for example, 'monthly001').",
"required": true,
"location": "path"
},
"token": {
"type": "string",
"description": "The token provided to the user's device when the subscription was purchased.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"packageName",
"subscriptionId",
"token"
],
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
},
"get": {
"id": "androidpublisher.purchases.get",
"path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}",
"httpMethod": "GET",
"description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
"parameters": {
"packageName": {
"type": "string",
"description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
"required": true,
"location": "path"
},
"subscriptionId": {
"type": "string",
"description": "The purchased subscription ID (for example, 'monthly001').",
"required": true,
"location": "path"
},
"token": {
"type": "string",
"description": "The token provided to the user's device when the subscription was purchased.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"packageName",
"subscriptionId",
"token"
],
"response": {
"$ref": "SubscriptionPurchase"
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
}
}
}
}
}
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/androidpublisher": {
"description": "View and manage your Google Play Developer account"
}
}
}
},
"basePath": "/androidpublisher/v1.1/applications/",
"baseUrl": "https://www.googleapis.com/androidpublisher/v1.1/applications/",
"batchPath": "batch/androidpublisher/v1.1",
"canonicalName": "Android Publisher",
"description": "Accesses Android application developers' Google Play accounts.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/android-publisher",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/tb235cukOw0QTEs8Jj_MLyR9hpU\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/android-16.png",
"x32": "https://www.google.com/images/icons/product/android-32.png"
},
"id": "androidpublisher:v1.1",
"kind": "discovery#restDescription",
"name": "androidpublisher",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"alt": {
"default": "json",
"description": "Data format for the response.",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query",
"type": "string"
},
"userIp": {
"description": "Deprecated. Please use quotaUser instead.",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"inapppurchases": {
"methods": {
"get": {
"description": "Checks the purchase and consumption status of an inapp item.",
"httpMethod": "GET",
"id": "androidpublisher.inapppurchases.get",
"parameterOrder": [
"packageName",
"productId",
"token"
],
"parameters": {
"packageName": {
"description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
"location": "path",
"required": true,
"type": "string"
},
"productId": {
"description": "The inapp product SKU (for example, 'com.some.thing.inapp1').",
"location": "path",
"required": true,
"type": "string"
},
"token": {
"description": "The token provided to the user's device when the inapp product was purchased.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{packageName}/inapp/{productId}/purchases/{token}",
"response": {
"$ref": "InappPurchase"
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
}
}
},
"purchases": {
"methods": {
"cancel": {
"description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
"httpMethod": "POST",
"id": "androidpublisher.purchases.cancel",
"parameterOrder": [
"packageName",
"subscriptionId",
"token"
],
"parameters": {
"packageName": {
"description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
"location": "path",
"required": true,
"type": "string"
},
"subscriptionId": {
"description": "The purchased subscription ID (for example, 'monthly001').",
"location": "path",
"required": true,
"type": "string"
},
"token": {
"description": "The token provided to the user's device when the subscription was purchased.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel",
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
},
"get": {
"description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
"httpMethod": "GET",
"id": "androidpublisher.purchases.get",
"parameterOrder": [
"packageName",
"subscriptionId",
"token"
],
"parameters": {
"packageName": {
"description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
"location": "path",
"required": true,
"type": "string"
},
"subscriptionId": {
"description": "The purchased subscription ID (for example, 'monthly001').",
"location": "path",
"required": true,
"type": "string"
},
"token": {
"description": "The token provided to the user's device when the subscription was purchased.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}",
"response": {
"$ref": "SubscriptionPurchase"
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
}
}
}
},
"revision": "20190402",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"InappPurchase": {
"description": "An InappPurchase resource indicates the status of a user's inapp product purchase.",
"id": "InappPurchase",
"properties": {
"consumptionState": {
"description": "The consumption state of the inapp product. Possible values are: \n- Yet to be consumed \n- Consumed",
"format": "int32",
"type": "integer"
},
"developerPayload": {
"description": "A developer-specified string that contains supplemental information about an order.",
"type": "string"
},
"kind": {
"default": "androidpublisher#inappPurchase",
"description": "This kind represents an inappPurchase object in the androidpublisher service.",
"type": "string"
},
"orderId": {
"description": "The order id associated with the purchase of the inapp product.",
"type": "string"
},
"purchaseState": {
"description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled",
"format": "int32",
"type": "integer"
},
"purchaseTime": {
"description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).",
"format": "int64",
"type": "string"
},
"purchaseType": {
"description": "The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: \n- Test (i.e. purchased from a license testing account) \n- Promo (i.e. purchased using a promo code) \n- Rewarded (i.e. from watching a video ad instead of paying)",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"SubscriptionPurchase": {
"description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
"id": "SubscriptionPurchase",
"properties": {
"autoRenewing": {
"description": "Whether the subscription will automatically be renewed when it reaches its current expiry time.",
"type": "boolean"
},
"initiationTimestampMsec": {
"description": "Time at which the subscription was granted, in milliseconds since the Epoch.",
"format": "int64",
"type": "string"
},
"kind": {
"default": "androidpublisher#subscriptionPurchase",
"description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
"type": "string"
},
"validUntilTimestampMsec": {
"description": "Time at which the subscription will expire, in milliseconds since the Epoch.",
"format": "int64",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "androidpublisher/v1.1/applications/",
"title": "Google Play Developer API",
"version": "v1.1"
}

366
etc/api/androidpublisher/v1/androidpublisher-api.json
View File

@@ -1,184 +1,184 @@
{
"kind": "discovery#restDescription",
"etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/fparelneh7TE9qKzoMjEcU2XZ9o\"",
"discoveryVersion": "v1",
"id": "androidpublisher:v1",
"name": "androidpublisher",
"canonicalName": "Android Publisher",
"version": "v1",
"revision": "20181009",
"title": "Google Play Developer API",
"description": "Accesses Android application developers' Google Play accounts.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
"x16": "https://www.google.com/images/icons/product/android-16.png",
"x32": "https://www.google.com/images/icons/product/android-32.png"
},
"documentationLink": "https://developers.google.com/android-publisher",
"protocol": "rest",
"baseUrl": "https://www.googleapis.com/androidpublisher/v1/applications/",
"basePath": "/androidpublisher/v1/applications/",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "androidpublisher/v1/applications/",
"batchPath": "batch/androidpublisher/v1",
"parameters": {
"alt": {
"type": "string",
"description": "Data format for the response.",
"default": "json",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"key": {
"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.",
"location": "query"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query"
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead.",
"location": "query"
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/androidpublisher": {
"description": "View and manage your Google Play Developer account"
}
}
}
},
"schemas": {
"SubscriptionPurchase": {
"id": "SubscriptionPurchase",
"type": "object",
"description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
"properties": {
"autoRenewing": {
"type": "boolean",
"description": "Whether the subscription will automatically be renewed when it reaches its current expiry time."
},
"initiationTimestampMsec": {
"type": "string",
"description": "Time at which the subscription was granted, in milliseconds since the Epoch.",
"format": "int64"
},
"kind": {
"type": "string",
"description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
"default": "androidpublisher#subscriptionPurchase"
},
"validUntilTimestampMsec": {
"type": "string",
"description": "Time at which the subscription will expire, in milliseconds since the Epoch.",
"format": "int64"
}
}
}
},
"resources": {
"purchases": {
"methods": {
"cancel": {
"id": "androidpublisher.purchases.cancel",
"path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel",
"httpMethod": "POST",
"description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
"parameters": {
"packageName": {
"type": "string",
"description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
"required": true,
"location": "path"
},
"subscriptionId": {
"type": "string",
"description": "The purchased subscription ID (for example, 'monthly001').",
"required": true,
"location": "path"
},
"token": {
"type": "string",
"description": "The token provided to the user's device when the subscription was purchased.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"packageName",
"subscriptionId",
"token"
],
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
},
"get": {
"id": "androidpublisher.purchases.get",
"path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}",
"httpMethod": "GET",
"description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
"parameters": {
"packageName": {
"type": "string",
"description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
"required": true,
"location": "path"
},
"subscriptionId": {
"type": "string",
"description": "The purchased subscription ID (for example, 'monthly001').",
"required": true,
"location": "path"
},
"token": {
"type": "string",
"description": "The token provided to the user's device when the subscription was purchased.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"packageName",
"subscriptionId",
"token"
],
"response": {
"$ref": "SubscriptionPurchase"
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
}
}
}
}
}
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/androidpublisher": {
"description": "View and manage your Google Play Developer account"
}
}
}
},
"basePath": "/androidpublisher/v1/applications/",
"baseUrl": "https://www.googleapis.com/androidpublisher/v1/applications/",
"batchPath": "batch/androidpublisher/v1",
"canonicalName": "Android Publisher",
"description": "Accesses Android application developers' Google Play accounts.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/android-publisher",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/Sfv9GD7qh13jRKioykGJhYinVyQ\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/android-16.png",
"x32": "https://www.google.com/images/icons/product/android-32.png"
},
"id": "androidpublisher:v1",
"kind": "discovery#restDescription",
"name": "androidpublisher",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"alt": {
"default": "json",
"description": "Data format for the response.",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query",
"type": "string"
},
"userIp": {
"description": "Deprecated. Please use quotaUser instead.",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"purchases": {
"methods": {
"cancel": {
"description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
"httpMethod": "POST",
"id": "androidpublisher.purchases.cancel",
"parameterOrder": [
"packageName",
"subscriptionId",
"token"
],
"parameters": {
"packageName": {
"description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
"location": "path",
"required": true,
"type": "string"
},
"subscriptionId": {
"description": "The purchased subscription ID (for example, 'monthly001').",
"location": "path",
"required": true,
"type": "string"
},
"token": {
"description": "The token provided to the user's device when the subscription was purchased.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel",
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
},
"get": {
"description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
"httpMethod": "GET",
"id": "androidpublisher.purchases.get",
"parameterOrder": [
"packageName",
"subscriptionId",
"token"
],
"parameters": {
"packageName": {
"description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
"location": "path",
"required": true,
"type": "string"
},
"subscriptionId": {
"description": "The purchased subscription ID (for example, 'monthly001').",
"location": "path",
"required": true,
"type": "string"
},
"token": {
"description": "The token provided to the user's device when the subscription was purchased.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}",
"response": {
"$ref": "SubscriptionPurchase"
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
}
}
}
},
"revision": "20190402",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"SubscriptionPurchase": {
"description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
"id": "SubscriptionPurchase",
"properties": {
"autoRenewing": {
"description": "Whether the subscription will automatically be renewed when it reaches its current expiry time.",
"type": "boolean"
},
"initiationTimestampMsec": {
"description": "Time at which the subscription was granted, in milliseconds since the Epoch.",
"format": "int64",
"type": "string"
},
"kind": {
"default": "androidpublisher#subscriptionPurchase",
"description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
"type": "string"
},
"validUntilTimestampMsec": {
"description": "Time at which the subscription will expire, in milliseconds since the Epoch.",
"format": "int64",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "androidpublisher/v1/applications/",
"title": "Google Play Developer API",
"version": "v1"
}

7258
etc/api/androidpublisher/v2/androidpublisher-api.json
View File

File diff suppressed because it is too large Load Diff

6785
etc/api/androidpublisher/v3/androidpublisher-api.json
View File

File diff suppressed because it is too large Load Diff

38
etc/api/api-list.yaml
View File

@@ -8,6 +8,7 @@ api:
acceleratedmobilepageurl:
- v1
accesscontextmanager:
- v1
- v1beta
adexchangebuyer:
- v1.3
@@ -56,6 +57,8 @@ api:
- v2
bigquerydatatransfer:
- v1
bigtableadmin:
- v2
binaryauthorization:
- v1beta1
blogger:
@@ -71,6 +74,7 @@ api:
classroom:
- v1
cloudasset:
- v1
- v1beta1
cloudbilling:
- v1
@@ -82,6 +86,8 @@ api:
- v1beta1
cloudfunctions:
- v1
cloudidentity:
- v1
cloudiot:
- v1
cloudkms:
@@ -91,17 +97,24 @@ api:
- v2
cloudmonitoring:
- v2beta2
cloudprivatecatalog:
- v1beta1
cloudprivatecatalogproducer:
- v1beta1
cloudprofiler:
- v2
cloudresourcemanager:
- v1
- v1beta1
- v2
cloudscheduler:
- v1beta1
cloudsearch:
- v1
cloudshell:
- v1
cloudtasks:
- v2
- v2beta2
- v2beta3
cloudtrace:
@@ -117,6 +130,8 @@ api:
- v2
container:
- v1
containeranalysis:
- v1beta1
content:
- v2
- v2sandbox
@@ -138,6 +153,7 @@ api:
- v2.8
- v3.0
- v3.2
- v3.3
dialogflow:
- v2
- v2beta1
@@ -150,6 +166,8 @@ api:
- v2beta1
dns:
- v1
docs:
- v1
doubleclickbidmanager:
- v1
doubleclicksearch:
@@ -157,7 +175,12 @@ api:
drive:
- v2
- v3
driveactivity:
- v2
factchecktools:
- v1alpha1
file:
- v1
- v1beta1
firebasedynamiclinks:
- v1
@@ -192,11 +215,14 @@ api:
- v1
groupssettings:
- v1
healthcare:
- v1beta1
iam:
- v1
iamcredentials:
- v1
iap:
- v1
- v1beta1
identitytoolkit:
- v3
@@ -209,6 +235,8 @@ api:
language:
- v1
- v1beta1
libraryagent:
- v1
licensing:
- v1
logging:
@@ -234,6 +262,7 @@ api:
pagespeedonline:
- v2
- v4
- v5
partners:
- v2
people:
@@ -261,6 +290,8 @@ api:
- v1
redis:
- v1
remotebuildexecution:
- v2
replicapool:
- v1beta2
replicapoolupdater:
@@ -269,6 +300,8 @@ api:
- v1sandbox
resourceviews:
- v1beta2
run:
- v1
runtimeconfig:
- v1
- v1beta1
@@ -278,6 +311,8 @@ api:
- v1
searchconsole:
- v1
securitycenter:
- v1
servicebroker:
- v1
serviceconsumermanagement:
@@ -287,6 +322,7 @@ api:
servicemanagement:
- v1
servicenetworking:
- v1
- v1beta
serviceregistry:
- alpha
@@ -350,6 +386,8 @@ api:
- v1
webmasters:
- v3
websecurityscanner:
- v1beta
youtube:
- v3
youtubeanalytics:

7205
etc/api/appengine/v1/appengine-api.json
View File

File diff suppressed because it is too large Load Diff

2560
etc/api/appengine/v1alpha/appengine-api.json
View File

File diff suppressed because it is too large Load Diff

7370
etc/api/appengine/v1beta/appengine-api.json
View File

File diff suppressed because it is too large Load Diff

4910
etc/api/appengine/v1beta4/appengine-api.json
View File

File diff suppressed because it is too large Load Diff

4844
etc/api/appengine/v1beta5/appengine-api.json
View File

File diff suppressed because it is too large Load Diff

948
etc/api/appsactivity/v1/appsactivity-api.json
View File

@@ -1,475 +1,475 @@
{
"kind": "discovery#restDescription",
"etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/kg_U6U5i2XPBFjnOz4xe6aDxN24\"",
"discoveryVersion": "v1",
"id": "appsactivity:v1",
"name": "appsactivity",
"version": "v1",
"revision": "20181011",
"title": "Drive Activity API",
"description": "Provides a historical view of activity.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
"documentationLink": "https://developers.google.com/google-apps/activity/",
"protocol": "rest",
"baseUrl": "https://www.googleapis.com/appsactivity/v1/",
"basePath": "/appsactivity/v1/",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "appsactivity/v1/",
"batchPath": "batch/appsactivity/v1",
"parameters": {
"alt": {
"type": "string",
"description": "Data format for the response.",
"default": "json",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"key": {
"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.",
"location": "query"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query"
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead.",
"location": "query"
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/activity": {
"description": "View the activity history of your Google apps"
}
}
}
},
"schemas": {
"Activity": {
"id": "Activity",
"type": "object",
"description": "An Activity resource is a combined view of multiple events. An activity has a list of individual events and a combined view of the common fields among all events.",
"properties": {
"combinedEvent": {
"$ref": "Event",
"description": "The fields common to all of the singleEvents that make up the Activity."
},
"singleEvents": {
"type": "array",
"description": "A list of all the Events that make up the Activity.",
"items": {
"$ref": "Event"
}
}
}
},
"Event": {
"id": "Event",
"type": "object",
"description": "Represents the changes associated with an action taken by a user.",
"properties": {
"additionalEventTypes": {
"type": "array",
"description": "Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.",
"items": {
"type": "string",
"enum": [
"comment",
"create",
"edit",
"emptyTrash",
"move",
"permissionChange",
"rename",
"trash",
"unknown",
"untrash",
"upload"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
}
},
"eventTimeMillis": {
"type": "string",
"description": "The time at which the event occurred formatted as Unix time in milliseconds.",
"format": "uint64"
},
"fromUserDeletion": {
"type": "boolean",
"description": "Whether this event is caused by a user being deleted."
},
"move": {
"$ref": "Move",
"description": "Extra information for move type events, such as changes in an object's parents."
},
"permissionChanges": {
"type": "array",
"description": "Extra information for permissionChange type events, such as the user or group the new permission applies to.",
"items": {
"$ref": "PermissionChange"
}
},
"primaryEventType": {
"type": "string",
"description": "The main type of event that occurred.",
"enum": [
"comment",
"create",
"edit",
"emptyTrash",
"move",
"permissionChange",
"rename",
"trash",
"unknown",
"untrash",
"upload"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"rename": {
"$ref": "Rename",
"description": "Extra information for rename type events, such as the old and new names."
},
"target": {
"$ref": "Target",
"description": "Information specific to the Target object modified by the event."
},
"user": {
"$ref": "User",
"description": "Represents the user responsible for the event."
}
}
},
"ListActivitiesResponse": {
"id": "ListActivitiesResponse",
"type": "object",
"description": "The response from the list request. Contains a list of activities and a token to retrieve the next page of results.",
"properties": {
"activities": {
"type": "array",
"description": "List of activities.",
"items": {
"$ref": "Activity"
}
},
"nextPageToken": {
"type": "string",
"description": "Token for the next page of results."
}
}
},
"Move": {
"id": "Move",
"type": "object",
"description": "Contains information about changes in an object's parents as a result of a move type event.",
"properties": {
"addedParents": {
"type": "array",
"description": "The added parent(s).",
"items": {
"$ref": "Parent"
}
},
"removedParents": {
"type": "array",
"description": "The removed parent(s).",
"items": {
"$ref": "Parent"
}
}
}
},
"Parent": {
"id": "Parent",
"type": "object",
"description": "Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.",
"properties": {
"id": {
"type": "string",
"description": "The parent's ID."
},
"isRoot": {
"type": "boolean",
"description": "Whether this is the root folder."
},
"title": {
"type": "string",
"description": "The parent's title."
}
}
},
"Permission": {
"id": "Permission",
"type": "object",
"description": "Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.",
"properties": {
"name": {
"type": "string",
"description": "The name of the user or group the permission applies to."
},
"permissionId": {
"type": "string",
"description": "The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource."
},
"role": {
"type": "string",
"description": "Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.",
"enum": [
"commenter",
"owner",
"publishedReader",
"reader",
"writer"
],
"enumDescriptions": [
"",
"",
"",
"",
""
]
},
"type": {
"type": "string",
"description": "Indicates how widely permissions are granted.",
"enum": [
"anyone",
"domain",
"group",
"user"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"user": {
"$ref": "User",
"description": "The user's information if the type is USER."
},
"withLink": {
"type": "boolean",
"description": "Whether the permission requires a link to the file."
}
}
},
"PermissionChange": {
"id": "PermissionChange",
"type": "object",
"description": "Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.",
"properties": {
"addedPermissions": {
"type": "array",
"description": "Lists all Permission objects added.",
"items": {
"$ref": "Permission"
}
},
"removedPermissions": {
"type": "array",
"description": "Lists all Permission objects removed.",
"items": {
"$ref": "Permission"
}
}
}
},
"Photo": {
"id": "Photo",
"type": "object",
"description": "Photo information for a user.",
"properties": {
"url": {
"type": "string",
"description": "The URL of the photo."
}
}
},
"Rename": {
"id": "Rename",
"type": "object",
"description": "Contains information about a renametype event.",
"properties": {
"newTitle": {
"type": "string",
"description": "The new title."
},
"oldTitle": {
"type": "string",
"description": "The old title."
}
}
},
"Target": {
"id": "Target",
"type": "object",
"description": "Information about the object modified by the event.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the target. For example, in Google Drive, this is the file or folder ID."
},
"mimeType": {
"type": "string",
"description": "The MIME type of the target."
},
"name": {
"type": "string",
"description": "The name of the target. For example, in Google Drive, this is the title of the file."
}
}
},
"User": {
"id": "User",
"type": "object",
"description": "A representation of a user.",
"properties": {
"isDeleted": {
"type": "boolean",
"description": "A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted."
},
"isMe": {
"type": "boolean",
"description": "Whether the user is the authenticated user."
},
"name": {
"type": "string",
"description": "The displayable name of the user."
},
"permissionId": {
"type": "string",
"description": "The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource."
},
"photo": {
"$ref": "Photo",
"description": "The profile photo of the user. Not present if the user has no profile photo."
}
}
}
},
"resources": {
"activities": {
"methods": {
"list": {
"id": "appsactivity.activities.list",
"path": "activities",
"httpMethod": "GET",
"description": "Returns a list of activities visible to the current logged in user. Visible activities are determined by the visiblity settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.",
"parameters": {
"drive.ancestorId": {
"type": "string",
"description": "Identifies the Drive folder containing the items for which to return activities.",
"location": "query"
},
"drive.fileId": {
"type": "string",
"description": "Identifies the Drive item to return activities for.",
"location": "query"
},
"groupingStrategy": {
"type": "string",
"description": "Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.",
"default": "driveUi",
"enum": [
"driveUi",
"none"
],
"enumDescriptions": [
"",
""
],
"location": "query"
},
"pageSize": {
"type": "integer",
"description": "The maximum number of events to return on a page. The response includes a continuation token if there are more events.",
"default": "50",
"format": "int32",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "A token to retrieve a specific page of results.",
"location": "query"
},
"source": {
"type": "string",
"description": "The Google service from which to return activities. Possible values of source are: \n- drive.google.com",
"location": "query"
},
"userId": {
"type": "string",
"description": "Indicates the user to return activity for. Use the special value me to indicate the currently authenticated user.",
"default": "me",
"location": "query"
}
},
"response": {
"$ref": "ListActivitiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/activity"
]
}
}
}
}
}
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/activity": {
"description": "View the activity history of your Google apps"
}
}
}
},
"basePath": "/appsactivity/v1/",
"baseUrl": "https://www.googleapis.com/appsactivity/v1/",
"batchPath": "batch/appsactivity/v1",
"description": "Provides a historical view of activity.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/google-apps/activity/",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/9Xk6E4xFbOR6o0M0-9JQPib6zYY\"",
"icons": {
"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
"id": "appsactivity:v1",
"kind": "discovery#restDescription",
"name": "appsactivity",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"alt": {
"default": "json",
"description": "Data format for the response.",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query",
"type": "string"
},
"userIp": {
"description": "Deprecated. Please use quotaUser instead.",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"activities": {
"methods": {
"list": {
"description": "Returns a list of activities visible to the current logged in user. Visible activities are determined by the visibility settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.",
"httpMethod": "GET",
"id": "appsactivity.activities.list",
"parameters": {
"drive.ancestorId": {
"description": "Identifies the Drive folder containing the items for which to return activities.",
"location": "query",
"type": "string"
},
"drive.fileId": {
"description": "Identifies the Drive item to return activities for.",
"location": "query",
"type": "string"
},
"groupingStrategy": {
"default": "driveUi",
"description": "Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.",
"enum": [
"driveUi",
"none"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"pageSize": {
"default": "50",
"description": "The maximum number of events to return on a page. The response includes a continuation token if there are more events.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token to retrieve a specific page of results.",
"location": "query",
"type": "string"
},
"source": {
"description": "The Google service from which to return activities. Possible values of source are: \n- drive.google.com",
"location": "query",
"type": "string"
},
"userId": {
"default": "me",
"description": "The ID used for ACL checks (does not filter the resulting event list by the assigned value). Use the special value me to indicate the currently authenticated user.",
"location": "query",
"type": "string"
}
},
"path": "activities",
"response": {
"$ref": "ListActivitiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/activity"
]
}
}
}
},
"revision": "20190402",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Activity": {
"description": "An Activity resource is a combined view of multiple events. An activity has a list of individual events and a combined view of the common fields among all events.",
"id": "Activity",
"properties": {
"combinedEvent": {
"$ref": "Event",
"description": "The fields common to all of the singleEvents that make up the Activity."
},
"singleEvents": {
"description": "A list of all the Events that make up the Activity.",
"items": {
"$ref": "Event"
},
"type": "array"
}
},
"type": "object"
},
"Event": {
"description": "Represents the changes associated with an action taken by a user.",
"id": "Event",
"properties": {
"additionalEventTypes": {
"description": "Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.",
"items": {
"enum": [
"comment",
"create",
"edit",
"emptyTrash",
"move",
"permissionChange",
"rename",
"trash",
"unknown",
"untrash",
"upload"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"type": "array"
},
"eventTimeMillis": {
"description": "The time at which the event occurred formatted as Unix time in milliseconds.",
"format": "uint64",
"type": "string"
},
"fromUserDeletion": {
"description": "Whether this event is caused by a user being deleted.",
"type": "boolean"
},
"move": {
"$ref": "Move",
"description": "Extra information for move type events, such as changes in an object's parents."
},
"permissionChanges": {
"description": "Extra information for permissionChange type events, such as the user or group the new permission applies to.",
"items": {
"$ref": "PermissionChange"
},
"type": "array"
},
"primaryEventType": {
"description": "The main type of event that occurred.",
"enum": [
"comment",
"create",
"edit",
"emptyTrash",
"move",
"permissionChange",
"rename",
"trash",
"unknown",
"untrash",
"upload"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"rename": {
"$ref": "Rename",
"description": "Extra information for rename type events, such as the old and new names."
},
"target": {
"$ref": "Target",
"description": "Information specific to the Target object modified by the event."
},
"user": {
"$ref": "User",
"description": "Represents the user responsible for the event."
}
},
"type": "object"
},
"ListActivitiesResponse": {
"description": "The response from the list request. Contains a list of activities and a token to retrieve the next page of results.",
"id": "ListActivitiesResponse",
"properties": {
"activities": {
"description": "List of activities.",
"items": {
"$ref": "Activity"
},
"type": "array"
},
"nextPageToken": {
"description": "Token for the next page of results.",
"type": "string"
}
},
"type": "object"
},
"Move": {
"description": "Contains information about changes in an object's parents as a result of a move type event.",
"id": "Move",
"properties": {
"addedParents": {
"description": "The added parent(s).",
"items": {
"$ref": "Parent"
},
"type": "array"
},
"removedParents": {
"description": "The removed parent(s).",
"items": {
"$ref": "Parent"
},
"type": "array"
}
},
"type": "object"
},
"Parent": {
"description": "Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.",
"id": "Parent",
"properties": {
"id": {
"description": "The parent's ID.",
"type": "string"
},
"isRoot": {
"description": "Whether this is the root folder.",
"type": "boolean"
},
"title": {
"description": "The parent's title.",
"type": "string"
}
},
"type": "object"
},
"Permission": {
"description": "Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.",
"id": "Permission",
"properties": {
"name": {
"description": "The name of the user or group the permission applies to.",
"type": "string"
},
"permissionId": {
"description": "The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.",
"type": "string"
},
"role": {
"description": "Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.",
"enum": [
"commenter",
"owner",
"publishedReader",
"reader",
"writer"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"type": {
"description": "Indicates how widely permissions are granted.",
"enum": [
"anyone",
"domain",
"group",
"user"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"user": {
"$ref": "User",
"description": "The user's information if the type is USER."
},
"withLink": {
"description": "Whether the permission requires a link to the file.",
"type": "boolean"
}
},
"type": "object"
},
"PermissionChange": {
"description": "Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.",
"id": "PermissionChange",
"properties": {
"addedPermissions": {
"description": "Lists all Permission objects added.",
"items": {
"$ref": "Permission"
},
"type": "array"
},
"removedPermissions": {
"description": "Lists all Permission objects removed.",
"items": {
"$ref": "Permission"
},
"type": "array"
}
},
"type": "object"
},
"Photo": {
"description": "Photo information for a user.",
"id": "Photo",
"properties": {
"url": {
"description": "The URL of the photo.",
"type": "string"
}
},
"type": "object"
},
"Rename": {
"description": "Contains information about a renametype event.",
"id": "Rename",
"properties": {
"newTitle": {
"description": "The new title.",
"type": "string"
},
"oldTitle": {
"description": "The old title.",
"type": "string"
}
},
"type": "object"
},
"Target": {
"description": "Information about the object modified by the event.",
"id": "Target",
"properties": {
"id": {
"description": "The ID of the target. For example, in Google Drive, this is the file or folder ID.",
"type": "string"
},
"mimeType": {
"description": "The MIME type of the target.",
"type": "string"
},
"name": {
"description": "The name of the target. For example, in Google Drive, this is the title of the file.",
"type": "string"
}
},
"type": "object"
},
"User": {
"description": "A representation of a user.",
"id": "User",
"properties": {
"isDeleted": {
"description": "A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.",
"type": "boolean"
},
"isMe": {
"description": "Whether the user is the authenticated user.",
"type": "boolean"
},
"name": {
"description": "The displayable name of the user.",
"type": "string"
},
"permissionId": {
"description": "The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.",
"type": "string"
},
"photo": {
"$ref": "Photo",
"description": "The profile photo of the user. Not present if the user has no profile photo."
}
},
"type": "object"
}
},
"servicePath": "appsactivity/v1/",
"title": "Drive Activity API",
"version": "v1"
}

612
etc/api/appstate/v1/appstate-api.json
View File

@@ -1,307 +1,307 @@
{
"kind": "discovery#restDescription",
"etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/QVpS9PD25kYc1LPN2F9-_0rvV5Y\"",
"discoveryVersion": "v1",
"id": "appstate:v1",
"name": "appstate",
"canonicalName": "App State",
"version": "v1",
"revision": "20181004",
"title": "Google App State API",
"description": "The Google App State API.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
"documentationLink": "https://developers.google.com/games/services/web/api/states",
"protocol": "rest",
"baseUrl": "https://www.googleapis.com/appstate/v1/",
"basePath": "/appstate/v1/",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "appstate/v1/",
"batchPath": "batch/appstate/v1",
"parameters": {
"alt": {
"type": "string",
"description": "Data format for the response.",
"default": "json",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"key": {
"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.",
"location": "query"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query"
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead.",
"location": "query"
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/appstate": {
"description": "View and manage your data for this application"
}
}
}
},
"schemas": {
"GetResponse": {
"id": "GetResponse",
"type": "object",
"description": "This is a JSON template for an app state resource.",
"properties": {
"currentStateVersion": {
"type": "string",
"description": "The current app state version."
},
"data": {
"type": "string",
"description": "The requested data."
},
"kind": {
"type": "string",
"description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#getResponse.",
"default": "appstate#getResponse"
},
"stateKey": {
"type": "integer",
"description": "The key for the data.",
"format": "int32"
}
}
},
"ListResponse": {
"id": "ListResponse",
"type": "object",
"description": "This is a JSON template to convert a list-response for app state.",
"properties": {
"items": {
"type": "array",
"description": "The app state data.",
"items": {
"$ref": "GetResponse"
}
},
"kind": {
"type": "string",
"description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#listResponse.",
"default": "appstate#listResponse"
},
"maximumKeyCount": {
"type": "integer",
"description": "The maximum number of keys allowed for this user.",
"format": "int32"
}
}
},
"UpdateRequest": {
"id": "UpdateRequest",
"type": "object",
"description": "This is a JSON template for a requests which update app state",
"properties": {
"data": {
"type": "string",
"description": "The new app state data that your application is trying to update with."
},
"kind": {
"type": "string",
"description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#updateRequest.",
"default": "appstate#updateRequest"
}
}
},
"WriteResult": {
"id": "WriteResult",
"type": "object",
"description": "This is a JSON template for an app state write result.",
"properties": {
"currentStateVersion": {
"type": "string",
"description": "The version of the data for this key on the server."
},
"kind": {
"type": "string",
"description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#writeResult.",
"default": "appstate#writeResult"
},
"stateKey": {
"type": "integer",
"description": "The written key.",
"format": "int32"
}
}
}
},
"resources": {
"states": {
"methods": {
"clear": {
"id": "appstate.states.clear",
"path": "states/{stateKey}/clear",
"httpMethod": "POST",
"description": "Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.",
"parameters": {
"currentDataVersion": {
"type": "string",
"description": "The version of the data to be cleared. Version strings are returned by the server.",
"location": "query"
},
"stateKey": {
"type": "integer",
"description": "The key for the data to be retrieved.",
"required": true,
"format": "int32",
"minimum": "0",
"maximum": "3",
"location": "path"
}
},
"parameterOrder": [
"stateKey"
],
"response": {
"$ref": "WriteResult"
},
"scopes": [
"https://www.googleapis.com/auth/appstate"
]
},
"delete": {
"id": "appstate.states.delete",
"path": "states/{stateKey}",
"httpMethod": "DELETE",
"description": "Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption.",
"parameters": {
"stateKey": {
"type": "integer",
"description": "The key for the data to be retrieved.",
"required": true,
"format": "int32",
"minimum": "0",
"maximum": "3",
"location": "path"
}
},
"parameterOrder": [
"stateKey"
],
"scopes": [
"https://www.googleapis.com/auth/appstate"
]
},
"get": {
"id": "appstate.states.get",
"path": "states/{stateKey}",
"httpMethod": "GET",
"description": "Retrieves the data corresponding to the passed key. If the key does not exist on the server, an HTTP 404 will be returned.",
"parameters": {
"stateKey": {
"type": "integer",
"description": "The key for the data to be retrieved.",
"required": true,
"format": "int32",
"minimum": "0",
"maximum": "3",
"location": "path"
}
},
"parameterOrder": [
"stateKey"
],
"response": {
"$ref": "GetResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appstate"
]
},
"list": {
"id": "appstate.states.list",
"path": "states",
"httpMethod": "GET",
"description": "Lists all the states keys, and optionally the state data.",
"parameters": {
"includeData": {
"type": "boolean",
"description": "Whether to include the full data in addition to the version number",
"default": "false",
"location": "query"
}
},
"response": {
"$ref": "ListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appstate"
]
},
"update": {
"id": "appstate.states.update",
"path": "states/{stateKey}",
"httpMethod": "PUT",
"description": "Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB.",
"parameters": {
"currentStateVersion": {
"type": "string",
"description": "The version of the app state your application is attempting to update. If this does not match the current version, this method will return a conflict error. If there is no data stored on the server for this key, the update will succeed irrespective of the value of this parameter.",
"location": "query"
},
"stateKey": {
"type": "integer",
"description": "The key for the data to be retrieved.",
"required": true,
"format": "int32",
"minimum": "0",
"maximum": "3",
"location": "path"
}
},
"parameterOrder": [
"stateKey"
],
"request": {
"$ref": "UpdateRequest"
},
"response": {
"$ref": "WriteResult"
},
"scopes": [
"https://www.googleapis.com/auth/appstate"
]
}
}
}
}
}
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/appstate": {
"description": "View and manage your data for this application"
}
}
}
},
"basePath": "/appstate/v1/",
"baseUrl": "https://www.googleapis.com/appstate/v1/",
"batchPath": "batch/appstate/v1",
"canonicalName": "App State",
"description": "The Google App State API.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/games/services/web/api/states",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/swZo7JM2ROZKlpCcnTqj1lpN-m0\"",
"icons": {
"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
"id": "appstate:v1",
"kind": "discovery#restDescription",
"name": "appstate",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"alt": {
"default": "json",
"description": "Data format for the response.",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query",
"type": "string"
},
"userIp": {
"description": "Deprecated. Please use quotaUser instead.",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"states": {
"methods": {
"clear": {
"description": "Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.",
"httpMethod": "POST",
"id": "appstate.states.clear",
"parameterOrder": [
"stateKey"
],
"parameters": {
"currentDataVersion": {
"description": "The version of the data to be cleared. Version strings are returned by the server.",
"location": "query",
"type": "string"
},
"stateKey": {
"description": "The key for the data to be retrieved.",
"format": "int32",
"location": "path",
"maximum": "3",
"minimum": "0",
"required": true,
"type": "integer"
}
},
"path": "states/{stateKey}/clear",
"response": {
"$ref": "WriteResult"
},
"scopes": [
"https://www.googleapis.com/auth/appstate"
]
},
"delete": {
"description": "Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption.",
"httpMethod": "DELETE",
"id": "appstate.states.delete",
"parameterOrder": [
"stateKey"
],
"parameters": {
"stateKey": {
"description": "The key for the data to be retrieved.",
"format": "int32",
"location": "path",
"maximum": "3",
"minimum": "0",
"required": true,
"type": "integer"
}
},
"path": "states/{stateKey}",
"scopes": [
"https://www.googleapis.com/auth/appstate"
]
},
"get": {
"description": "Retrieves the data corresponding to the passed key. If the key does not exist on the server, an HTTP 404 will be returned.",
"httpMethod": "GET",
"id": "appstate.states.get",
"parameterOrder": [
"stateKey"
],
"parameters": {
"stateKey": {
"description": "The key for the data to be retrieved.",
"format": "int32",
"location": "path",
"maximum": "3",
"minimum": "0",
"required": true,
"type": "integer"
}
},
"path": "states/{stateKey}",
"response": {
"$ref": "GetResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appstate"
]
},
"list": {
"description": "Lists all the states keys, and optionally the state data.",
"httpMethod": "GET",
"id": "appstate.states.list",
"parameters": {
"includeData": {
"default": "false",
"description": "Whether to include the full data in addition to the version number",
"location": "query",
"type": "boolean"
}
},
"path": "states",
"response": {
"$ref": "ListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appstate"
]
},
"update": {
"description": "Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB.",
"httpMethod": "PUT",
"id": "appstate.states.update",
"parameterOrder": [
"stateKey"
],
"parameters": {
"currentStateVersion": {
"description": "The version of the app state your application is attempting to update. If this does not match the current version, this method will return a conflict error. If there is no data stored on the server for this key, the update will succeed irrespective of the value of this parameter.",
"location": "query",
"type": "string"
},
"stateKey": {
"description": "The key for the data to be retrieved.",
"format": "int32",
"location": "path",
"maximum": "3",
"minimum": "0",
"required": true,
"type": "integer"
}
},
"path": "states/{stateKey}",
"request": {
"$ref": "UpdateRequest"
},
"response": {
"$ref": "WriteResult"
},
"scopes": [
"https://www.googleapis.com/auth/appstate"
]
}
}
}
},
"revision": "20190328",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"GetResponse": {
"description": "This is a JSON template for an app state resource.",
"id": "GetResponse",
"properties": {
"currentStateVersion": {
"description": "The current app state version.",
"type": "string"
},
"data": {
"description": "The requested data.",
"type": "string"
},
"kind": {
"default": "appstate#getResponse",
"description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#getResponse.",
"type": "string"
},
"stateKey": {
"description": "The key for the data.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ListResponse": {
"description": "This is a JSON template to convert a list-response for app state.",
"id": "ListResponse",
"properties": {
"items": {
"description": "The app state data.",
"items": {
"$ref": "GetResponse"
},
"type": "array"
},
"kind": {
"default": "appstate#listResponse",
"description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#listResponse.",
"type": "string"
},
"maximumKeyCount": {
"description": "The maximum number of keys allowed for this user.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"UpdateRequest": {
"description": "This is a JSON template for a requests which update app state",
"id": "UpdateRequest",
"properties": {
"data": {
"description": "The new app state data that your application is trying to update with.",
"type": "string"
},
"kind": {
"default": "appstate#updateRequest",
"description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#updateRequest.",
"type": "string"
}
},
"type": "object"
},
"WriteResult": {
"description": "This is a JSON template for an app state write result.",
"id": "WriteResult",
"properties": {
"currentStateVersion": {
"description": "The version of the data for this key on the server.",
"type": "string"
},
"kind": {
"default": "appstate#writeResult",
"description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#writeResult.",
"type": "string"
},
"stateKey": {
"description": "The written key.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
}
},
"servicePath": "appstate/v1/",
"title": "Google App State API",
"version": "v1"
}

7668
etc/api/bigquery/v2/bigquery-api.json
View File

File diff suppressed because it is too large Load Diff

3662
etc/api/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
View File

File diff suppressed because it is too large Load Diff

521
etc/api/bigtableadmin/v1/bigtableadmin-api.json Normal file
View File

@@ -0,0 +1,521 @@
{
"basePath": "",
"baseUrl": "https://bigtableadmin.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Bigtable Admin",
"description": "Administer your Cloud Bigtable tables and instances.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/bigtable/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "bigtableadmin:v1",
"kind": "discovery#restDescription",
"name": "bigtableadmin",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"get": {
"description": "Gets information about a location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "bigtableadmin.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Location"
}
},
"list": {
"description": "Lists information about the supported locations for this service.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "bigtableadmin.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/locations",
"response": {
"$ref": "ListLocationsResponse"
}
}
}
}
}
}
},
"revision": "20190328",
"rootUrl": "https://bigtableadmin.googleapis.com/",
"schemas": {
"Cluster": {
"description": "A resizable group of nodes in a particular cloud location, capable\nof serving all Tables in the parent\nInstance.",
"id": "Cluster",
"properties": {
"defaultStorageType": {
"description": "(`CreationOnly`)\nThe type of storage used by this cluster to serve its\nparent instance's tables, unless explicitly overridden.",
"enum": [
"STORAGE_TYPE_UNSPECIFIED",
"SSD",
"HDD"
],
"enumDescriptions": [
"The user did not specify a storage type.",
"Flash (SSD) storage should be used.",
"Magnetic drive (HDD) storage should be used."
],
"type": "string"
},
"location": {
"description": "(`CreationOnly`)\nThe location where this cluster's nodes and storage reside. For best\nperformance, clients should be located as close as possible to this\ncluster. Currently only zones are supported, so values should be of the\nform `projects/<project>/locations/<zone>`.",
"type": "string"
},
"name": {
"description": "(`OutputOnly`)\nThe unique name of the cluster. Values are of the form\n`projects/<project>/instances/<instance>/clusters/a-z*`.",
"type": "string"
},
"serveNodes": {
"description": "The number of nodes allocated to this cluster. More nodes enable higher\nthroughput and more consistent performance.",
"format": "int32",
"type": "integer"
},
"state": {
"description": "(`OutputOnly`)\nThe current state of the cluster.",
"enum": [
"STATE_NOT_KNOWN",
"READY",
"CREATING",
"RESIZING",
"DISABLED"
],
"enumDescriptions": [
"The state of the cluster could not be determined.",
"The cluster has been successfully created and is ready to serve requests.",
"The cluster is currently being created, and may be destroyed\nif the creation process encounters an error.\nA cluster may not be able to serve requests while being created.",
"The cluster is currently being resized, and may revert to its previous\nnode count if the process encounters an error.\nA cluster is still capable of serving requests while being resized,\nbut may exhibit performance as if its number of allocated nodes is\nbetween the starting and requested states.",
"The cluster has no backing nodes. The data (tables) still\nexist, but no operations can be performed on the cluster."
],
"type": "string"
}
},
"type": "object"
},
"CreateClusterMetadata": {
"description": "The metadata for the Operation returned by CreateCluster.",
"id": "CreateClusterMetadata",
"properties": {
"finishTime": {
"description": "The time at which the operation failed or was completed successfully.",
"format": "google-datetime",
"type": "string"
},
"originalRequest": {
"$ref": "CreateClusterRequest",
"description": "The request that prompted the initiation of this CreateCluster operation."
},
"requestTime": {
"description": "The time at which the original request was received.",
"format": "google-datetime",
"type": "string"
},
"tables": {
"additionalProperties": {
"$ref": "TableProgress"
},
"description": "Keys: the full `name` of each table that existed in the instance when\nCreateCluster was first called, i.e.\n`projects/<project>/instances/<instance>/tables/<table>`. Any table added\nto the instance by a later API call will be created in the new cluster by\nthat API call, not this one.\n\nValues: information on how much of a table's data has been copied to the\nnewly-created cluster so far.",
"type": "object"
}
},
"type": "object"
},
"CreateClusterRequest": {
"description": "Request message for BigtableInstanceAdmin.CreateCluster.",
"id": "CreateClusterRequest",
"properties": {
"cluster": {
"$ref": "Cluster",
"description": "The cluster to be created.\nFields marked `OutputOnly` must be left blank."
},
"clusterId": {
"description": "The ID to be used when referring to the new cluster within its instance,\ne.g., just `mycluster` rather than\n`projects/myproject/instances/myinstance/clusters/mycluster`.",
"type": "string"
},
"parent": {
"description": "The unique name of the instance in which to create the new cluster.\nValues are of the form\n`projects/<project>/instances/<instance>`.",
"type": "string"
}
},
"type": "object"
},
"CreateInstanceMetadata": {
"description": "The metadata for the Operation returned by CreateInstance.",
"id": "CreateInstanceMetadata",
"properties": {
"finishTime": {
"description": "The time at which the operation failed or was completed successfully.",
"format": "google-datetime",
"type": "string"
},
"originalRequest": {
"$ref": "CreateInstanceRequest",
"description": "The request that prompted the initiation of this CreateInstance operation."
},
"requestTime": {
"description": "The time at which the original request was received.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"CreateInstanceRequest": {
"description": "Request message for BigtableInstanceAdmin.CreateInstance.",
"id": "CreateInstanceRequest",
"properties": {
"clusters": {
"additionalProperties": {
"$ref": "Cluster"
},
"description": "The clusters to be created within the instance, mapped by desired\ncluster ID, e.g., just `mycluster` rather than\n`projects/myproject/instances/myinstance/clusters/mycluster`.\nFields marked `OutputOnly` must be left blank.\nCurrently, at most two clusters can be specified.",
"type": "object"
},
"instance": {
"$ref": "Instance",
"description": "The instance to create.\nFields marked `OutputOnly` must be left blank."
},
"instanceId": {
"description": "The ID to be used when referring to the new instance within its project,\ne.g., just `myinstance` rather than\n`projects/myproject/instances/myinstance`.",
"type": "string"
},
"parent": {
"description": "The unique name of the project in which to create the new instance.\nValues are of the form `projects/<project>`.",
"type": "string"
}
},
"type": "object"
},
"Instance": {
"description": "A collection of Bigtable Tables and\nthe resources that serve them.\nAll tables in an instance are served from all\nClusters in the instance.",
"id": "Instance",
"properties": {
"displayName": {
"description": "The descriptive name for this instance as it appears in UIs.\nCan be changed at any time, but should be kept globally unique\nto avoid confusion.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. They can be used to filter resources and aggregate\nmetrics.\n\n* Label keys must be between 1 and 63 characters long and must conform to\n the regular expression: `\\p{Ll}\\p{Lo}{0,62}`.\n* Label values must be between 0 and 63 characters long and must conform to\n the regular expression: `[\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}`.\n* No more than 64 labels can be associated with a given resource.\n* Keys and values must both be under 128 bytes.",
"type": "object"
},
"name": {
"description": "(`OutputOnly`)\nThe unique name of the instance. Values are of the form\n`projects/<project>/instances/a-z+[a-z0-9]`.",
"type": "string"
},
"state": {
"description": "(`OutputOnly`)\nThe current state of the instance.",
"enum": [
"STATE_NOT_KNOWN",
"READY",
"CREATING"
],
"enumDescriptions": [
"The state of the instance could not be determined.",
"The instance has been successfully created and can serve requests\nto its tables.",
"The instance is currently being created, and may be destroyed\nif the creation process encounters an error."
],
"type": "string"
},
"type": {
"description": "The type of the instance. Defaults to `PRODUCTION`.",
"enum": [
"TYPE_UNSPECIFIED",
"PRODUCTION",
"DEVELOPMENT"
],
"enumDescriptions": [
"The type of the instance is unspecified. If set when creating an\ninstance, a `PRODUCTION` instance will be created. If set when updating\nan instance, the type will be left unchanged.",
"An instance meant for production use. `serve_nodes` must be set\non the cluster.",
"The instance is meant for development and testing purposes only; it has\nno performance or uptime guarantees and is not covered by SLA.\nAfter a development instance is created, it can be upgraded by\nupdating the instance to type `PRODUCTION`. An instance created\nas a production instance cannot be changed to a development instance.\nWhen creating a development instance, `serve_nodes` on the cluster must\nnot be set."
],
"type": "string"
}
},
"type": "object"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "ListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"id": "Location",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name.\nFor example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"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"
},
"name": {
"description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"type": "object"
},
"PartialUpdateInstanceRequest": {
"description": "Request message for BigtableInstanceAdmin.PartialUpdateInstance.",
"id": "PartialUpdateInstanceRequest",
"properties": {
"instance": {
"$ref": "Instance",
"description": "The Instance which will (partially) replace the current value."
},
"updateMask": {
"description": "The subset of Instance fields which should be replaced.\nMust be explicitly set.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"TableProgress": {
"description": "Progress info for copying a table's data to the new cluster.",
"id": "TableProgress",
"properties": {
"estimatedCopiedBytes": {
"description": "Estimate of the number of bytes copied so far for this table.\nThis will eventually reach 'estimated_size_bytes' unless the table copy\nis CANCELLED.",
"format": "int64",
"type": "string"
},
"estimatedSizeBytes": {
"description": "Estimate of the size of the table to be copied.",
"format": "int64",
"type": "string"
},
"state": {
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"COPYING",
"COMPLETED",
"CANCELLED"
],
"enumDescriptions": [
"",
"The table has not yet begun copying to the new cluster.",
"The table is actively being copied to the new cluster.",
"The table has been fully copied to the new cluster.",
"The table was deleted before it finished copying to the new cluster.\nNote that tables deleted after completion will stay marked as\nCOMPLETED, not CANCELLED."
],
"type": "string"
}
},
"type": "object"
},
"UpdateAppProfileMetadata": {
"description": "The metadata for the Operation returned by UpdateAppProfile.",
"id": "UpdateAppProfileMetadata",
"properties": {},
"type": "object"
},
"UpdateClusterMetadata": {
"description": "The metadata for the Operation returned by UpdateCluster.",
"id": "UpdateClusterMetadata",
"properties": {
"finishTime": {
"description": "The time at which the operation failed or was completed successfully.",
"format": "google-datetime",
"type": "string"
},
"originalRequest": {
"$ref": "Cluster",
"description": "The request that prompted the initiation of this UpdateCluster operation."
},
"requestTime": {
"description": "The time at which the original request was received.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"UpdateInstanceMetadata": {
"description": "The metadata for the Operation returned by UpdateInstance.",
"id": "UpdateInstanceMetadata",
"properties": {
"finishTime": {
"description": "The time at which the operation failed or was completed successfully.",
"format": "google-datetime",
"type": "string"
},
"originalRequest": {
"$ref": "PartialUpdateInstanceRequest",
"description": "The request that prompted the initiation of this UpdateInstance operation."
},
"requestTime": {
"description": "The time at which the original request was received.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud Bigtable Admin API",
"version": "v1",
"version_module": true
}

2303
etc/api/bigtableadmin/v2/bigtableadmin-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

1597
etc/api/binaryauthorization/v1beta1/binaryauthorization-api.json
View File

File diff suppressed because it is too large Load Diff

1836
etc/api/blogger/v2/blogger-api.json
View File

File diff suppressed because it is too large Load Diff

5006
etc/api/blogger/v3/blogger-api.json
View File

File diff suppressed because it is too large Load Diff

9494
etc/api/books/v1/books-api.json
View File

File diff suppressed because it is too large Load Diff

5956
etc/api/calendar/v3/calendar-api.json
View File

File diff suppressed because it is too large Load Diff

2208
etc/api/chat/v1/chat-api.json
View File

File diff suppressed because it is too large Load Diff

3240
etc/api/civicinfo/v2/civicinfo-api.json
View File

File diff suppressed because it is too large Load Diff

7118
etc/api/classroom/v1/classroom-api.json
View File

File diff suppressed because it is too large Load Diff

583
etc/api/cloudasset/v1/cloudasset-api.json Normal file
View File

@@ -0,0 +1,583 @@
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"basePath": "",
"baseUrl": "https://cloudasset.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Asset",
"description": "The cloud asset API manages the history and inventory of cloud resources.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/quickstart-cloud-asset-inventory",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "cloudasset:v1",
"kind": "discovery#restDescription",
"name": "cloudasset",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"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.",
"flatPath": "v1/{v1Id}/{v1Id1}/operations/{operationsId}/{operationsId1}",
"httpMethod": "GET",
"id": "cloudasset.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^[^/]+/[^/]+/operations/[^/]+/.+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"v1": {
"methods": {
"batchGetAssetsHistory": {
"description": "Batch gets the update history of assets that overlap a time window.\nFor RESOURCE content, this API outputs history with asset in both\nnon-delete or deleted status.\nFor IAM_POLICY content, this API outputs history when the asset and its\nattached IAM POLICY both exist. This can create gaps in the output history.\nIf a specified asset does not exist, this API returns an INVALID_ARGUMENT\nerror.",
"flatPath": "v1/{v1Id}/{v1Id1}:batchGetAssetsHistory",
"httpMethod": "GET",
"id": "cloudasset.batchGetAssetsHistory",
"parameterOrder": [
"parent"
],
"parameters": {
"assetNames": {
"description": "A list of the full names of the assets. For example:\n`//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.\nSee [Resource\nNames](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nand [Resource Name Format](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/resource-name-format)\nfor more info.\n\nThe request becomes a no-op if the asset name list is empty, and the max\nsize of the asset name list is 100 in one request.",
"location": "query",
"repeated": true,
"type": "string"
},
"contentType": {
"description": "Required. The content type.",
"enum": [
"CONTENT_TYPE_UNSPECIFIED",
"RESOURCE",
"IAM_POLICY"
],
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The relative name of the root asset. It can only be an\norganization number (such as \"organizations/123\"), a project ID (such as\n\"projects/my-project-id\")\", or a project number (such as \"projects/12345\").",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
"type": "string"
},
"readTimeWindow.endTime": {
"description": "End time of the time window (inclusive).\nCurrent timestamp if not specified.",
"format": "google-datetime",
"location": "query",
"type": "string"
},
"readTimeWindow.startTime": {
"description": "Start time of the time window (exclusive).",
"format": "google-datetime",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}:batchGetAssetsHistory",
"response": {
"$ref": "BatchGetAssetsHistoryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"exportAssets": {
"description": "Exports assets with time and resource types to a given Cloud Storage\nlocation. The output format is newline-delimited JSON.\nThis API implements the google.longrunning.Operation API allowing you\nto keep track of the export.",
"flatPath": "v1/{v1Id}/{v1Id1}:exportAssets",
"httpMethod": "POST",
"id": "cloudasset.exportAssets",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The relative name of the root asset. This can only be an\norganization number (such as \"organizations/123\"), a project ID (such as\n\"projects/my-project-id\"), or a project number (such as \"projects/12345\"),\nor a folder number (such as \"folders/123\").",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:exportAssets",
"request": {
"$ref": "ExportAssetsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
},
"revision": "20190327",
"rootUrl": "https://cloudasset.googleapis.com/",
"schemas": {
"Asset": {
"description": "Cloud asset. This includes all Google Cloud Platform resources,\nCloud IAM policies, and other non-GCP assets.",
"id": "Asset",
"properties": {
"assetType": {
"description": "Type of the asset. Example: \"compute.googleapis.com/Disk\".",
"type": "string"
},
"iamPolicy": {
"$ref": "Policy",
"description": "Representation of the actual Cloud IAM policy set on a cloud resource. For\neach resource, there must be at most one Cloud IAM policy set on it."
},
"name": {
"description": "The full name of the asset. For example:\n`//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.\nSee [Resource\nNames](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nfor more information.",
"type": "string"
},
"resource": {
"$ref": "Resource",
"description": "Representation of the resource."
}
},
"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\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.",
"id": "AuditConfig",
"properties": {
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.",
"items": {
"$ref": "AuditLogConfig"
},
"type": "array"
},
"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"
}
},
"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.",
"id": "AuditLogConfig",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
"items": {
"type": "string"
},
"type": "array"
},
"logType": {
"description": "The log type that this config enables.",
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
"type": "string"
}
},
"type": "object"
},
"BatchGetAssetsHistoryResponse": {
"description": "Batch get assets history response.",
"id": "BatchGetAssetsHistoryResponse",
"properties": {
"assets": {
"description": "A list of assets with valid time windows.",
"items": {
"$ref": "TemporalAsset"
},
"type": "array"
}
},
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
},
"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` .\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}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
"type": "object"
},
"ExportAssetsRequest": {
"description": "Export asset request.",
"id": "ExportAssetsRequest",
"properties": {
"assetTypes": {
"description": "A list of asset types of which to take a snapshot for. For example:\n\"compute.googleapis.com/Disk\". If specified, only matching assets will be returned.\nSee [Introduction to Cloud Asset\nInventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview)\nfor all supported asset types.",
"items": {
"type": "string"
},
"type": "array"
},
"contentType": {
"description": "Asset content type. If not specified, no content but the asset name will be\nreturned.",
"enum": [
"CONTENT_TYPE_UNSPECIFIED",
"RESOURCE",
"IAM_POLICY"
],
"enumDescriptions": [
"Unspecified content type.",
"Resource metadata.",
"The actual IAM policy set on a resource."
],
"type": "string"
},
"outputConfig": {
"$ref": "OutputConfig",
"description": "Required. Output configuration indicating where the results will be output\nto. All results will be in newline delimited JSON format."
},
"readTime": {
"description": "Timestamp to take an asset snapshot. This can only be set to a timestamp\nbetween 2018-10-02 UTC (inclusive) and the current time. If not specified,\nthe current time will be used. Due to delays in resource data collection\nand indexing, there is a volatile window during which running the same\nquery may get different results.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Expr": {
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
"id": "Expr",
"properties": {
"description": {
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
"type": "string"
},
"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"
},
"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": "object"
},
"GcsDestination": {
"description": "A Cloud Storage location.",
"id": "GcsDestination",
"properties": {
"uri": {
"description": "The uri of the Cloud Storage object. It's the same uri that is used by\ngsutil. For example: \"gs://bucket_name/object_name\". See [Viewing and\nEditing Object\nMetadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)\nfor more information.",
"type": "string"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"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"
},
"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"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"OutputConfig": {
"description": "Output configuration for export assets destination.",
"id": "OutputConfig",
"properties": {
"gcsDestination": {
"$ref": "GcsDestination",
"description": "Destination on Cloud Storage."
}
},
"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**JSON 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\n**YAML Example**\n\n bindings:\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 role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
"id": "Policy",
"properties": {
"auditConfigs": {
"description": "Specifies cloud audit logging configuration for this policy.",
"items": {
"$ref": "AuditConfig"
},
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"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"
}
},
"type": "object"
},
"Resource": {
"description": "Representation of a cloud resource.",
"id": "Resource",
"properties": {
"data": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The content of the resource, in which some sensitive fields are scrubbed\naway and may not be present.",
"type": "object"
},
"discoveryDocumentUri": {
"description": "The URL of the discovery document containing the resource's JSON schema.\nFor example:\n`\"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest\"`.\nIt will be left unspecified for resources without a discovery-based API,\nsuch as Cloud Bigtable.",
"type": "string"
},
"discoveryName": {
"description": "The JSON schema name listed in the discovery document.\nExample: \"Project\". It will be left unspecified for resources (such as\nCloud Bigtable) without a discovery-based API.",
"type": "string"
},
"parent": {
"description": "The full name of the immediate parent of this resource. See\n[Resource\nNames](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nfor more information.\n\nFor GCP assets, it is the parent resource defined in the [Cloud IAM policy\nhierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).\nFor example:\n`\"//cloudresourcemanager.googleapis.com/projects/my_project_123\"`.\n\nFor third-party assets, it is up to the users to define.",
"type": "string"
},
"resourceUrl": {
"description": "The REST URL for accessing the resource. An HTTP GET operation using this\nURL returns the resource itself.\nExample:\n`https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`.\nIt will be left unspecified for resources without a REST API.",
"type": "string"
},
"version": {
"description": "The API version. Example: \"v1\".",
"type": "string"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error\nmessage, and error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"TemporalAsset": {
"description": "Temporal asset. In addition to the asset, the temporal asset includes the\nstatus of the asset and valid from and to time of it.",
"id": "TemporalAsset",
"properties": {
"asset": {
"$ref": "Asset",
"description": "Asset."
},
"deleted": {
"description": "If the asset is deleted or not.",
"type": "boolean"
},
"window": {
"$ref": "TimeWindow",
"description": "The time window when the asset data and state was observed."
}
},
"type": "object"
},
"TimeWindow": {
"description": "A time window of (start_time, end_time].",
"id": "TimeWindow",
"properties": {
"endTime": {
"description": "End time of the time window (inclusive).\nCurrent timestamp if not specified.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Start time of the time window (exclusive).",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud Asset API",
"version": "v1",
"version_module": true
}

1445
etc/api/cloudasset/v1beta1/cloudasset-api.json
View File

File diff suppressed because it is too large Load Diff

2000
etc/api/cloudbilling/v1/cloudbilling-api.json
View File

File diff suppressed because it is too large Load Diff

2911
etc/api/cloudbuild/v1/cloudbuild-api.json
View File

File diff suppressed because it is too large Load Diff

1061
etc/api/cloudbuild/v1alpha1/cloudbuild-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

2086
etc/api/clouddebugger/v2/clouddebugger-api.json
View File

File diff suppressed because it is too large Load Diff

1464
etc/api/clouderrorreporting/v1beta1/clouderrorreporting-api.json
View File

File diff suppressed because it is too large Load Diff

2139
etc/api/cloudfunctions/v1/cloudfunctions-api.json
View File

File diff suppressed because it is too large Load Diff

1914
etc/api/cloudfunctions/v1beta2/cloudfunctions-api.json
View File

File diff suppressed because it is too large Load Diff

743
etc/api/cloudidentity/v1/cloudidentity-api.json Normal file
View File

@@ -0,0 +1,743 @@
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-identity.groups": {
"description": "See, change, create, and delete any of the Cloud Identity Groups that you can access, including the members of each group"
},
"https://www.googleapis.com/auth/cloud-identity.groups.readonly": {
"description": "See any Cloud Identity Groups that you can access, including group members and their emails"
}
}
}
},
"basePath": "",
"baseUrl": "https://cloudidentity.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Identity",
"description": "API for provisioning and managing identity resources.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/identity/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "cloudidentity:v1",
"kind": "discovery#restDescription",
"name": "cloudidentity",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"groups": {
"methods": {
"create": {
"description": "Creates a Group.",
"flatPath": "v1/groups",
"httpMethod": "POST",
"id": "cloudidentity.groups.create",
"parameterOrder": [],
"parameters": {},
"path": "v1/groups",
"request": {
"$ref": "Group"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups"
]
},
"delete": {
"description": "Deletes a Group.",
"flatPath": "v1/groups/{groupsId}",
"httpMethod": "DELETE",
"id": "cloudidentity.groups.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where `group_id` is the unique ID\nassigned to the Group.",
"location": "path",
"pattern": "^groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups"
]
},
"get": {
"description": "Retrieves a Group.",
"flatPath": "v1/groups/{groupsId}",
"httpMethod": "GET",
"id": "cloudidentity.groups.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where `group_id` is the unique ID\nassigned to the Group.",
"location": "path",
"pattern": "^groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Group"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups",
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
]
},
"list": {
"description": "List groups within a customer or a domain.",
"flatPath": "v1/groups",
"httpMethod": "GET",
"id": "cloudidentity.groups.list",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "The default page size is 200 (max 1000) for the BASIC view, and 50\n(max 500) for the FULL view.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous list request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "`Required`. May be made Optional in the future.\nCustomer ID to list all groups from.",
"location": "query",
"type": "string"
},
"view": {
"description": "Group resource view to be returned. Defaults to [View.BASIC]().",
"enum": [
"VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"location": "query",
"type": "string"
}
},
"path": "v1/groups",
"response": {
"$ref": "ListGroupsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups",
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
]
},
"lookup": {
"description": "Looks up [resource\nname](https://cloud.google.com/apis/design/resource_names) of a Group by\nits EntityKey.",
"flatPath": "v1/groups:lookup",
"httpMethod": "GET",
"id": "cloudidentity.groups.lookup",
"parameterOrder": [],
"parameters": {
"groupKey.id": {
"description": "The ID of the entity within the given namespace. The ID must be unique\nwithin its namespace.",
"location": "query",
"type": "string"
},
"groupKey.namespace": {
"description": "Namespaces provide isolation for IDs, so an ID only needs to be unique\nwithin its namespace.\n\nNamespaces are currently only created as part of IdentitySource creation\nfrom Admin Console. A namespace `\"identitysources/{identity_source_id}\"` is\ncreated corresponding to every Identity Source `identity_source_id`.",
"location": "query",
"type": "string"
}
},
"path": "v1/groups:lookup",
"response": {
"$ref": "LookupGroupNameResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups",
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
]
},
"patch": {
"description": "Updates a Group.",
"flatPath": "v1/groups/{groupsId}",
"httpMethod": "PATCH",
"id": "cloudidentity.groups.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where group_id is the unique ID\nassigned to the Group.\n\nMust be left blank while creating a Group.",
"location": "path",
"pattern": "^groups/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Editable fields: `display_name`, `description`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Group"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups"
]
},
"search": {
"description": "Searches for Groups.",
"flatPath": "v1/groups:search",
"httpMethod": "GET",
"id": "cloudidentity.groups.search",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "The default page size is 200 (max 1000) for the BASIC view, and 50\n(max 500) for the FULL view.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous search request, if any.",
"location": "query",
"type": "string"
},
"query": {
"description": "`Required`. Query string for performing search on groups. Users can search\non parent and label attributes of groups.\nEXACT match ('==') is supported on parent, and CONTAINS match ('in') is\nsupported on labels.",
"location": "query",
"type": "string"
},
"view": {
"description": "Group resource view to be returned. Defaults to [View.BASIC]().",
"enum": [
"VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"location": "query",
"type": "string"
}
},
"path": "v1/groups:search",
"response": {
"$ref": "SearchGroupsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups",
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
]
}
},
"resources": {
"memberships": {
"methods": {
"create": {
"description": "Creates a Membership.",
"flatPath": "v1/groups/{groupsId}/memberships",
"httpMethod": "POST",
"id": "cloudidentity.groups.memberships.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to create Membership within. Format: `groups/{group_id}`, where\n`group_id` is the unique ID assigned to the Group.",
"location": "path",
"pattern": "^groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/memberships",
"request": {
"$ref": "Membership"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups"
]
},
"delete": {
"description": "Deletes a Membership.",
"flatPath": "v1/groups/{groupsId}/memberships/{membershipsId}",
"httpMethod": "DELETE",
"id": "cloudidentity.groups.memberships.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership to be deleted.\n\nFormat: `groups/{group_id}/memberships/{member_id}`, where `group_id` is\nthe unique ID assigned to the Group to which Membership belongs to, and\nmember_id is the unique ID assigned to the member.",
"location": "path",
"pattern": "^groups/[^/]+/memberships/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups"
]
},
"get": {
"description": "Retrieves a Membership.",
"flatPath": "v1/groups/{groupsId}/memberships/{membershipsId}",
"httpMethod": "GET",
"id": "cloudidentity.groups.memberships.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership to be retrieved.\n\nFormat: `groups/{group_id}/memberships/{member_id}`, where `group_id` is\nthe unique id assigned to the Group to which Membership belongs to, and\n`member_id` is the unique ID assigned to the member.",
"location": "path",
"pattern": "^groups/[^/]+/memberships/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Membership"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups",
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
]
},
"list": {
"description": "List Memberships within a Group.",
"flatPath": "v1/groups/{groupsId}/memberships",
"httpMethod": "GET",
"id": "cloudidentity.groups.memberships.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The default page size is 200 (max 1000) for the BASIC view, and 50\n(max 500) for the FULL view.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous list request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to list Memberships within.\n\nFormat: `groups/{group_id}`, where `group_id` is the unique ID assigned to\nthe Group.",
"location": "path",
"pattern": "^groups/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Membership resource view to be returned. Defaults to View.BASIC.",
"enum": [
"VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/memberships",
"response": {
"$ref": "ListMembershipsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups",
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
]
},
"lookup": {
"description": "Looks up [resource\nname](https://cloud.google.com/apis/design/resource_names) of a Membership\nwithin a Group by member's EntityKey.",
"flatPath": "v1/groups/{groupsId}/memberships:lookup",
"httpMethod": "GET",
"id": "cloudidentity.groups.memberships.lookup",
"parameterOrder": [
"parent"
],
"parameters": {
"memberKey.id": {
"description": "The ID of the entity within the given namespace. The ID must be unique\nwithin its namespace.",
"location": "query",
"type": "string"
},
"memberKey.namespace": {
"description": "Namespaces provide isolation for IDs, so an ID only needs to be unique\nwithin its namespace.\n\nNamespaces are currently only created as part of IdentitySource creation\nfrom Admin Console. A namespace `\"identitysources/{identity_source_id}\"` is\ncreated corresponding to every Identity Source `identity_source_id`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to lookup Membership within.\n\nFormat: `groups/{group_id}`, where `group_id` is the unique ID assigned to\nthe Group.",
"location": "path",
"pattern": "^groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/memberships:lookup",
"response": {
"$ref": "LookupMembershipNameResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups",
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
]
}
}
}
}
}
},
"revision": "20190330",
"rootUrl": "https://cloudidentity.googleapis.com/",
"schemas": {
"EntityKey": {
"description": "An EntityKey uniquely identifies an Entity. Namespaces are used to provide\nisolation for IDs. A single ID can be reused across namespaces but the\ncombination of a namespace and an ID must be unique.",
"id": "EntityKey",
"properties": {
"id": {
"description": "The ID of the entity within the given namespace. The ID must be unique\nwithin its namespace.",
"type": "string"
},
"namespace": {
"description": "Namespaces provide isolation for IDs, so an ID only needs to be unique\nwithin its namespace.\n\nNamespaces are currently only created as part of IdentitySource creation\nfrom Admin Console. A namespace `\"identitysources/{identity_source_id}\"` is\ncreated corresponding to every Identity Source `identity_source_id`.",
"type": "string"
}
},
"type": "object"
},
"Group": {
"description": "Resource representing a Group.",
"id": "Group",
"properties": {
"createTime": {
"description": "The time when the Group was created.\nOutput only.",
"format": "google-datetime",
"type": "string"
},
"description": {
"description": "An extended description to help users determine the purpose of a Group. For\nexample, you can include information about who should join the Group, the\ntypes of messages to send to the Group, links to FAQs about the Group, or\nrelated Groups. Maximum length is 4,096 characters.",
"type": "string"
},
"displayName": {
"description": "The Group's display name.",
"type": "string"
},
"groupKey": {
"$ref": "EntityKey",
"description": "EntityKey of the Group.\n\nMust be set when creating a Group, read-only afterwards."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "`Required`. Labels for Group resource.\nFor creating Groups under a namespace, set label key to\n'labels/system/groups/external' and label value as empty.",
"type": "object"
},
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where group_id is the unique ID\nassigned to the Group.\n\nMust be left blank while creating a Group.",
"type": "string"
},
"parent": {
"description": "The entity under which this Group resides in Cloud Identity resource\nhierarchy. Must be set when creating a Group, read-only afterwards.\n\nCurrently allowed types: `identitysources`.",
"type": "string"
},
"updateTime": {
"description": "The time when the Group was last updated.\nOutput only.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"ListGroupsResponse": {
"description": "Response message for ListGroups operation.",
"id": "ListGroupsResponse",
"properties": {
"groups": {
"description": "Groups returned in response to list request.\nThe results are not sorted.",
"items": {
"$ref": "Group"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results available for listing.",
"type": "string"
}
},
"type": "object"
},
"ListMembershipsResponse": {
"id": "ListMembershipsResponse",
"properties": {
"memberships": {
"description": "List of Memberships.",
"items": {
"$ref": "Membership"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results available for listing.",
"type": "string"
}
},
"type": "object"
},
"LookupGroupNameResponse": {
"id": "LookupGroupNameResponse",
"properties": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where `group_id` is the unique ID\nassigned to the Group.",
"type": "string"
}
},
"type": "object"
},
"LookupMembershipNameResponse": {
"id": "LookupMembershipNameResponse",
"properties": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership being looked up.\n\nFormat: `groups/{group_id}/memberships/{member_id}`, where `group_id` is\nthe unique ID assigned to the Group to which Membership belongs to, and\n`member_id` is the unique ID assigned to the member.",
"type": "string"
}
},
"type": "object"
},
"Membership": {
"description": "Resource representing a Membership within a Group",
"id": "Membership",
"properties": {
"createTime": {
"description": "Creation timestamp of the Membership. Output only.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership in the format: `groups/{group_id}/memberships/{member_id}`,\nwhere group_id is the unique ID assigned to the Group to which Membership\nbelongs to, and member_id is the unique ID assigned to the member\n\nMust be left blank while creating a Membership.",
"type": "string"
},
"preferredMemberKey": {
"$ref": "EntityKey",
"description": "EntityKey of the entity to be added as the member. Must be set while\ncreating a Membership, read-only afterwards.\n\nCurrently allowed entity types: `Users`, `Groups`."
},
"roles": {
"description": "Roles for a member within the Group.\n\nCurrently supported MembershipRoles: `\"MEMBER\"`.",
"items": {
"$ref": "MembershipRole"
},
"type": "array"
},
"updateTime": {
"description": "Last updated timestamp of the Membership. Output only.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"MembershipRole": {
"description": "Resource representing a role within a Membership.",
"id": "MembershipRole",
"properties": {
"name": {
"description": "MembershipRole in string format.\n\nCurrently supported MembershipRoles: `\"MEMBER\"`.",
"type": "string"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"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"
},
"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"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"SearchGroupsResponse": {
"id": "SearchGroupsResponse",
"properties": {
"groups": {
"description": "List of Groups satisfying the search query.",
"items": {
"$ref": "Group"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results available for specified query.",
"type": "string"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error\nmessage, and error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud Identity API",
"version": "v1",
"version_module": true
}

687
etc/api/cloudidentity/v1beta1/cloudidentity-api.json Normal file
View File

@@ -0,0 +1,687 @@
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-identity.groups": {
"description": "See, change, create, and delete any of the Cloud Identity Groups that you can access, including the members of each group"
},
"https://www.googleapis.com/auth/cloud-identity.groups.readonly": {
"description": "See any Cloud Identity Groups that you can access, including group members and their emails"
}
}
}
},
"basePath": "",
"baseUrl": "https://cloudidentity.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Identity",
"description": "API for provisioning and managing identity resources.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/identity/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "cloudidentity:v1beta1",
"kind": "discovery#restDescription",
"name": "cloudidentity",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"groups": {
"methods": {
"create": {
"description": "Creates a Group.",
"flatPath": "v1beta1/groups",
"httpMethod": "POST",
"id": "cloudidentity.groups.create",
"parameterOrder": [],
"parameters": {},
"path": "v1beta1/groups",
"request": {
"$ref": "Group"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups"
]
},
"delete": {
"description": "Deletes a Group.",
"flatPath": "v1beta1/groups/{groupsId}",
"httpMethod": "DELETE",
"id": "cloudidentity.groups.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where `group_id` is the unique id\nassigned to the Group.",
"location": "path",
"pattern": "^groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups"
]
},
"get": {
"description": "Retrieves a Group.",
"flatPath": "v1beta1/groups/{groupsId}",
"httpMethod": "GET",
"id": "cloudidentity.groups.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where `group_id` is the unique id\nassigned to the Group.",
"location": "path",
"pattern": "^groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Group"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups",
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
]
},
"lookup": {
"description": "Looks up [resource\nname](https://cloud.google.com/apis/design/resource_names) of a Group by\nits EntityKey.",
"flatPath": "v1beta1/groups:lookup",
"httpMethod": "GET",
"id": "cloudidentity.groups.lookup",
"parameterOrder": [],
"parameters": {
"groupKey.id": {
"description": "The id of the entity within the given namespace. The id must be unique\nwithin its namespace.",
"location": "query",
"type": "string"
},
"groupKey.namespace": {
"description": "Namespaces provide isolation for ids, i.e an id only needs to be unique\nwithin its namespace.\n\nNamespaces are currently only created as part of IdentitySource creation\nfrom Admin Console. A namespace `\"identitysources/{identity_source_id}\"` is\ncreated corresponding to every Identity Source `identity_source_id`.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/groups:lookup",
"response": {
"$ref": "LookupGroupNameResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups",
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
]
},
"patch": {
"description": "Updates a Group.",
"flatPath": "v1beta1/groups/{groupsId}",
"httpMethod": "PATCH",
"id": "cloudidentity.groups.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where group_id is the unique id\nassigned to the Group.\n\nMust be left blank while creating a Group",
"location": "path",
"pattern": "^groups/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Editable fields: `display_name`, `description`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "Group"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups"
]
},
"search": {
"description": "Searches for Groups.",
"flatPath": "v1beta1/groups:search",
"httpMethod": "GET",
"id": "cloudidentity.groups.search",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "The default page size is 200 (max 1000) for the BASIC view, and 50\n(max 500) for the FULL view.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous search request, if any.",
"location": "query",
"type": "string"
},
"query": {
"description": "Query string for performing search on groups.\nUsers can search on namespace and label attributes of groups.\nEXACT match ('=') is supported on namespace, and CONTAINS match (':') is\nsupported on labels. This is a `required` field.\nMultiple queries can be combined using `AND` operator. The operator is case\nsensitive.\nAn example query would be:\n\"namespace=<namespace_value> AND labels:<labels_value>\".",
"location": "query",
"type": "string"
},
"view": {
"description": "Group resource view to be returned. Defaults to [GroupView.BASIC]().",
"enum": [
"BASIC",
"FULL"
],
"location": "query",
"type": "string"
}
},
"path": "v1beta1/groups:search",
"response": {
"$ref": "SearchGroupsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups",
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
]
}
},
"resources": {
"memberships": {
"methods": {
"create": {
"description": "Creates a Membership.",
"flatPath": "v1beta1/groups/{groupsId}/memberships",
"httpMethod": "POST",
"id": "cloudidentity.groups.memberships.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to create Membership within. Format: `groups/{group_id}`, where\n`group_id` is the unique id assigned to the Group.",
"location": "path",
"pattern": "^groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/memberships",
"request": {
"$ref": "Membership"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups"
]
},
"delete": {
"description": "Deletes a Membership.",
"flatPath": "v1beta1/groups/{groupsId}/memberships/{membershipsId}",
"httpMethod": "DELETE",
"id": "cloudidentity.groups.memberships.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership to be deleted.\n\nFormat: `groups/{group_id}/memberships/{member_id}`, where `group_id` is\nthe unique id assigned to the Group to which Membership belongs to, and\nmember_id is the unique id assigned to the member.",
"location": "path",
"pattern": "^groups/[^/]+/memberships/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups"
]
},
"get": {
"description": "Retrieves a Membership.",
"flatPath": "v1beta1/groups/{groupsId}/memberships/{membershipsId}",
"httpMethod": "GET",
"id": "cloudidentity.groups.memberships.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership to be retrieved.\n\nFormat: `groups/{group_id}/memberships/{member_id}`, where `group_id` is\nthe unique id assigned to the Group to which Membership belongs to, and\n`member_id` is the unique id assigned to the member.",
"location": "path",
"pattern": "^groups/[^/]+/memberships/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Membership"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups",
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
]
},
"list": {
"description": "List Memberships within a Group.",
"flatPath": "v1beta1/groups/{groupsId}/memberships",
"httpMethod": "GET",
"id": "cloudidentity.groups.memberships.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The default page size is 200 (max 1000) for the BASIC view, and 50\n(max 500) for the FULL view.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous list request, if any",
"location": "query",
"type": "string"
},
"parent": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to list Memberships within.\n\nFormat: `groups/{group_id}`, where `group_id` is the unique id assigned to\nthe Group.",
"location": "path",
"pattern": "^groups/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Membership resource view to be returned. Defaults to MembershipView.BASIC.",
"enum": [
"BASIC",
"FULL"
],
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+parent}/memberships",
"response": {
"$ref": "ListMembershipsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups",
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
]
},
"lookup": {
"description": "Looks up [resource\nname](https://cloud.google.com/apis/design/resource_names) of a Membership\nwithin a Group by member's EntityKey.",
"flatPath": "v1beta1/groups/{groupsId}/memberships:lookup",
"httpMethod": "GET",
"id": "cloudidentity.groups.memberships.lookup",
"parameterOrder": [
"parent"
],
"parameters": {
"memberKey.id": {
"description": "The id of the entity within the given namespace. The id must be unique\nwithin its namespace.",
"location": "query",
"type": "string"
},
"memberKey.namespace": {
"description": "Namespaces provide isolation for ids, i.e an id only needs to be unique\nwithin its namespace.\n\nNamespaces are currently only created as part of IdentitySource creation\nfrom Admin Console. A namespace `\"identitysources/{identity_source_id}\"` is\ncreated corresponding to every Identity Source `identity_source_id`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to lookup Membership within.\n\nFormat: `groups/{group_id}`, where `group_id` is the unique id assigned to\nthe Group.",
"location": "path",
"pattern": "^groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/memberships:lookup",
"response": {
"$ref": "LookupMembershipNameResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-identity.groups",
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
]
}
}
}
}
}
},
"revision": "20190330",
"rootUrl": "https://cloudidentity.googleapis.com/",
"schemas": {
"EntityKey": {
"description": "An EntityKey uniquely identifies an Entity. Namespaces are used to provide\nisolation for ids. A single Id can be reused across namespaces but the\ncombination of a namespace and an id must be unique.",
"id": "EntityKey",
"properties": {
"id": {
"description": "The id of the entity within the given namespace. The id must be unique\nwithin its namespace.",
"type": "string"
},
"namespace": {
"description": "Namespaces provide isolation for ids, i.e an id only needs to be unique\nwithin its namespace.\n\nNamespaces are currently only created as part of IdentitySource creation\nfrom Admin Console. A namespace `\"identitysources/{identity_source_id}\"` is\ncreated corresponding to every Identity Source `identity_source_id`.",
"type": "string"
}
},
"type": "object"
},
"Group": {
"description": "Resource representing a Group",
"id": "Group",
"properties": {
"additionalGroupKeys": {
"description": "Optional. Additional entity key aliases for a Group",
"items": {
"$ref": "EntityKey"
},
"type": "array"
},
"createTime": {
"description": "The time when the Group was created.\nOutput only",
"format": "google-datetime",
"type": "string"
},
"description": {
"description": "An extended description to help users determine the purpose of a Group. For\nexample, you can include information about who should join the Group, the\ntypes of messages to send to the Group, links to FAQs about the Group, or\nrelated Groups. Maximum length is 4,096 characters.",
"type": "string"
},
"displayName": {
"description": "The Group's display name.",
"type": "string"
},
"groupKey": {
"$ref": "EntityKey",
"description": "EntityKey of the Group.\n\nMust be set when creating a Group, read-only afterwards."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for Group resource.\nRequired.\nFor creating Groups under a namespace, set label key to\n'labels/system/groups/external' and label value as empty.",
"type": "object"
},
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where group_id is the unique id\nassigned to the Group.\n\nMust be left blank while creating a Group",
"type": "string"
},
"parent": {
"description": "The entity under which this Group resides in Cloud Identity resource\nhierarchy. Must be set when creating a Group, read-only afterwards.\n\nCurrently allowed types: 'identitysources'.",
"type": "string"
},
"updateTime": {
"description": "The time when the Group was last updated.\nOutput only",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"ListMembershipsResponse": {
"id": "ListMembershipsResponse",
"properties": {
"memberships": {
"description": "List of Memberships",
"items": {
"$ref": "Membership"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results available for listing.",
"type": "string"
}
},
"type": "object"
},
"LookupGroupNameResponse": {
"id": "LookupGroupNameResponse",
"properties": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where `group_id` is the unique id\nassigned to the Group.",
"type": "string"
}
},
"type": "object"
},
"LookupMembershipNameResponse": {
"id": "LookupMembershipNameResponse",
"properties": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership being looked up.\n\nFormat: `groups/{group_id}/memberships/{member_id}`, where `group_id` is\nthe unique id assigned to the Group to which Membership belongs to, and\n`member_id` is the unique id assigned to the member.",
"type": "string"
}
},
"type": "object"
},
"Membership": {
"description": "Resource representing a Membership within a Group",
"id": "Membership",
"properties": {
"createTime": {
"description": "Creation timestamp of the Membership.",
"format": "google-datetime",
"type": "string"
},
"memberKey": {
"$ref": "EntityKey",
"description": "EntityKey of the entity to be added as the member. Must be set while\ncreating a Membership, read-only afterwards.\n\nCurrently allowed entity types: `Users`, `Groups`."
},
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership in the format: `groups/{group_id}/memberships/{member_id}`,\nwhere group_id is the unique id assigned to the Group to which Membership\nbelongs to, and member_id is the unique id assigned to the member\n\nMust be left blank while creating a Membership.",
"type": "string"
},
"roles": {
"description": "Roles for a member within the Group.\n\nCurrently supported MembershipRoles: `\"MEMBER\"`.",
"items": {
"$ref": "MembershipRole"
},
"type": "array"
},
"updateTime": {
"description": "Last updated timestamp of the Membership.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"MembershipRole": {
"description": "Resource representing a role within a Membership.",
"id": "MembershipRole",
"properties": {
"name": {
"description": "MembershipRole in string format.\n\nCurrently supported MembershipRoles: `\"MEMBER\"`.",
"type": "string"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"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"
},
"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"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"SearchGroupsResponse": {
"id": "SearchGroupsResponse",
"properties": {
"groups": {
"description": "List of Groups satisfying the search query.",
"items": {
"$ref": "Group"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results available for specified query.",
"type": "string"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error\nmessage, and error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud Identity API",
"version": "v1beta1",
"version_module": true
}

3588
etc/api/cloudiot/v1/cloudiot-api.json
View File

File diff suppressed because it is too large Load Diff

3550
etc/api/cloudkms/v1/cloudkms-api.json
View File

File diff suppressed because it is too large Load Diff

686
etc/api/cloudprivatecatalog/v1beta1/cloudprivatecatalog-api.json Normal file
View File

@@ -0,0 +1,686 @@
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"basePath": "",
"baseUrl": "https://cloudprivatecatalog.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Private Catalog",
"description": "Enable cloud users to discover enterprise catalogs and products in their organizations.",
"discoveryVersion": "v1",
"documentationLink": "https://sites.google.com/corp/google.com/cloudprivatecatalog",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "cloudprivatecatalog:v1beta1",
"kind": "discovery#restDescription",
"name": "cloudprivatecatalog",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"folders": {
"resources": {
"catalogs": {
"methods": {
"search": {
"description": "Search Catalog resources that consumers have access to, within the\nscope of the consumer cloud resource hierarchy context.",
"flatPath": "v1beta1/folders/{foldersId}/catalogs:search",
"httpMethod": "GET",
"id": "cloudprivatecatalog.folders.catalogs.search",
"parameterOrder": [
"resource"
],
"parameters": {
"pageSize": {
"description": "The maximum number of entries that are requested.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to SearchCatalogs that\nindicates where this listing should continue from.\nThis field is optional.",
"location": "query",
"type": "string"
},
"query": {
"description": "The query to filter the catalogs. The supported queries are:\n\n* Get a single catalog: `name=catalogs/{catalog_id}`",
"location": "query",
"type": "string"
},
"resource": {
"description": "Required. The name of the resource context. It can be in following formats:\n\n* `projects/{project_id}`\n* `folders/{folder_id}`\n* `organizations/{organization_id}`",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}/catalogs:search",
"response": {
"$ref": "GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"products": {
"methods": {
"search": {
"description": "Search Product resources that consumers have access to, within the\nscope of the consumer cloud resource hierarchy context.",
"flatPath": "v1beta1/folders/{foldersId}/products:search",
"httpMethod": "GET",
"id": "cloudprivatecatalog.folders.products.search",
"parameterOrder": [
"resource"
],
"parameters": {
"pageSize": {
"description": "The maximum number of entries that are requested.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to SearchProducts that\nindicates where this listing should continue from.\nThis field is optional.",
"location": "query",
"type": "string"
},
"query": {
"description": "The query to filter the products.\n\nThe supported queries are:\n* List products of all catalogs: empty\n* List products under a catalog: `parent=catalogs/{catalog_id}`\n* Get a product by name:\n`name=catalogs/{catalog_id}/products/{product_id}`",
"location": "query",
"type": "string"
},
"resource": {
"description": "Required. The name of the resource context. See\nSearchCatalogsRequest.resource for details.",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}/products:search",
"response": {
"$ref": "GoogleCloudPrivatecatalogV1beta1SearchProductsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"versions": {
"methods": {
"search": {
"description": "Search Version resources that consumers have access to, within the\nscope of the consumer cloud resource hierarchy context.",
"flatPath": "v1beta1/folders/{foldersId}/versions:search",
"httpMethod": "GET",
"id": "cloudprivatecatalog.folders.versions.search",
"parameterOrder": [
"resource"
],
"parameters": {
"pageSize": {
"description": "The maximum number of entries that are requested.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to SearchVersions\nthat indicates where this listing should continue from.\nThis field is optional.",
"location": "query",
"type": "string"
},
"query": {
"description": "The query to filter the versions. Required.\n\nThe supported queries are:\n* List versions under a product:\n`parent=catalogs/{catalog_id}/products/{product_id}`\n* Get a version by name:\n`name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}`",
"location": "query",
"type": "string"
},
"resource": {
"description": "Required. The name of the resource context. See\nSearchCatalogsRequest.resource for details.",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}/versions:search",
"response": {
"$ref": "GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"organizations": {
"resources": {
"catalogs": {
"methods": {
"search": {
"description": "Search Catalog resources that consumers have access to, within the\nscope of the consumer cloud resource hierarchy context.",
"flatPath": "v1beta1/organizations/{organizationsId}/catalogs:search",
"httpMethod": "GET",
"id": "cloudprivatecatalog.organizations.catalogs.search",
"parameterOrder": [
"resource"
],
"parameters": {
"pageSize": {
"description": "The maximum number of entries that are requested.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to SearchCatalogs that\nindicates where this listing should continue from.\nThis field is optional.",
"location": "query",
"type": "string"
},
"query": {
"description": "The query to filter the catalogs. The supported queries are:\n\n* Get a single catalog: `name=catalogs/{catalog_id}`",
"location": "query",
"type": "string"
},
"resource": {
"description": "Required. The name of the resource context. It can be in following formats:\n\n* `projects/{project_id}`\n* `folders/{folder_id}`\n* `organizations/{organization_id}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}/catalogs:search",
"response": {
"$ref": "GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"products": {
"methods": {
"search": {
"description": "Search Product resources that consumers have access to, within the\nscope of the consumer cloud resource hierarchy context.",
"flatPath": "v1beta1/organizations/{organizationsId}/products:search",
"httpMethod": "GET",
"id": "cloudprivatecatalog.organizations.products.search",
"parameterOrder": [
"resource"
],
"parameters": {
"pageSize": {
"description": "The maximum number of entries that are requested.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to SearchProducts that\nindicates where this listing should continue from.\nThis field is optional.",
"location": "query",
"type": "string"
},
"query": {
"description": "The query to filter the products.\n\nThe supported queries are:\n* List products of all catalogs: empty\n* List products under a catalog: `parent=catalogs/{catalog_id}`\n* Get a product by name:\n`name=catalogs/{catalog_id}/products/{product_id}`",
"location": "query",
"type": "string"
},
"resource": {
"description": "Required. The name of the resource context. See\nSearchCatalogsRequest.resource for details.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}/products:search",
"response": {
"$ref": "GoogleCloudPrivatecatalogV1beta1SearchProductsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"versions": {
"methods": {
"search": {
"description": "Search Version resources that consumers have access to, within the\nscope of the consumer cloud resource hierarchy context.",
"flatPath": "v1beta1/organizations/{organizationsId}/versions:search",
"httpMethod": "GET",
"id": "cloudprivatecatalog.organizations.versions.search",
"parameterOrder": [
"resource"
],
"parameters": {
"pageSize": {
"description": "The maximum number of entries that are requested.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to SearchVersions\nthat indicates where this listing should continue from.\nThis field is optional.",
"location": "query",
"type": "string"
},
"query": {
"description": "The query to filter the versions. Required.\n\nThe supported queries are:\n* List versions under a product:\n`parent=catalogs/{catalog_id}/products/{product_id}`\n* Get a version by name:\n`name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}`",
"location": "query",
"type": "string"
},
"resource": {
"description": "Required. The name of the resource context. See\nSearchCatalogsRequest.resource for details.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}/versions:search",
"response": {
"$ref": "GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"projects": {
"resources": {
"catalogs": {
"methods": {
"search": {
"description": "Search Catalog resources that consumers have access to, within the\nscope of the consumer cloud resource hierarchy context.",
"flatPath": "v1beta1/projects/{projectsId}/catalogs:search",
"httpMethod": "GET",
"id": "cloudprivatecatalog.projects.catalogs.search",
"parameterOrder": [
"resource"
],
"parameters": {
"pageSize": {
"description": "The maximum number of entries that are requested.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to SearchCatalogs that\nindicates where this listing should continue from.\nThis field is optional.",
"location": "query",
"type": "string"
},
"query": {
"description": "The query to filter the catalogs. The supported queries are:\n\n* Get a single catalog: `name=catalogs/{catalog_id}`",
"location": "query",
"type": "string"
},
"resource": {
"description": "Required. The name of the resource context. It can be in following formats:\n\n* `projects/{project_id}`\n* `folders/{folder_id}`\n* `organizations/{organization_id}`",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}/catalogs:search",
"response": {
"$ref": "GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"products": {
"methods": {
"search": {
"description": "Search Product resources that consumers have access to, within the\nscope of the consumer cloud resource hierarchy context.",
"flatPath": "v1beta1/projects/{projectsId}/products:search",
"httpMethod": "GET",
"id": "cloudprivatecatalog.projects.products.search",
"parameterOrder": [
"resource"
],
"parameters": {
"pageSize": {
"description": "The maximum number of entries that are requested.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to SearchProducts that\nindicates where this listing should continue from.\nThis field is optional.",
"location": "query",
"type": "string"
},
"query": {
"description": "The query to filter the products.\n\nThe supported queries are:\n* List products of all catalogs: empty\n* List products under a catalog: `parent=catalogs/{catalog_id}`\n* Get a product by name:\n`name=catalogs/{catalog_id}/products/{product_id}`",
"location": "query",
"type": "string"
},
"resource": {
"description": "Required. The name of the resource context. See\nSearchCatalogsRequest.resource for details.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}/products:search",
"response": {
"$ref": "GoogleCloudPrivatecatalogV1beta1SearchProductsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"versions": {
"methods": {
"search": {
"description": "Search Version resources that consumers have access to, within the\nscope of the consumer cloud resource hierarchy context.",
"flatPath": "v1beta1/projects/{projectsId}/versions:search",
"httpMethod": "GET",
"id": "cloudprivatecatalog.projects.versions.search",
"parameterOrder": [
"resource"
],
"parameters": {
"pageSize": {
"description": "The maximum number of entries that are requested.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to SearchVersions\nthat indicates where this listing should continue from.\nThis field is optional.",
"location": "query",
"type": "string"
},
"query": {
"description": "The query to filter the versions. Required.\n\nThe supported queries are:\n* List versions under a product:\n`parent=catalogs/{catalog_id}/products/{product_id}`\n* Get a version by name:\n`name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}`",
"location": "query",
"type": "string"
},
"resource": {
"description": "Required. The name of the resource context. See\nSearchCatalogsRequest.resource for details.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}/versions:search",
"response": {
"$ref": "GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
},
"revision": "20190330",
"rootUrl": "https://cloudprivatecatalog.googleapis.com/",
"schemas": {
"GoogleCloudPrivatecatalogV1beta1Catalog": {
"description": "The readonly representation of a catalog computed with a given resource\ncontext.",
"id": "GoogleCloudPrivatecatalogV1beta1Catalog",
"properties": {
"createTime": {
"description": "Output only. The time when the catalog was created.",
"format": "google-datetime",
"type": "string"
},
"description": {
"description": "Output only. The description of the catalog.",
"type": "string"
},
"displayName": {
"description": "Output only. The descriptive name of the catalog as it appears in UIs.",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the target catalog, in the format of\n`catalogs/{catalog_id}'.",
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the catalog was last updated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudPrivatecatalogV1beta1Product": {
"description": "The readonly representation of a product computed with a given resource\ncontext.",
"id": "GoogleCloudPrivatecatalogV1beta1Product",
"properties": {
"assetType": {
"description": "Output only. The type of the product asset. It can be one of the\nfollowing values:\n\n* `google.deploymentmanager.Template`\n* `google.cloudprivatecatalog.ListingOnly`",
"type": "string"
},
"createTime": {
"description": "Output only. The time when the product was created.",
"format": "google-datetime",
"type": "string"
},
"displayMetadata": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Output only. The display metadata to describe the product.\nThe JSON schema of the metadata differs by Product.asset_type.\nWhen the type is `google.deploymentmanager.Template`, the schema is as\nfollows:\n\n```\n\"$schema\": http://json-schema.org/draft-04/schema#\ntype: object\nproperties:\n name:\n type: string\n minLength: 1\n maxLength: 64\n description:\n type: string\n minLength: 1\n maxLength: 2048\n tagline:\n type: string\n minLength: 1\n maxLength: 100\n support_info:\n type: string\n minLength: 1\n maxLength: 2048\n creator:\n type: string\n minLength: 1\n maxLength: 100\n documentation:\n type: array\n items:\n type: object\n properties:\n url:\n type: string\n pattern:\n \"^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]\"\n title:\n type: string\n minLength: 1\n maxLength: 64\n description:\n type: string\n minLength: 1\n maxLength: 2048\nrequired:\n- name\n- description\nadditionalProperties: false\n\n```\n\nWhen the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema\nis as follows:\n\n```\n\"$schema\": http://json-schema.org/draft-04/schema#\ntype: object\nproperties:\n name:\n type: string\n minLength: 1\n maxLength: 64\n description:\n type: string\n minLength: 1\n maxLength: 2048\n tagline:\n type: string\n minLength: 1\n maxLength: 100\n support_info:\n type: string\n minLength: 1\n maxLength: 2048\n creator:\n type: string\n minLength: 1\n maxLength: 100\n documentation:\n type: array\n items:\n type: object\n properties:\n url:\n type: string\n pattern:\n \"^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]\"\n title:\n type: string\n minLength: 1\n maxLength: 64\n description:\n type: string\n minLength: 1\n maxLength: 2048\n signup_url:\n type: string\n pattern:\n \"^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]\"\nrequired:\n- name\n- description\n- signup_url\nadditionalProperties: false\n```",
"type": "object"
},
"iconUri": {
"description": "Output only. The icon URI of the product.",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the target product, in the format of\n`products/a-z*[a-z0-9]'.\n\nA unique identifier for the product under a catalog.",
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the product was last updated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse": {
"description": "Response message for PrivateCatalog.SearchCatalogs.",
"id": "GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse",
"properties": {
"catalogs": {
"description": "The `Catalog`s computed from the resource context.",
"items": {
"$ref": "GoogleCloudPrivatecatalogV1beta1Catalog"
},
"type": "array"
},
"nextPageToken": {
"description": "A pagination token returned from a previous call to SearchCatalogs that\nindicates from where listing should continue.\nThis field is optional.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudPrivatecatalogV1beta1SearchProductsResponse": {
"description": "Response message for PrivateCatalog.SearchProducts.",
"id": "GoogleCloudPrivatecatalogV1beta1SearchProductsResponse",
"properties": {
"nextPageToken": {
"description": "A pagination token returned from a previous call to SearchProducts that\nindicates from where listing should continue.\nThis field is optional.",
"type": "string"
},
"products": {
"description": "The `Product` resources computed from the resource context.",
"items": {
"$ref": "GoogleCloudPrivatecatalogV1beta1Product"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse": {
"description": "Response message for PrivateCatalog.SearchVersions.",
"id": "GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse",
"properties": {
"nextPageToken": {
"description": "A pagination token returned from a previous call to SearchVersions that\nindicates from where the listing should continue.\nThis field is optional.",
"type": "string"
},
"versions": {
"description": "The `Version` resources computed from the resource context.",
"items": {
"$ref": "GoogleCloudPrivatecatalogV1beta1Version"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudPrivatecatalogV1beta1Version": {
"description": "The consumer representation of a version which is a child resource under a\n`Product` with asset data.",
"id": "GoogleCloudPrivatecatalogV1beta1Version",
"properties": {
"asset": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Output only. The asset which has been validated and is ready to be\nprovisioned. See\ngoogle.cloud.privatecatalogproducer.v1beta.Version.asset for details.",
"type": "object"
},
"createTime": {
"description": "Output only. The time when the version was created.",
"format": "google-datetime",
"type": "string"
},
"description": {
"description": "Output only. The user-supplied description of the version. Maximum of 256\ncharacters.",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the version, in the format\n`catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'.\n\nA unique identifier for the version under a product.",
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the version was last updated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud Private Catalog API",
"version": "v1beta1",
"version_module": true
}

1473
etc/api/cloudprivatecatalogproducer/v1beta1/cloudprivatecatalogproducer-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

666
etc/api/cloudprofiler/v2/cloudprofiler-api.json
View File

@@ -1,342 +1,342 @@
{
"canonicalName": "Cloud Profiler",
"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"
}
}
}
},
"rootUrl": "https://cloudprofiler.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudprofiler",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Stackdriver Profiler API",
"ownerName": "Google",
"resources": {
"projects": {
"resources": {
"profiles": {
"methods": {
"createOffline": {
"response": {
"$ref": "Profile"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "Parent project to create the profile in.",
"required": true,
"type": "string"
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/monitoring": {
"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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
],
"flatPath": "v2/projects/{projectsId}/profiles:createOffline",
"path": "v2/{+parent}/profiles:createOffline",
"id": "cloudprofiler.projects.profiles.createOffline",
"description": "CreateOfflineProfile creates a new profile resource in the offline mode.\nThe client provides the profile to create along with the profile bytes, the\nserver records it.",
"request": {
"$ref": "Profile"
}
},
"patch": {
"description": "UpdateProfile updates the profile bytes and labels on the profile resource\ncreated in the online mode. Updating the bytes for profiles created in the\noffline mode is currently not supported: the profile content must be\nprovided at the time of the profile creation.",
"request": {
"$ref": "Profile"
},
"response": {
"$ref": "Profile"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
"description": "Field mask used to specify the fields to be overwritten. Currently only\nprofile_bytes and labels fields are supported by UpdateProfile, so only\nthose fields can be specified in the mask. When no mask is provided, all\nfields are overwritten.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
},
"name": {
"location": "path",
"description": "Output only. Opaque, server-assigned, unique ID for this profile.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/profiles/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
],
"flatPath": "v2/projects/{projectsId}/profiles/{profilesId}",
"path": "v2/{+name}",
"id": "cloudprofiler.projects.profiles.patch"
},
"create": {
"path": "v2/{+parent}/profiles",
"id": "cloudprofiler.projects.profiles.create",
"request": {
"$ref": "CreateProfileRequest"
},
"description": "CreateProfile creates a new profile resource in the online mode.\n\nThe server ensures that the new profiles are created at a constant rate per\ndeployment, so the creation request may hang for some time until the next\nprofile session is available.\n\nThe request may fail with ABORTED error if the creation is not available\nwithin ~1m, the response will indicate the duration of the backoff the\nclient should take before attempting creating a profile again. The backoff\nduration is returned in google.rpc.RetryInfo extension on the response\nstatus. To a gRPC client, the extension will be return as a\nbinary-serialized proto in the trailing metadata item named\n\"google.rpc.retryinfo-bin\".",
"response": {
"$ref": "Profile"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "Parent project to create the profile in.",
"required": true,
"type": "string"
}
},
"flatPath": "v2/projects/{projectsId}/profiles"
}
}
}
}
}
},
"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"
},
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
"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"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"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"
}
},
"version": "v2",
"baseUrl": "https://cloudprofiler.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Manages continuous profiling information.",
"servicePath": "",
"basePath": "",
"id": "cloudprofiler:v2",
"documentationLink": "https://cloud.google.com/profiler/",
"revision": "20181008",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"CreateProfileRequest": {
"properties": {
"profileType": {
"description": "One or more profile types that the agent is capable of providing.",
"type": "array",
"items": {
},
"basePath": "",
"baseUrl": "https://cloudprofiler.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Profiler",
"description": "Manages continuous profiling information.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/profiler/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "cloudprofiler:v2",
"kind": "discovery#restDescription",
"name": "cloudprofiler",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"PROFILE_TYPE_UNSPECIFIED",
"CPU",
"WALL",
"HEAP",
"THREADS",
"CONTENTION",
"PEAK_HEAP",
"HEAP_ALLOC"
],
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"enumDescriptions": [
"Unspecified profile type.",
"Thread CPU time sampling.",
"Wallclock time sampling. More expensive as stops all threads.",
"In-use heap profile. Represents a snapshot of the allocations that are\nlive at the time of the profiling.",
"Single-shot collection of all thread stacks.",
"Synchronization contention profile.",
"Peak heap profile.",
"Heap allocation profile. It represents the aggregation of all allocations\nmade over the duration of the profile. All allocations are included,\nincluding those that might have been freed by the end of the profiling\ninterval. The profile is in particular useful for garbage collecting\nlanguages to understand which parts of the code create most of the garbage\ncollection pressure to see if those can be optimized."
]
},
"deployment": {
"description": "Deployment details.",
"$ref": "Deployment"
}
},
"id": "CreateProfileRequest",
"description": "CreateProfileRequest describes a profile resource online creation request.\nThe deployment field must be populated. The profile_type specifies the list\nof profile types supported by the agent. The creation call will hang until a\nprofile of one of these types needs to be collected.",
"type": "object"
},
"Deployment": {
"description": "Deployment contains the deployment identification information.",
"type": "object",
"properties": {
"projectId": {
"description": "Project ID is the ID of a cloud project.\nValidation regex: `^a-z{4,61}[a-z0-9]$`.",
"type": "string"
},
"labels": {
"additionalProperties": {
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"description": "Labels identify the deployment within the user universe and same target.\nValidation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`.\nValue for an individual label must be \u003c= 512 bytes, the total\nsize of all label names and values must be \u003c= 1024 bytes.\n\nLabel named \"language\" can be used to record the programming language of\nthe profiled deployment. The standard choices for the value include \"java\",\n\"go\", \"python\", \"ruby\", \"nodejs\", \"php\", \"dotnet\".\n\nFor deployments running on Google Cloud Platform, \"zone\" or \"region\" label\nshould be present describing the deployment location. An example of a zone\nis \"us-central1-a\", an example of a region is \"us-central1\" or\n\"us-central\".",
"type": "object"
},
"target": {
"description": "Target is the service name used to group related deployments:\n* Service name for GAE Flex / Standard.\n* Cluster and container name for GKE.\n* User-specified string for direct GCE profiling (e.g. Java).\n* Job name for Dataflow.\nValidation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.",
"type": "string"
}
},
"id": "Deployment"
},
"Profile": {
"description": "Profile resource.",
"type": "object",
"properties": {
"duration": {
"description": "Duration of the profiling session.\nInput (for the offline mode) or output (for the online mode).\nThe field represents requested profiling duration. It may slightly differ\nfrom the effective profiling duration, which is recorded in the profile\ndata, in case the profiling can't be stopped immediately (e.g. in case\nstopping the profiling is handled asynchronously).",
"format": "google-duration",
"type": "string"
},
"profileType": {
"enumDescriptions": [
"Unspecified profile type.",
"Thread CPU time sampling.",
"Wallclock time sampling. More expensive as stops all threads.",
"In-use heap profile. Represents a snapshot of the allocations that are\nlive at the time of the profiling.",
"Single-shot collection of all thread stacks.",
"Synchronization contention profile.",
"Peak heap profile.",
"Heap allocation profile. It represents the aggregation of all allocations\nmade over the duration of the profile. All allocations are included,\nincluding those that might have been freed by the end of the profiling\ninterval. The profile is in particular useful for garbage collecting\nlanguages to understand which parts of the code create most of the garbage\ncollection pressure to see if those can be optimized."
],
"enum": [
"PROFILE_TYPE_UNSPECIFIED",
"CPU",
"WALL",
"HEAP",
"THREADS",
"CONTENTION",
"PEAK_HEAP",
"HEAP_ALLOC"
],
"description": "Type of profile.\nFor offline mode, this must be specified when creating the profile. For\nonline mode it is assigned and returned by the server.",
"type": "string"
},
"deployment": {
"description": "Deployment this profile corresponds to.",
"$ref": "Deployment"
},
"labels": {
"description": "Input only. Labels associated to this specific profile. These labels will\nget merged with the deployment labels for the final data set. See\ndocumentation on deployment labels for validation rules and limits.",
"type": "object",
"additionalProperties": {
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"profileBytes": {
"description": "Input only. Profile bytes, as a gzip compressed serialized proto, the\nformat is https://github.com/google/pprof/blob/master/proto/profile.proto.",
"format": "byte",
"type": "string"
},
"name": {
"description": "Output only. Opaque, server-assigned, unique ID for this profile.",
"type": "string"
}
},
"id": "Profile"
}
},
"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",
"resources": {
"projects": {
"resources": {
"profiles": {
"methods": {
"create": {
"description": "CreateProfile creates a new profile resource in the online mode.\n\nThe server ensures that the new profiles are created at a constant rate per\ndeployment, so the creation request may hang for some time until the next\nprofile session is available.\n\nThe request may fail with ABORTED error if the creation is not available\nwithin ~1m, the response will indicate the duration of the backoff the\nclient should take before attempting creating a profile again. The backoff\nduration is returned in google.rpc.RetryInfo extension on the response\nstatus. To a gRPC client, the extension will be return as a\nbinary-serialized proto in the trailing metadata item named\n\"google.rpc.retryinfo-bin\".",
"flatPath": "v2/projects/{projectsId}/profiles",
"httpMethod": "POST",
"id": "cloudprofiler.projects.profiles.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Parent project to create the profile in.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/profiles",
"request": {
"$ref": "CreateProfileRequest"
},
"response": {
"$ref": "Profile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
]
},
"createOffline": {
"description": "CreateOfflineProfile creates a new profile resource in the offline mode.\nThe client provides the profile to create along with the profile bytes, the\nserver records it.",
"flatPath": "v2/projects/{projectsId}/profiles:createOffline",
"httpMethod": "POST",
"id": "cloudprofiler.projects.profiles.createOffline",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Parent project to create the profile in.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/profiles:createOffline",
"request": {
"$ref": "Profile"
},
"response": {
"$ref": "Profile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
]
},
"patch": {
"description": "UpdateProfile updates the profile bytes and labels on the profile resource\ncreated in the online mode. Updating the bytes for profiles created in the\noffline mode is currently not supported: the profile content must be\nprovided at the time of the profile creation.",
"flatPath": "v2/projects/{projectsId}/profiles/{profilesId}",
"httpMethod": "PATCH",
"id": "cloudprofiler.projects.profiles.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Opaque, server-assigned, unique ID for this profile.",
"location": "path",
"pattern": "^projects/[^/]+/profiles/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Field mask used to specify the fields to be overwritten. Currently only\nprofile_bytes and labels fields are supported by UpdateProfile, so only\nthose fields can be specified in the mask. When no mask is provided, all\nfields are overwritten.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "Profile"
},
"response": {
"$ref": "Profile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
]
}
}
}
}
}
},
"revision": "20190330",
"rootUrl": "https://cloudprofiler.googleapis.com/",
"schemas": {
"CreateProfileRequest": {
"description": "CreateProfileRequest describes a profile resource online creation request.\nThe deployment field must be populated. The profile_type specifies the list\nof profile types supported by the agent. The creation call will hang until a\nprofile of one of these types needs to be collected.",
"id": "CreateProfileRequest",
"properties": {
"deployment": {
"$ref": "Deployment",
"description": "Deployment details."
},
"profileType": {
"description": "One or more profile types that the agent is capable of providing.",
"enumDescriptions": [
"Unspecified profile type.",
"Thread CPU time sampling.",
"Wallclock time sampling. More expensive as stops all threads.",
"In-use heap profile. Represents a snapshot of the allocations that are\nlive at the time of the profiling.",
"Single-shot collection of all thread stacks.",
"Synchronization contention profile.",
"Peak heap profile.",
"Heap allocation profile. It represents the aggregation of all allocations\nmade over the duration of the profile. All allocations are included,\nincluding those that might have been freed by the end of the profiling\ninterval. The profile is in particular useful for garbage collecting\nlanguages to understand which parts of the code create most of the garbage\ncollection pressure to see if those can be optimized."
],
"items": {
"enum": [
"PROFILE_TYPE_UNSPECIFIED",
"CPU",
"WALL",
"HEAP",
"THREADS",
"CONTENTION",
"PEAK_HEAP",
"HEAP_ALLOC"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Deployment": {
"description": "Deployment contains the deployment identification information.",
"id": "Deployment",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels identify the deployment within the user universe and same target.\nValidation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`.\nValue for an individual label must be <= 512 bytes, the total\nsize of all label names and values must be <= 1024 bytes.\n\nLabel named \"language\" can be used to record the programming language of\nthe profiled deployment. The standard choices for the value include \"java\",\n\"go\", \"python\", \"ruby\", \"nodejs\", \"php\", \"dotnet\".\n\nFor deployments running on Google Cloud Platform, \"zone\" or \"region\" label\nshould be present describing the deployment location. An example of a zone\nis \"us-central1-a\", an example of a region is \"us-central1\" or\n\"us-central\".",
"type": "object"
},
"projectId": {
"description": "Project ID is the ID of a cloud project.\nValidation regex: `^a-z{4,61}[a-z0-9]$`.",
"type": "string"
},
"target": {
"description": "Target is the service name used to group related deployments:\n* Service name for GAE Flex / Standard.\n* Cluster and container name for GKE.\n* User-specified string for direct GCE profiling (e.g. Java).\n* Job name for Dataflow.\nValidation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.",
"type": "string"
}
},
"type": "object"
},
"Profile": {
"description": "Profile resource.",
"id": "Profile",
"properties": {
"deployment": {
"$ref": "Deployment",
"description": "Deployment this profile corresponds to."
},
"duration": {
"description": "Duration of the profiling session.\nInput (for the offline mode) or output (for the online mode).\nThe field represents requested profiling duration. It may slightly differ\nfrom the effective profiling duration, which is recorded in the profile\ndata, in case the profiling can't be stopped immediately (e.g. in case\nstopping the profiling is handled asynchronously).",
"format": "google-duration",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Labels associated to this specific profile. These labels will\nget merged with the deployment labels for the final data set. See\ndocumentation on deployment labels for validation rules and limits.",
"type": "object"
},
"name": {
"description": "Output only. Opaque, server-assigned, unique ID for this profile.",
"type": "string"
},
"profileBytes": {
"description": "Input only. Profile bytes, as a gzip compressed serialized proto, the\nformat is https://github.com/google/pprof/blob/master/proto/profile.proto.",
"format": "byte",
"type": "string"
},
"profileType": {
"description": "Type of profile.\nFor offline mode, this must be specified when creating the profile. For\nonline mode it is assigned and returned by the server.",
"enum": [
"PROFILE_TYPE_UNSPECIFIED",
"CPU",
"WALL",
"HEAP",
"THREADS",
"CONTENTION",
"PEAK_HEAP",
"HEAP_ALLOC"
],
"enumDescriptions": [
"Unspecified profile type.",
"Thread CPU time sampling.",
"Wallclock time sampling. More expensive as stops all threads.",
"In-use heap profile. Represents a snapshot of the allocations that are\nlive at the time of the profiling.",
"Single-shot collection of all thread stacks.",
"Synchronization contention profile.",
"Peak heap profile.",
"Heap allocation profile. It represents the aggregation of all allocations\nmade over the duration of the profile. All allocations are included,\nincluding those that might have been freed by the end of the profiling\ninterval. The profile is in particular useful for garbage collecting\nlanguages to understand which parts of the code create most of the garbage\ncollection pressure to see if those can be optimized."
],
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Stackdriver Profiler API",
"version": "v2",
"version_module": true
}

4096
etc/api/cloudresourcemanager/v1/cloudresourcemanager-api.json
View File

File diff suppressed because it is too large Load Diff

2056
etc/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
View File

File diff suppressed because it is too large Load Diff

1772
etc/api/cloudresourcemanager/v2/cloudresourcemanager-api.json
View File

File diff suppressed because it is too large Load Diff

1772
etc/api/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
View File

File diff suppressed because it is too large Load Diff

872
etc/api/cloudscheduler/v1beta1/cloudscheduler-api.json Normal file
View File

@@ -0,0 +1,872 @@
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"basePath": "",
"baseUrl": "https://cloudscheduler.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Scheduler",
"description": "Creates and manages jobs run on a regular recurring schedule.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/scheduler/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "cloudscheduler:v1beta1",
"kind": "discovery#restDescription",
"name": "cloudscheduler",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"get": {
"description": "Gets information about a location.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "cloudscheduler.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Location"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists information about the supported locations for this service.",
"flatPath": "v1beta1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "cloudscheduler.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}/locations",
"response": {
"$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"jobs": {
"methods": {
"create": {
"description": "Creates a job.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobs",
"httpMethod": "POST",
"id": "cloudscheduler.projects.locations.jobs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required.\n\nThe location name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/jobs",
"request": {
"$ref": "Job"
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a job.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}",
"httpMethod": "DELETE",
"id": "cloudscheduler.projects.locations.jobs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a job.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}",
"httpMethod": "GET",
"id": "cloudscheduler.projects.locations.jobs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists jobs.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobs",
"httpMethod": "GET",
"id": "cloudscheduler.projects.locations.jobs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Requested page size.\n\nThe maximum page size is 500. If unspecified, the page size will\nbe the maximum. Fewer jobs than requested might be returned,\neven if more jobs exist; use next_page_token to determine if more\njobs exist.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server will return. To\nrequest 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 from\nthe previous call to ListJobs. It is an error to\nswitch the value of filter or\norder_by while iterating through pages.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required.\n\nThe location name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/jobs",
"response": {
"$ref": "ListJobsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a job.\n\nIf successful, the updated Job is returned. If the job does\nnot exist, `NOT_FOUND` is returned.\n\nIf UpdateJob does not successfully return, it is possible for the\njob to be in an Job.State.UPDATE_FAILED state. A job in this state may\nnot be executed. If this happens, retry the UpdateJob request\nuntil a successful response is received.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}",
"httpMethod": "PATCH",
"id": "cloudscheduler.projects.locations.jobs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Optionally caller-specified in CreateJob, after\nwhich it becomes output only.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_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\n projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the job'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* `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), or underscores (_). The maximum length is 500 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "A mask used to specify which fields of the job are being updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "Job"
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"pause": {
"description": "Pauses a job.\n\nIf a job is paused then the system will stop executing the job\nuntil it is re-enabled via ResumeJob. The\nstate of the job is stored in state; if paused it\nwill be set to Job.State.PAUSED. A job must be in Job.State.ENABLED\nto be paused.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:pause",
"httpMethod": "POST",
"id": "cloudscheduler.projects.locations.jobs.pause",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}:pause",
"request": {
"$ref": "PauseJobRequest"
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"resume": {
"description": "Resume a job.\n\nThis method reenables a job after it has been Job.State.PAUSED. The\nstate of a job is stored in Job.state; after calling this method it\nwill be set to Job.State.ENABLED. A job must be in\nJob.State.PAUSED to be resumed.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:resume",
"httpMethod": "POST",
"id": "cloudscheduler.projects.locations.jobs.resume",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}:resume",
"request": {
"$ref": "ResumeJobRequest"
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"run": {
"description": "Forces a job to run now.\n\nWhen this method is called, Cloud Scheduler will dispatch the job, even\nif the job is already running.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:run",
"httpMethod": "POST",
"id": "cloudscheduler.projects.locations.jobs.run",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}:run",
"request": {
"$ref": "RunJobRequest"
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20190326",
"rootUrl": "https://cloudscheduler.googleapis.com/",
"schemas": {
"AppEngineHttpTarget": {
"description": "App Engine target. The job will be pushed to a job handler by means\nof an HTTP request via an http_method such\nas HTTP POST, HTTP GET, etc. The job is acknowledged by means of an\nHTTP response code in the range [200 - 299]. Error 503 is\nconsidered an App Engine system error instead of an application\nerror. Requests returning error 503 will be retried regardless of\nretry configuration and not counted against retry counts. Any other\nresponse code, or a failure to receive a response before the\ndeadline, constitutes a failed attempt.",
"id": "AppEngineHttpTarget",
"properties": {
"appEngineRouting": {
"$ref": "AppEngineRouting",
"description": "App Engine Routing setting for the job."
},
"body": {
"description": "Body.\n\nHTTP request body. A request body is allowed only if the HTTP method is\nPOST or PUT. It will result in invalid argument error to set a body on a\njob with an incompatible HttpMethod.",
"format": "byte",
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "HTTP request headers.\n\nThis map contains the header field names and values. Headers can be set\nwhen the job is created.\n\nCloud Scheduler sets some headers to default values:\n\n* `User-Agent`: By default, this header is\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"`.\n This header can be modified, but Cloud Scheduler will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n* `X-CloudScheduler`: This header will be set to true.\n\nIf the job has an body, Cloud Scheduler sets\nthe following headers:\n\n* `Content-Type`: By default, the `Content-Type` header is set to\n `\"application/octet-stream\"`. The default can be overridden by explictly\n setting `Content-Type` to a particular media type when the job is\n created.\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Scheduler. This value is\n output only. It cannot be changed.\n\nThe headers below are output only. They cannot be set or overridden:\n\n* `X-Google-*`: For Google internal use only.\n* `X-AppEngine-*`: For Google internal use only.\n\nIn addition, some App Engine headers, which contain\njob-specific information, are also be sent to the job handler.",
"type": "object"
},
"httpMethod": {
"description": "The HTTP method to use for the request. PATCH and OPTIONS are not\npermitted.",
"enum": [
"HTTP_METHOD_UNSPECIFIED",
"POST",
"GET",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"enumDescriptions": [
"HTTP method unspecified. Defaults to POST.",
"HTTP POST",
"HTTP GET",
"HTTP HEAD",
"HTTP PUT",
"HTTP DELETE",
"HTTP PATCH",
"HTTP OPTIONS"
],
"type": "string"
},
"relativeUri": {
"description": "The relative URI.\n\nThe relative URL must begin with \"/\" and must be a valid HTTP relative URL.\nIt can contain a path, query string arguments, and `#` fragments.\nIf the relative URL is empty, then the root path \"/\" will be used.\nNo spaces are allowed, and the maximum length allowed is 2083 characters.",
"type": "string"
}
},
"type": "object"
},
"AppEngineRouting": {
"description": "App Engine Routing.\n\nFor more information about services, versions, and instances see\n[An Overview of App\nEngine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),\n[Microservices Architecture on Google App\nEngine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),\n[App Engine Standard request\nrouting](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),\nand [App Engine Flex request\nrouting](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).",
"id": "AppEngineRouting",
"properties": {
"host": {
"description": "Output only. The host that the job is sent to.\n\nFor more information about how App Engine requests are routed, see\n[here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).\n\nThe host is constructed as:\n\n\n* `host = [application_domain_name]`</br>\n `| [service] + '.' + [application_domain_name]`</br>\n `| [version] + '.' + [application_domain_name]`</br>\n `| [version_dot_service]+ '.' + [application_domain_name]`</br>\n `| [instance] + '.' + [application_domain_name]`</br>\n `| [instance_dot_service] + '.' + [application_domain_name]`</br>\n `| [instance_dot_version] + '.' + [application_domain_name]`</br>\n `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`\n\n* `application_domain_name` = The domain name of the app, for\n example <app-id>.appspot.com, which is associated with the\n job's project ID.\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\n\nIf service is empty, then the job will be sent\nto the service which is the default service when the job is attempted.\n\nIf version is empty, then the job will be sent\nto the version which is the default version when the job is attempted.\n\nIf instance is empty, then the job will be\nsent to an instance which is available when the job is attempted.\n\nIf service,\nversion, or\ninstance is invalid, then the job will be sent\nto the default version of the default service when the job is attempted.",
"type": "string"
},
"instance": {
"description": "App instance.\n\nBy default, the job is sent to an instance which is available when\nthe job is attempted.\n\nRequests can only be sent to a specific instance if\n[manual scaling is used in App Engine\nStandard](https://cloud.google.com/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\nrouting](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)\nand [App Engine Flex request\nrouting](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).",
"type": "string"
},
"service": {
"description": "App service.\n\nBy default, the job is sent to the service which is the default\nservice when the job is attempted.",
"type": "string"
},
"version": {
"description": "App version.\n\nBy default, the job is sent to the version which is the default\nversion when the job is attempted.",
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"HttpTarget": {
"description": "Http target. The job will be pushed to the job handler by means of\nan HTTP request via an http_method such as HTTP\nPOST, HTTP GET, etc. The job is acknowledged by means of an HTTP\nresponse code in the range [200 - 299]. A failure to receive a response\nconstitutes a failed execution. For a redirected request, the response\nreturned by the redirected request is considered.",
"id": "HttpTarget",
"properties": {
"body": {
"description": "HTTP request body. A request body is allowed only if the HTTP\nmethod is POST, PUT, or PATCH. It is an error to set body on a job with an\nincompatible HttpMethod.",
"format": "byte",
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The user can specify HTTP request headers to send with the job's\nHTTP request. This map contains the header field names and\nvalues. Repeated headers are not supported, but a header value can\ncontain commas. These headers represent a subset of the headers\nthat will accompany the job's HTTP request. Some HTTP request\nheaders will be ignored or replaced. A partial list of headers that\nwill be ignored or replaced is below:\n- Host: This will be computed by Cloud Scheduler and derived from\nuri.\n* `Content-Length`: This will be computed by Cloud Scheduler.\n* `User-Agent`: This will be set to `\"Google-Cloud-Scheduler\"`.\n* `X-Google-*`: Google internal use only.\n* `X-AppEngine-*`: Google internal use only.\n\nThe total size of headers must be less than 80KB.",
"type": "object"
},
"httpMethod": {
"description": "Which HTTP method to use for the request.",
"enum": [
"HTTP_METHOD_UNSPECIFIED",
"POST",
"GET",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"enumDescriptions": [
"HTTP method unspecified. Defaults to POST.",
"HTTP POST",
"HTTP GET",
"HTTP HEAD",
"HTTP PUT",
"HTTP DELETE",
"HTTP PATCH",
"HTTP OPTIONS"
],
"type": "string"
},
"oauthToken": {
"$ref": "OAuthToken",
"description": "If specified, an\n[OAuth token](https://developers.google.com/identity/protocols/OAuth2)\nwill be generated and attached as an `Authorization` header in the HTTP\nrequest.\n\nThis type of authorization should be used when sending requests to a GCP\nendpoint."
},
"oidcToken": {
"$ref": "OidcToken",
"description": "If specified, an\n[OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)\ntoken will be generated and attached as an `Authorization` header in the\nHTTP request.\n\nThis type of authorization should be used when sending requests to third\nparty endpoints."
},
"uri": {
"description": "Required.\n\nThe full URI path that the request will be sent to. This string\nmust begin with either \"http://\" or \"https://\". Some examples of\nvalid values for uri are:\n`http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will\nencode some characters for safety and compatibility. The maximum allowed\nURL length is 2083 characters after encoding.",
"type": "string"
}
},
"type": "object"
},
"Job": {
"description": "Configuration for a job.\nThe maximum allowed size for a job is 100KB.",
"id": "Job",
"properties": {
"appEngineHttpTarget": {
"$ref": "AppEngineHttpTarget",
"description": "App Engine HTTP target."
},
"attemptDeadline": {
"description": "The deadline for job attempts. If the request handler does not respond by\nthis deadline then the request is cancelled and the attempt is marked as a\n`DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in\nexecution logs. Cloud Scheduler will retry the job according\nto the RetryConfig.\n\nThe allowed duration for this deadline is:\n\n* For HTTP targets, between 15 seconds and 30 minutes.\n* For App Engine HTTP targets, between 15\n seconds and 24 hours.\n* For PubSub targets, this field is ignored.",
"format": "google-duration",
"type": "string"
},
"description": {
"description": "Optionally caller-specified in CreateJob or\nUpdateJob.\n\nA human-readable description for the job. This string must not contain\nmore than 500 characters.",
"type": "string"
},
"httpTarget": {
"$ref": "HttpTarget",
"description": "HTTP target."
},
"lastAttemptTime": {
"description": "Output only. The time the last job attempt started.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "Optionally caller-specified in CreateJob, after\nwhich it becomes output only.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_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\n projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the job'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* `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), or underscores (_). The maximum length is 500 characters.",
"type": "string"
},
"pubsubTarget": {
"$ref": "PubsubTarget",
"description": "Pub/Sub target."
},
"retryConfig": {
"$ref": "RetryConfig",
"description": "Settings that determine the retry behavior."
},
"schedule": {
"description": "Required, except when used with UpdateJob.\n\nDescribes the schedule on which the job will be executed.\n\nThe schedule can be either of the following types:\n\n* [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)\n* English-like\n[schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)\n\nAs a general rule, execution `n + 1` of a job will not begin\nuntil execution `n` has finished. Cloud Scheduler will never\nallow two simultaneously outstanding executions. For example,\nthis implies that if the `n+1`th execution is scheduled to run at\n16:00 but the `n`th execution takes until 16:15, the `n+1`th\nexecution will not start until `16:15`.\nA scheduled start time will be delayed if the previous\nexecution has not ended when its scheduled time occurs.\n\nIf retry_count > 0 and a job attempt fails,\nthe job will be tried a total of retry_count\ntimes, with exponential backoff, until the next scheduled start\ntime.",
"type": "string"
},
"scheduleTime": {
"description": "Output only. The next time the job is scheduled. Note that this may be a\nretry of a previously failed attempt or the next execution time\naccording to the schedule.",
"format": "google-datetime",
"type": "string"
},
"state": {
"description": "Output only. State of the job.",
"enum": [
"STATE_UNSPECIFIED",
"ENABLED",
"PAUSED",
"DISABLED",
"UPDATE_FAILED"
],
"enumDescriptions": [
"Unspecified state.",
"The job is executing normally.",
"The job is paused by the user. It will not execute. A user can\nintentionally pause the job using\nPauseJobRequest.",
"The job is disabled by the system due to error. The user\ncannot directly set a job to be disabled.",
"The job state resulting from a failed CloudScheduler.UpdateJob\noperation. To recover a job from this state, retry\nCloudScheduler.UpdateJob until a successful response is received."
],
"type": "string"
},
"status": {
"$ref": "Status",
"description": "Output only. The response from the target for the last attempted execution."
},
"timeZone": {
"description": "Specifies the time zone to be used in interpreting\nschedule. The value of this field must be a time\nzone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).\n\nNote that some time zones include a provision for\ndaylight savings time. The rules for daylight saving time are\ndetermined by the chosen tz. For UTC use the string \"utc\". If a\ntime zone is not specified, the default will be in UTC (also known\nas GMT).",
"type": "string"
},
"userUpdateTime": {
"description": "Output only. The creation time of the job.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"ListJobsResponse": {
"description": "Response message for listing jobs using ListJobs.",
"id": "ListJobsResponse",
"properties": {
"jobs": {
"description": "The list of jobs.",
"items": {
"$ref": "Job"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass this value in the\npage_token field in the subsequent call to\nListJobs to retrieve the next page of results.\nIf this is empty it indicates that there are no more results\nthrough which to paginate.\n\nThe page token is valid for only 2 hours.",
"type": "string"
}
},
"type": "object"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "ListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"id": "Location",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name.\nFor example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"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"
},
"name": {
"description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"type": "object"
},
"OAuthToken": {
"description": "Contains information needed for generating an\n[OAuth token](https://developers.google.com/identity/protocols/OAuth2).\nThis type of authorization should be used when sending requests to a GCP\nendpoint.",
"id": "OAuthToken",
"properties": {
"scope": {
"description": "OAuth scope to be used for generating OAuth access token.\nIf not specified, \"https://www.googleapis.com/auth/cloud-platform\"\nwill be used.",
"type": "string"
},
"serviceAccountEmail": {
"description": "[Service account email](https://cloud.google.com/iam/docs/service-accounts)\nto be used for generating OAuth token.\nThe service account must be within the same project as the job. The caller\nmust have iam.serviceAccounts.actAs permission for the service account.",
"type": "string"
}
},
"type": "object"
},
"OidcToken": {
"description": "Contains information needed for generating an\n[OpenID Connect\ntoken](https://developers.google.com/identity/protocols/OpenIDConnect). This\ntype of authorization should be used when sending requests to third party\nendpoints.",
"id": "OidcToken",
"properties": {
"audience": {
"description": "Audience to be used when generating OIDC token. If not specified, the URI\nspecified in target will be used.",
"type": "string"
},
"serviceAccountEmail": {
"description": "[Service account email](https://cloud.google.com/iam/docs/service-accounts)\nto be used for generating OIDC token.\nThe service account must be within the same project as the job. The caller\nmust have iam.serviceAccounts.actAs permission for the service account.",
"type": "string"
}
},
"type": "object"
},
"PauseJobRequest": {
"description": "Request message for PauseJob.",
"id": "PauseJobRequest",
"properties": {},
"type": "object"
},
"PubsubMessage": {
"description": "A message that is published by publishers and consumed by subscribers. The\nmessage must contain either a non-empty data field or at least one attribute.\nNote that client libraries represent this object differently\ndepending on the language. See the corresponding\n<a href=\"https://cloud.google.com/pubsub/docs/reference/libraries\">client\nlibrary documentation</a> for more information. See\n<a href=\"https://cloud.google.com/pubsub/quotas\">Quotas and limits</a>\nfor more information about message limits.",
"id": "PubsubMessage",
"properties": {
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Optional attributes for this message.",
"type": "object"
},
"data": {
"description": "The message data field. If this field is empty, the message must contain\nat least one attribute.",
"format": "byte",
"type": "string"
},
"messageId": {
"description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
"type": "string"
},
"publishTime": {
"description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"PubsubTarget": {
"description": "Pub/Sub target. The job will be delivered by publishing a message to\nthe given Pub/Sub topic.",
"id": "PubsubTarget",
"properties": {
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Attributes for PubsubMessage.\n\nPubsub message must contain either non-empty data, or at least one\nattribute.",
"type": "object"
},
"data": {
"description": "The message payload for PubsubMessage.\n\nPubsub message must contain either non-empty data, or at least one\nattribute.",
"format": "byte",
"type": "string"
},
"topicName": {
"description": "Required.\n\nThe name of the Cloud Pub/Sub topic to which messages will\nbe published when a job is delivered. The topic name must be in the\nsame format as required by PubSub's\n[PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),\nfor example `projects/PROJECT_ID/topics/TOPIC_ID`.\n\nThe topic must be in the same project as the Cloud Scheduler job.",
"type": "string"
}
},
"type": "object"
},
"ResumeJobRequest": {
"description": "Request message for ResumeJob.",
"id": "ResumeJobRequest",
"properties": {},
"type": "object"
},
"RetryConfig": {
"description": "Settings that determine the retry behavior.\n\nBy default, if a job does not complete successfully (meaning that\nan acknowledgement is not received from the handler, then it will be retried\nwith exponential backoff according to the settings in RetryConfig.",
"id": "RetryConfig",
"properties": {
"maxBackoffDuration": {
"description": "The maximum amount of time to wait before retrying a job after\nit fails.\n\nThe default value of this field is 1 hour.",
"format": "google-duration",
"type": "string"
},
"maxDoublings": {
"description": "The time between retries will double `max_doublings` times.\n\nA job's retry interval starts at\nmin_backoff_duration, then doubles\n`max_doublings` times, then increases linearly, and finally\nretries retries at intervals of\nmax_backoff_duration up to\nretry_count times.\n\nFor example, if min_backoff_duration is\n10s, max_backoff_duration is 300s, and\n`max_doublings` is 3, then the a job will first be retried in 10s. The\nretry interval will double three times, and then increase linearly by\n2^3 * 10s. Finally, the job will retry at intervals of\nmax_backoff_duration until the job has\nbeen attempted retry_count times. Thus, the\nrequests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....\n\nThe default value of this field is 5.",
"format": "int32",
"type": "integer"
},
"maxRetryDuration": {
"description": "The time limit for retrying a failed job, measured from time when an\nexecution was first attempted. If specified with\nretry_count, the job will be retried until both\nlimits are reached.\n\nThe default value for max_retry_duration is zero, which means retry\nduration is unlimited.",
"format": "google-duration",
"type": "string"
},
"minBackoffDuration": {
"description": "The minimum amount of time to wait before retrying a job after\nit fails.\n\nThe default value of this field is 5 seconds.",
"format": "google-duration",
"type": "string"
},
"retryCount": {
"description": "The number of attempts that the system will make to run a job using the\nexponential backoff procedure described by\nmax_doublings.\n\nThe default value of retry_count is zero.\n\nIf retry_count is zero, a job attempt will *not* be retried if\nit fails. Instead the Cloud Scheduler system will wait for the\nnext scheduled execution time.\n\nIf retry_count is set to a non-zero number then Cloud Scheduler\nwill retry failed attempts, using exponential backoff,\nretry_count times, or until the next scheduled execution time,\nwhichever comes first.\n\nValues greater than 5 and negative values are not allowed.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"RunJobRequest": {
"description": "Request message for forcing a job to run now using\nRunJob.",
"id": "RunJobRequest",
"properties": {},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error\nmessage, and error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud Scheduler API",
"version": "v1beta1",
"version_module": true
}

4591
etc/api/cloudsearch/v1/cloudsearch-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

896
etc/api/cloudshell/v1/cloudshell-api.json
View File

@@ -1,456 +1,456 @@
{
"ownerName": "Google",
"resources": {
"operations": {
"methods": {
"cancel": {
"id": "cloudshell.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"
},
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"name": {
"pattern": "^operations/.+$",
"location": "path",
"description": "The name of the operation resource to be cancelled.",
"required": true,
"type": "string"
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/operations/{operationsId}:cancel"
},
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"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}",
"id": "cloudshell.operations.delete",
"path": "v1/{+name}"
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "ListOperationsResponse"
},
"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": {
"location": "query",
"description": "The standard list page size.",
"format": "int32",
"type": "integer"
},
"filter": {
"location": "query",
"description": "The standard list filter.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/operations",
"id": "cloudshell.operations.list",
"path": "v1/{+name}"
},
"get": {
"flatPath": "v1/operations/{operationsId}",
"id": "cloudshell.operations.get",
"path": "v1/{+name}",
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"name": {
"pattern": "^operations/.+$",
"location": "path",
"description": "The name of the operation resource.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
},
"parameters": {
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
]
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"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": {
"description": "API key. Your API 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"
},
"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"
},
"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://cloudshell.googleapis.com/",
"servicePath": "",
"description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n",
"kind": "discovery#restDescription",
"basePath": "",
"documentationLink": "https://cloud.google.com/shell/docs/",
"id": "cloudshell:v1",
"revision": "20181011",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"Environment": {
"description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".",
"type": "object",
"properties": {
"dockerImage": {
"description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".",
"type": "string"
},
"state": {
"enumDescriptions": [
"The environment's states is unknown.",
"The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.",
"The environment is being started but is not yet ready to accept\nconnections.",
"The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started."
],
"enum": [
"STATE_UNSPECIFIED",
"DISABLED",
"STARTING",
"RUNNING"
],
"description": "Output only. Current execution state of this environment.",
"type": "string"
},
"name": {
"description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.",
"type": "string"
},
"sshHost": {
"description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.",
"type": "string"
},
"sshPort": {
"description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.",
"format": "int32",
"type": "integer"
},
"id": {
"description": "Output only. The environment's identifier, which is always \"default\".",
"type": "string"
},
"sshUsername": {
"description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.",
"type": "string"
},
"publicKeys": {
"description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.",
"type": "array",
"items": {
"$ref": "PublicKey"
}
}
},
"id": "Environment"
},
"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"
},
"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"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\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"
},
},
"basePath": "",
"baseUrl": "https://cloudshell.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Shell",
"description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/shell/docs/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "cloudshell:v1",
"kind": "discovery#restDescription",
"name": "cloudshell",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "Required. Content of this key.",
"format": "byte",
"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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"id": "PublicKey"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"type": "object",
"properties": {},
"id": "CancelOperationRequest"
},
"StartEnvironmentMetadata": {
"description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
"type": "object",
"properties": {
"state": {
"enumDescriptions": [
"The environment's start state is unknown.",
"The environment is in the process of being started, but no additional\ndetails are available.",
"Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.",
"Startup is complete and the user should be able to establish an SSH\nconnection to their environment."
],
"enum": [
"STATE_UNSPECIFIED",
"STARTING",
"UNARCHIVING_DISK",
"FINISHED"
],
"description": "Current state of the environment being started.",
"type": "string"
}
},
"id": "StartEnvironmentMetadata"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
},
"protocol": "rest",
"resources": {
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Operation"
}
"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`.",
"flatPath": "v1/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "cloudshell.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^operations/.+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "cloudshell.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^operations/.+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "GET",
"id": "cloudshell.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^operations/.+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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.",
"flatPath": "v1/operations",
"httpMethod": "GET",
"id": "cloudshell.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^operations$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
},
"id": "ListOperationsResponse"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
"error": {
"description": "The error result of the operation in case of failure or cancellation.",
"$ref": "Status"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
},
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
"type": "string"
},
"revision": "20190330",
"rootUrl": "https://cloudshell.googleapis.com/",
"schemas": {
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "CancelOperationRequest",
"properties": {},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"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\".",
"id": "Environment",
"properties": {
"dockerImage": {
"description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".",
"type": "string"
},
"id": {
"description": "Output only. The environment's identifier, which is always \"default\".",
"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"
},
"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.",
"items": {
"$ref": "PublicKey"
},
"type": "array"
},
"sshHost": {
"description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.",
"type": "string"
},
"sshPort": {
"description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.",
"format": "int32",
"type": "integer"
},
"sshUsername": {
"description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.",
"type": "string"
},
"state": {
"description": "Output only. Current execution state of this environment.",
"enum": [
"STATE_UNSPECIFIED",
"DISABLED",
"STARTING",
"RUNNING"
],
"enumDescriptions": [
"The environment's states is unknown.",
"The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.",
"The environment is being started but is not yet ready to accept\nconnections.",
"The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started."
],
"type": "string"
}
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"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"
},
"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"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"PublicKey": {
"description": "A public SSH key, corresponding to a private SSH key held by the client.",
"id": "PublicKey",
"properties": {
"format": {
"description": "Required. Format of this key's content.",
"enum": [
"FORMAT_UNSPECIFIED",
"SSH_DSS",
"SSH_RSA",
"ECDSA_SHA2_NISTP256",
"ECDSA_SHA2_NISTP384",
"ECDSA_SHA2_NISTP521"
],
"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)."
],
"type": "string"
},
"key": {
"description": "Required. Content of this key.",
"format": "byte",
"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"
}
},
"type": "object"
},
"StartEnvironmentMetadata": {
"description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
"id": "StartEnvironmentMetadata",
"properties": {
"state": {
"description": "Current state of the environment being started.",
"enum": [
"STATE_UNSPECIFIED",
"STARTING",
"UNARCHIVING_DISK",
"FINISHED"
],
"enumDescriptions": [
"The environment's start state is unknown.",
"The environment is in the process of being started, but no additional\ndetails are available.",
"Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.",
"Startup is complete and the user should be able to establish an SSH\nconnection to their environment."
],
"type": "string"
}
},
"type": "object"
},
"StartEnvironmentResponse": {
"description": "Message included in the response field of operations returned from\nStartEnvironment once the\noperation is complete.",
"id": "StartEnvironmentResponse",
"properties": {
"environment": {
"$ref": "Environment",
"description": "Environment that was started."
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error\nmessage, and error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
}
},
"id": "Operation"
}
},
"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 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",
"fullyEncodeReservedExpansion": true,
"title": "Cloud Shell API"
}
},
"servicePath": "",
"title": "Cloud Shell API",
"version": "v1",
"version_module": true
}

1039
etc/api/cloudshell/v1alpha1/cloudshell-api.json
View File

File diff suppressed because it is too large Load Diff

1244
etc/api/cloudtasks/v2/cloudtasks-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

3018
etc/api/cloudtasks/v2beta2/cloudtasks-api.json
View File

File diff suppressed because it is too large Load Diff

2483
etc/api/cloudtasks/v2beta3/cloudtasks-api.json
View File

File diff suppressed because it is too large Load Diff

730
etc/api/cloudtrace/v1/cloudtrace-api.json
View File

@@ -1,373 +1,373 @@
{
"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"
}
}
}
},
"rootUrl": "https://cloudtrace.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudtrace",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Stackdriver Trace API",
"ownerName": "Google",
"resources": {
"projects": {
"resources": {
"traces": {
"methods": {
"list": {
"description": "Returns of a list of traces that match the specified filter conditions.",
"httpMethod": "GET",
"parameterOrder": [
"projectId"
],
"response": {
"$ref": "ListTracesResponse"
},
"parameters": {
"orderBy": {
"location": "query",
"description": "Field used to sort the returned traces. Optional.\nCan be one of the following:\n\n* `trace_id`\n* `name` (`name` field of root span in the trace)\n* `duration` (difference between `end_time` and `start_time` fields of\n the root span)\n* `start` (`start_time` field of the root span)\n\nDescending order can be specified by appending `desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is permitted.",
"type": "string"
},
"projectId": {
"description": "ID of the Cloud project where the trace data is stored.",
"required": true,
"type": "string",
"location": "path"
},
"filter": {
"description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
"type": "string",
"location": "query"
},
"endTime": {
"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": {
"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": {
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"MINIMAL",
"ROOTSPAN",
"COMPLETE"
],
"description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.",
"type": "string",
"location": "query"
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/trace.append": {
"description": "Write Trace data for a project or application"
},
"https://www.googleapis.com/auth/trace.readonly": {
"description": "Read Trace data for a project or application"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.readonly"
],
"flatPath": "v1/projects/{projectId}/traces",
"id": "cloudtrace.projects.traces.list",
"path": "v1/projects/{projectId}/traces"
},
"get": {
"response": {
"$ref": "Trace"
},
"parameterOrder": [
"projectId",
"traceId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.readonly"
],
"parameters": {
"projectId": {
"location": "path",
"description": "ID of the Cloud project where the trace data is stored.",
"required": true,
"type": "string"
},
"traceId": {
"description": "ID of the trace to return.",
"required": true,
"type": "string",
"location": "path"
}
},
"flatPath": "v1/projects/{projectId}/traces/{traceId}",
"path": "v1/projects/{projectId}/traces/{traceId}",
"id": "cloudtrace.projects.traces.get",
"description": "Gets a single trace by its ID."
}
}
}
},
"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": {
"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.patchTraces",
"request": {
"$ref": "Traces"
},
"description": "Sends new traces to Stackdriver Trace or updates existing traces. If the ID\nof a trace that you send matches that of an existing trace, any fields\nin the existing trace and its spans are overwritten by the provided values,\nand any new fields provided are merged with the existing trace data. If the\nID does not match, a new trace is created."
}
}
}
},
"parameters": {
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"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"
},
"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"
},
"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"
},
"quotaUser": {
"location": "query",
"description": "Available to use 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://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. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus.\n",
"servicePath": "",
"basePath": "",
"revision": "20181004",
"documentationLink": "https://cloud.google.com/trace",
"id": "cloudtrace:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"TraceSpan": {
"properties": {
"labels": {
"additionalProperties": {
},
"basePath": "",
"baseUrl": "https://cloudtrace.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Trace",
"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. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus.\n",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/trace",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "cloudtrace:v1",
"kind": "discovery#restDescription",
"name": "cloudtrace",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
},
"description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes (10MB for\n`/stacktrace` values).\n\nSome predefined label keys exist, or you may create your own. When creating\nyour own, we recommend the following formats:\n\n* `/category/product/key` for agents of well-known products (e.g.\n `/db/mongodb/read_size`).\n* `short_host/path/key` for domain-specific keys (e.g.\n `foo.com/myproduct/bar`)\n\nPredefined labels include:\n\n* `/agent`\n* `/component`\n* `/error/message`\n* `/error/name`\n* `/http/client_city`\n* `/http/client_country`\n* `/http/client_protocol`\n* `/http/client_region`\n* `/http/host`\n* `/http/method`\n* `/http/path`\n* `/http/redirected_url`\n* `/http/request/size`\n* `/http/response/size`\n* `/http/route`\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\nGoogle Cloud Platform Console.\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. For example, `2205310701640571284`.",
"format": "uint64",
"type": "string"
},
"parentSpanId": {
"description": "ID of the parent span, if any. Optional.",
"format": "uint64",
"type": "string"
},
"endTime": {
"description": "End time of the span in nanoseconds from the UNIX epoch.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Start time of the span in nanoseconds from the UNIX epoch.",
"format": "google-datetime",
"type": "string"
},
"kind": {
"enum": [
"SPAN_KIND_UNSPECIFIED",
"RPC_SERVER",
"RPC_CLIENT"
],
"description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `RPC_CLIENT`\nand `RPC_SERVER` to identify queueing latency associated with the span.",
"type": "string",
"enumDescriptions": [
"Unspecified.",
"Indicates that the span covers server-side handling of an RPC or other\nremote network request.",
"Indicates that the span covers the client-side wrapper around an RPC or\nother remote request."
]
}
},
"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": {
"description": "The response message for the `ListTraces` method.",
"type": "object",
"properties": {
"traces": {
"description": "List of trace records as specified by the view parameter.",
"type": "array",
"items": {
"$ref": "Trace"
}
},
"nextPageToken": {
"description": "If defined, indicates that there are more traces that match the request\nand that this value should be passed to the next request to continue\nretrieving additional traces.",
"type": "string"
},
"protocol": "rest",
"resources": {
"projects": {
"methods": {
"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.",
"flatPath": "v1/projects/{projectId}/traces",
"httpMethod": "PATCH",
"id": "cloudtrace.projects.patchTraces",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "ID of the Cloud project where the trace data is stored.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/traces",
"request": {
"$ref": "Traces"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append"
]
}
},
"resources": {
"traces": {
"methods": {
"get": {
"description": "Gets a single trace by its ID.",
"flatPath": "v1/projects/{projectId}/traces/{traceId}",
"httpMethod": "GET",
"id": "cloudtrace.projects.traces.get",
"parameterOrder": [
"projectId",
"traceId"
],
"parameters": {
"projectId": {
"description": "ID of the Cloud project where the trace data is stored.",
"location": "path",
"required": true,
"type": "string"
},
"traceId": {
"description": "ID of the trace to return.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/traces/{traceId}",
"response": {
"$ref": "Trace"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.readonly"
]
},
"list": {
"description": "Returns of a list of traces that match the specified filter conditions.",
"flatPath": "v1/projects/{projectId}/traces",
"httpMethod": "GET",
"id": "cloudtrace.projects.traces.list",
"parameterOrder": [
"projectId"
],
"parameters": {
"endTime": {
"description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
"format": "google-datetime",
"location": "query",
"type": "string"
},
"filter": {
"description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
"location": "query",
"type": "string"
},
"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.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of traces to return. If not specified or <= 0, the\nimplementation selects a reasonable value. The implementation may\nreturn fewer traces than the requested page size. Optional.",
"format": "int32",
"location": "query",
"type": "integer"
},
"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.",
"location": "query",
"type": "string"
},
"projectId": {
"description": "ID of the Cloud project where the trace data is stored.",
"location": "path",
"required": true,
"type": "string"
},
"startTime": {
"description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
"format": "google-datetime",
"location": "query",
"type": "string"
},
"view": {
"description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.",
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"MINIMAL",
"ROOTSPAN",
"COMPLETE"
],
"location": "query",
"type": "string"
}
},
"path": "v1/projects/{projectId}/traces",
"response": {
"$ref": "ListTracesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.readonly"
]
}
}
}
}
}
},
"id": "ListTracesResponse"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {},
"id": "Empty"
},
"Trace": {
"properties": {
"projectId": {
"description": "Project ID of the Cloud project where the trace data is stored.",
"type": "string"
},
"spans": {
"description": "Collection of spans in the trace.",
"type": "array",
"items": {
"$ref": "TraceSpan"
}
},
"traceId": {
"description": "Globally unique identifier for the trace. This identifier is a 128-bit\nnumeric value formatted as a 32-byte hex string. For example,\n`382d4f4c6b7bb2f4a972559d9085001d`.",
"type": "string"
},
"revision": "20190326",
"rootUrl": "https://cloudtrace.googleapis.com/",
"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 `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"ListTracesResponse": {
"description": "The response message for the `ListTraces` method.",
"id": "ListTracesResponse",
"properties": {
"nextPageToken": {
"description": "If defined, indicates that there are more traces that match the request\nand that this value should be passed to the next request to continue\nretrieving additional traces.",
"type": "string"
},
"traces": {
"description": "List of trace records as specified by the view parameter.",
"items": {
"$ref": "Trace"
},
"type": "array"
}
},
"type": "object"
},
"Trace": {
"description": "A trace describes how long it takes for an application to perform an\noperation. It consists of a set of spans, each of which represent a single\ntimed event within the operation.",
"id": "Trace",
"properties": {
"projectId": {
"description": "Project ID of the Cloud project where the trace data is stored.",
"type": "string"
},
"spans": {
"description": "Collection of spans in the trace.",
"items": {
"$ref": "TraceSpan"
},
"type": "array"
},
"traceId": {
"description": "Globally unique identifier for the trace. This identifier is a 128-bit\nnumeric value formatted as a 32-byte hex string. For example,\n`382d4f4c6b7bb2f4a972559d9085001d`.",
"type": "string"
}
},
"type": "object"
},
"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.",
"id": "TraceSpan",
"properties": {
"endTime": {
"description": "End time of the span in nanoseconds from the UNIX epoch.",
"format": "google-datetime",
"type": "string"
},
"kind": {
"description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `RPC_CLIENT`\nand `RPC_SERVER` to identify queueing latency associated with the span.",
"enum": [
"SPAN_KIND_UNSPECIFIED",
"RPC_SERVER",
"RPC_CLIENT"
],
"enumDescriptions": [
"Unspecified.",
"Indicates that the span covers server-side handling of an RPC or other\nremote network request.",
"Indicates that the span covers the client-side wrapper around an RPC or\nother remote request."
],
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes (10MB for\n`/stacktrace` values).\n\nSome predefined label keys exist, or you may create your own. When creating\nyour own, we recommend the following formats:\n\n* `/category/product/key` for agents of well-known products (e.g.\n `/db/mongodb/read_size`).\n* `short_host/path/key` for domain-specific keys (e.g.\n `foo.com/myproduct/bar`)\n\nPredefined labels include:\n\n* `/agent`\n* `/component`\n* `/error/message`\n* `/error/name`\n* `/http/client_city`\n* `/http/client_country`\n* `/http/client_protocol`\n* `/http/client_region`\n* `/http/host`\n* `/http/method`\n* `/http/path`\n* `/http/redirected_url`\n* `/http/request/size`\n* `/http/response/size`\n* `/http/route`\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\nGoogle Cloud Platform Console.\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"
},
"parentSpanId": {
"description": "ID of the parent span, if any. Optional.",
"format": "uint64",
"type": "string"
},
"spanId": {
"description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace. For example, `2205310701640571284`.",
"format": "uint64",
"type": "string"
},
"startTime": {
"description": "Start time of the span in nanoseconds from the UNIX epoch.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Traces": {
"description": "List of new or updated traces.",
"id": "Traces",
"properties": {
"traces": {
"description": "List of traces.",
"items": {
"$ref": "Trace"
},
"type": "array"
}
},
"type": "object"
}
},
"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"
},
"Traces": {
"properties": {
"traces": {
"description": "List of traces.",
"type": "array",
"items": {
"$ref": "Trace"
}
}
},
"id": "Traces",
"description": "List of new or updated traces.",
"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"
}
}
},
"servicePath": "",
"title": "Stackdriver Trace API",
"version": "v1",
"version_module": true
}

1164
etc/api/cloudtrace/v2/cloudtrace-api.json
View File

File diff suppressed because it is too large Load Diff

1480
etc/api/composer/v1/composer-api.json
View File

File diff suppressed because one or more lines are too long

1539
etc/api/composer/v1beta1/composer-api.json
View File

File diff suppressed because one or more lines are too long

107280
etc/api/compute/alpha/compute-api.json
View File

File diff suppressed because it is too large Load Diff

88638
etc/api/compute/beta/compute-api.json
View File

File diff suppressed because it is too large Load Diff

74420
etc/api/compute/v1/compute-api.json
View File

File diff suppressed because it is too large Load Diff

8118
etc/api/container/v1/container-api.json
View File

File diff suppressed because it is too large Load Diff

9215
etc/api/container/v1beta1/container-api.json
View File

File diff suppressed because it is too large Load Diff

2965
etc/api/containeranalysis/v1alpha1/containeranalysis-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

2729
etc/api/containeranalysis/v1beta1/containeranalysis-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

9086
etc/api/content/v2.1/content-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

21554
etc/api/content/v2/content-api.json
View File

File diff suppressed because it is too large Load Diff

2326
etc/api/customsearch/v1/customsearch-api.json
View File

File diff suppressed because it is too large Load Diff

10995
etc/api/dataflow/v1b3/dataflow-api.json
View File

File diff suppressed because it is too large Load Diff

6635
etc/api/dataproc/v1/dataproc-api.json
View File

File diff suppressed because it is too large Load Diff

7550
etc/api/dataproc/v1beta2/dataproc-api.json
View File

File diff suppressed because it is too large Load Diff

3968
etc/api/datastore/v1/datastore-api.json
View File

File diff suppressed because it is too large Load Diff

1260
etc/api/datastore/v1beta1/datastore-api.json
View File

File diff suppressed because it is too large Load Diff

2994
etc/api/datastore/v1beta3/datastore-api.json
View File

File diff suppressed because it is too large Load Diff

6492
etc/api/deploymentmanager/alpha/deploymentmanager-api.json
View File

File diff suppressed because it is too large Load Diff

3896
etc/api/deploymentmanager/v2/deploymentmanager-api.json
View File

File diff suppressed because it is too large Load Diff

5996
etc/api/deploymentmanager/v2beta/deploymentmanager-api.json
View File

File diff suppressed because it is too large Load Diff

40030
etc/api/dfareporting/v3.1/dfareporting-api.json
View File

File diff suppressed because it is too large Load Diff

40102
etc/api/dfareporting/v3.2/dfareporting-api.json
View File

File diff suppressed because it is too large Load Diff

19917
etc/api/dfareporting/v3.3/dfareporting-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

8269
etc/api/dialogflow/v2/dialogflow-api.json
View File

File diff suppressed because it is too large Load Diff

12585
etc/api/dialogflow/v2beta1/dialogflow-api.json
View File

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More